Dsc Configuration - Create Or Update

Reference

Service:: Automation

API Version:: 2023-11-01

Create the configuration identified by configuration name.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}?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 create or update parameters for configuration.
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.

Request Body

Media Types: "application/json", "text/plain; charset=utf-8"

Name	Required	Type	Description
properties.source	True	ContentSource	Gets or sets the source.
location		string	Gets or sets the location of the resource.
name		string	Gets or sets name of the resource.
properties.description		string	Gets or sets the description of the configuration.
properties.logProgress		boolean	Gets or sets progress log option.
properties.logVerbose		boolean	Gets or sets verbose log option.
properties.parameters		<string, DscConfigurationParameter>	Gets or sets the configuration parameters.
tags		object	Gets or sets the tags attached to the resource.

Responses

Name	Type	Description
200 OK	DscConfiguration	OK Media Types: "application/json", "text/plain; charset=utf-8"
201 Created	DscConfiguration	Created Media Types: "application/json", "text/plain; charset=utf-8"
Other Status Codes	ErrorResponse	Automation error response describing why the operation failed. Media Types: "application/json", "text/plain; charset=utf-8"

Name

Type

Description

200 OK

DscConfiguration

Media Types: "application/json", "text/plain; charset=utf-8"

201 Created

DscConfiguration

Created

Media Types: "application/json", "text/plain; charset=utf-8"

Other Status Codes

ErrorResponse

Automation error response describing why the operation failed.

Media Types: "application/json", "text/plain; charset=utf-8"

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

Create or Update Configuration

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount18/configurations/SetupServer?api-version=2023-11-01

{
  "properties": {
    "source": {
      "hash": {
        "algorithm": "sha256",
        "value": "A9E5DB56BA21513F61E0B3868816FDC6D4DF5131F5617D7FF0D769674BD5072F"
      },
      "type": "embeddedContent",
      "value": "Configuration SetupServer {\r\n    Node localhost {\r\n                               WindowsFeature IIS {\r\n                               Name = \"Web-Server\";\r\n            Ensure = \"Present\"\r\n        }\r\n    }\r\n}"
    },
    "description": "sample configuration"
  },
  "name": "SetupServer",
  "location": "East US 2"
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/configurations/SetupServer",
  "name": "SetupServer",
  "type": "Microsoft.Automation/AutomationAccounts/Configurations",
  "location": "East US 2",
  "tags": {},
  "etag": null,
  "properties": {
    "provisioningState": "Succeeded",
    "jobCount": 0,
    "parameters": {},
    "description": "sample configuration",
    "state": null,
    "creationTime": "0001-01-01T00:00:00+00:00",
    "lastModifiedTime": "0001-01-01T00:00:00+00:00",
    "logVerbose": false
  }
}

Status code:: 201

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/configurations/SetupServer",
  "name": "SetupServer",
  "type": "Microsoft.Automation/AutomationAccounts/Configurations",
  "location": "East US 2",
  "tags": {},
  "etag": "\"636263396635600000\"",
  "properties": {
    "provisioningState": "Succeeded",
    "jobCount": 0,
    "parameters": {},
    "description": "sample configuration",
    "state": "Published",
    "creationTime": "2017-03-28T23:14:23.56+00:00",
    "lastModifiedTime": "2017-03-28T23:14:23.56+00:00",
    "logVerbose": false
  }
}

Definitions

Name	Description
ContentHash	Definition of the runbook property type.
ContentSource	Definition of the content source.
ContentSourceType	Gets or sets the content source type.
DscConfiguration	Definition of the configuration type.
DscConfigurationCreateOrUpdateParameters	The parameters supplied to the create or update configuration operation.
DscConfigurationParameter	Definition of the configuration parameter type.
DscConfigurationProvisioningState	Gets or sets the provisioning state of the configuration.
DscConfigurationState	Gets or sets the state of the configuration.
ErrorResponse	Error response of an operation failure

ContentHash

Definition of the runbook property type.

Name	Type	Description
algorithm	string	Gets or sets the content hash algorithm used to hash the content.
value	string	Gets or sets expected hash value of the content.

ContentSource

Definition of the content source.

Name	Type	Description
hash	ContentHash	Gets or sets the hash.
type	ContentSourceType	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.

ContentSourceType

Gets or sets the content source type.

Name	Type	Description
embeddedContent	string
uri	string