Dsc Configuration - Get Content

  • Reference
Service:
Automation
API Version:
2023-11-01

Retrieve the configuration script identified by configuration name.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}/content?api-version=2023-11-01

URI Parameters

Name In Required Type Description
automationAccountName
 path True

string

The name of the automation account.
configurationName
 path True

string

The configuration name.
resourceGroupName
 path True

string

Name of an Azure Resource group.

Regex pattern: ^[-\w\._]+$
subscriptionId
 path True

string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version
 query True

string

Client Api Version.

Responses

Name Type Description
200 OK

file

OK

Media Types: "text/powershell"
Other Status Codes

ErrorResponse

Automation error response describing why the operation failed.

Media Types: "text/powershell"

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Get DSC Configuration content

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/configurations/ConfigName/content?api-version=2023-11-01

Sample Response

Status code:
200 
Content-Type: text/powershell
Response Body
"Configuration ConfigName {\r\n    Node localhost {\r\n                               WindowsFeature IIS {\r\n                               Name = \"Web-Server\";\r\n            Ensure = \"Present\"\r\n        }\r\n    }\r\n}"

Definitions

ErrorResponse

Error response of an operation failure

Name Type Description
code

string

Error code
message

string

Error message indicating why the operation failed.