Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. automation
  5. getDscConfiguration
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.automation.getDscConfiguration

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Retrieve the configuration identified by configuration name. Azure REST API version: 2022-08-08.

Other available API versions: 2023-05-15-preview, 2023-11-01, 2024-10-23.

Using getDscConfiguration

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDscConfiguration(args: GetDscConfigurationArgs, opts?: InvokeOptions): Promise<GetDscConfigurationResult>
function getDscConfigurationOutput(args: GetDscConfigurationOutputArgs, opts?: InvokeOptions): Output<GetDscConfigurationResult>
Copy
def get_dsc_configuration(automation_account_name: Optional[str] = None,
                          configuration_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetDscConfigurationResult
def get_dsc_configuration_output(automation_account_name: Optional[pulumi.Input[str]] = None,
                          configuration_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetDscConfigurationResult]
Copy
func LookupDscConfiguration(ctx *Context, args *LookupDscConfigurationArgs, opts ...InvokeOption) (*LookupDscConfigurationResult, error)
func LookupDscConfigurationOutput(ctx *Context, args *LookupDscConfigurationOutputArgs, opts ...InvokeOption) LookupDscConfigurationResultOutput
Copy

> Note: This function is named LookupDscConfiguration in the Go SDK.

public static class GetDscConfiguration 
{
    public static Task<GetDscConfigurationResult> InvokeAsync(GetDscConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<GetDscConfigurationResult> Invoke(GetDscConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDscConfigurationResult> getDscConfiguration(GetDscConfigurationArgs args, InvokeOptions options)
public static Output<GetDscConfigurationResult> getDscConfiguration(GetDscConfigurationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:automation:getDscConfiguration
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AutomationAccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the automation account.
ConfigurationName
This property is required.
Changes to this property will trigger replacement.
string
The configuration name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure Resource group.
AutomationAccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the automation account.
ConfigurationName
This property is required.
Changes to this property will trigger replacement.
string
The configuration name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure Resource group.
automationAccountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the automation account.
configurationName
This property is required.
Changes to this property will trigger replacement.
String
The configuration name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Azure Resource group.
automationAccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the automation account.
configurationName
This property is required.
Changes to this property will trigger replacement.
string
The configuration name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure Resource group.
automation_account_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the automation account.
configuration_name
This property is required.
Changes to this property will trigger replacement.
str
The configuration name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of an Azure Resource group.
automationAccountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the automation account.
configurationName
This property is required.
Changes to this property will trigger replacement.
String
The configuration name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Azure Resource group.

getDscConfiguration Result

The following output properties are available:

Id string
Fully qualified resource Id for the resource
Name string
The name of the resource
Type string
The type of the resource.
CreationTime string
Gets or sets the creation time.
Description string
Gets or sets the description.
Etag string
Gets or sets the etag of the resource.
JobCount int
Gets or sets the job count of the configuration.
LastModifiedTime string
Gets or sets the last modified time.
Location string
The Azure Region where the resource lives
LogVerbose bool
Gets or sets verbose log option.
NodeConfigurationCount int
Gets the number of compiled node configurations.
Parameters Dictionary<string, Pulumi.AzureNative.Automation.Outputs.DscConfigurationParameterResponse>
Gets or sets the configuration parameters.
ProvisioningState string
Gets or sets the provisioning state of the configuration.
Source Pulumi.AzureNative.Automation.Outputs.ContentSourceResponse
Gets or sets the source.
State string
Gets or sets the state of the configuration.
Tags Dictionary<string, string>
Resource tags.
Id string
Fully qualified resource Id for the resource
Name string
The name of the resource
Type string
The type of the resource.
CreationTime string
Gets or sets the creation time.
Description string
Gets or sets the description.
Etag string
Gets or sets the etag of the resource.
JobCount int
Gets or sets the job count of the configuration.
LastModifiedTime string
Gets or sets the last modified time.
Location string
The Azure Region where the resource lives
LogVerbose bool
Gets or sets verbose log option.
NodeConfigurationCount int
Gets the number of compiled node configurations.
Parameters map[string]DscConfigurationParameterResponse
Gets or sets the configuration parameters.
ProvisioningState string
Gets or sets the provisioning state of the configuration.
Source ContentSourceResponse
Gets or sets the source.
State string
Gets or sets the state of the configuration.
Tags map[string]string
Resource tags.
id String
Fully qualified resource Id for the resource
name String
The name of the resource
type String
The type of the resource.
creationTime String
Gets or sets the creation time.
description String
Gets or sets the description.
etag String
Gets or sets the etag of the resource.
jobCount Integer
Gets or sets the job count of the configuration.
lastModifiedTime String
Gets or sets the last modified time.
location String
The Azure Region where the resource lives
logVerbose Boolean
Gets or sets verbose log option.
nodeConfigurationCount Integer
Gets the number of compiled node configurations.
parameters Map<String,DscConfigurationParameterResponse>
Gets or sets the configuration parameters.
provisioningState String
Gets or sets the provisioning state of the configuration.
source ContentSourceResponse
Gets or sets the source.
state String
Gets or sets the state of the configuration.
tags Map<String,String>
Resource tags.
id string
Fully qualified resource Id for the resource
name string
The name of the resource
type string
The type of the resource.
creationTime string
Gets or sets the creation time.
description string
Gets or sets the description.
etag string
Gets or sets the etag of the resource.
jobCount number
Gets or sets the job count of the configuration.
lastModifiedTime string
Gets or sets the last modified time.
location string
The Azure Region where the resource lives
logVerbose boolean
Gets or sets verbose log option.
nodeConfigurationCount number
Gets the number of compiled node configurations.
parameters {[key: string]: DscConfigurationParameterResponse}
Gets or sets the configuration parameters.
provisioningState string
Gets or sets the provisioning state of the configuration.
source ContentSourceResponse
Gets or sets the source.
state string
Gets or sets the state of the configuration.
tags {[key: string]: string}
Resource tags.
id str
Fully qualified resource Id for the resource
name str
The name of the resource
type str
The type of the resource.
creation_time str
Gets or sets the creation time.
description str
Gets or sets the description.
etag str
Gets or sets the etag of the resource.
job_count int
Gets or sets the job count of the configuration.
last_modified_time str
Gets or sets the last modified time.
location str
The Azure Region where the resource lives
log_verbose bool
Gets or sets verbose log option.
node_configuration_count int
Gets the number of compiled node configurations.
parameters Mapping[str, DscConfigurationParameterResponse]
Gets or sets the configuration parameters.
provisioning_state str
Gets or sets the provisioning state of the configuration.
source ContentSourceResponse
Gets or sets the source.
state str
Gets or sets the state of the configuration.
tags Mapping[str, str]
Resource tags.
id String
Fully qualified resource Id for the resource
name String
The name of the resource
type String
The type of the resource.
creationTime String
Gets or sets the creation time.
description String
Gets or sets the description.
etag String
Gets or sets the etag of the resource.
jobCount Number
Gets or sets the job count of the configuration.
lastModifiedTime String
Gets or sets the last modified time.
location String
The Azure Region where the resource lives
logVerbose Boolean
Gets or sets verbose log option.
nodeConfigurationCount Number
Gets the number of compiled node configurations.
parameters Map<Property Map>
Gets or sets the configuration parameters.
provisioningState String
Gets or sets the provisioning state of the configuration.
source Property Map
Gets or sets the source.
state String
Gets or sets the state of the configuration.
tags Map<String>
Resource tags.

Supporting Types

ContentHashResponse

Algorithm This property is required. string
Gets or sets the content hash algorithm used to hash the content.
Value This property is required. string
Gets or sets expected hash value of the content.
Algorithm This property is required. string
Gets or sets the content hash algorithm used to hash the content.
Value This property is required. string
Gets or sets expected hash value of the content.
algorithm This property is required. String
Gets or sets the content hash algorithm used to hash the content.
value This property is required. String
Gets or sets expected hash value of the content.
algorithm This property is required. string
Gets or sets the content hash algorithm used to hash the content.
value This property is required. string
Gets or sets expected hash value of the content.
algorithm This property is required. str
Gets or sets the content hash algorithm used to hash the content.
value This property is required. str
Gets or sets expected hash value of the content.
algorithm This property is required. String
Gets or sets the content hash algorithm used to hash the content.
value This property is required. String
Gets or sets expected hash value of the content.

ContentSourceResponse

Hash Pulumi.AzureNative.Automation.Inputs.ContentHashResponse
Gets or sets the hash.
Type string
Gets or sets the content source type.
Value string
Gets or sets the value of the content. This is based on the content source type.
Version string
Gets or sets the version of the content.
Hash ContentHashResponse
Gets or sets the hash.
Type string
Gets or sets the content source type.
Value string
Gets or sets the value of the content. This is based on the content source type.
Version string
Gets or sets the version of the content.
hash ContentHashResponse
Gets or sets the hash.
type String
Gets or sets the content source type.
value String
Gets or sets the value of the content. This is based on the content source type.
version String
Gets or sets the version of the content.
hash ContentHashResponse
Gets or sets the hash.
type string
Gets or sets the content source type.
value string
Gets or sets the value of the content. This is based on the content source type.
version string
Gets or sets the version of the content.
hash ContentHashResponse
Gets or sets the hash.
type str
Gets or sets the content source type.
value str
Gets or sets the value of the content. This is based on the content source type.
version str
Gets or sets the version of the content.
hash Property Map
Gets or sets the hash.
type String
Gets or sets the content source type.
value String
Gets or sets the value of the content. This is based on the content source type.
version String
Gets or sets the version of the content.

DscConfigurationParameterResponse

DefaultValue string
Gets or sets the default value of parameter.
IsMandatory bool
Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
Position int
Get or sets the position of the parameter.
Type string
Gets or sets the type of the parameter.
DefaultValue string
Gets or sets the default value of parameter.
IsMandatory bool
Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
Position int
Get or sets the position of the parameter.
Type string
Gets or sets the type of the parameter.
defaultValue String
Gets or sets the default value of parameter.
isMandatory Boolean
Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
position Integer
Get or sets the position of the parameter.
type String
Gets or sets the type of the parameter.
defaultValue string
Gets or sets the default value of parameter.
isMandatory boolean
Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
position number
Get or sets the position of the parameter.
type string
Gets or sets the type of the parameter.
default_value str
Gets or sets the default value of parameter.
is_mandatory bool
Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
position int
Get or sets the position of the parameter.
type str
Gets or sets the type of the parameter.
defaultValue String
Gets or sets the default value of parameter.
isMandatory Boolean
Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
position Number
Get or sets the position of the parameter.
type String
Gets or sets the type of the parameter.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native