{ "swagger": "2.0", "info": { "title": "AutomationManagement", "version": "2018-01-15", "x-ms-code-generation-settings": { "useDateTimeOffset": true } }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodeConfigurations/{nodeConfigurationName}": { "delete": { "tags": [ "DscNodeConfiguration" ], "operationId": "DscNodeConfiguration_Delete", "description": "Delete the Dsc node configurations by node configuration.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/dscnodeconfigurations" }, "x-ms-examples": { "Delete a DSC node configuration": { "$ref": "./examples/deleteDscNodeConfiguration.json" } }, "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeConfigurationName", "in": "path", "required": true, "type": "string", "description": "The Dsc node configuration name." }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } }, "get": { "tags": [ "DscNodeConfiguration" ], "operationId": "DscNodeConfiguration_Get", "description": "Retrieve the Dsc node configurations by node configuration.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/dscnodeconfigurations" }, "x-ms-examples": { "Get a DSC node configuration": { "$ref": "./examples/getDscNodeConfiguration.json" } }, "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeConfigurationName", "in": "path", "required": true, "type": "string", "description": "The Dsc node configuration name." }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DscNodeConfiguration" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "DscNodeConfiguration" ], "operationId": "DscNodeConfiguration_CreateOrUpdate", "x-ms-long-running-operation": true, "description": "Create the node configuration identified by node configuration name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/dscnodeconfigurations" }, "x-ms-examples": { "Create node configuration": { "$ref": "./examples/createOrUpdateDscNodeConfiguration.json" } }, "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeConfigurationName", "in": "path", "required": true, "type": "string", "description": "The Dsc node configuration name." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DscNodeConfigurationCreateOrUpdateParameters" }, "description": "The create or update parameters for configuration." }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/DscNodeConfiguration" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodeConfigurations": { "get": { "tags": [ "DscNodeConfiguration" ], "operationId": "DscNodeConfiguration_ListByAutomationAccount", "description": "Retrieve a list of dsc node configurations.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/dscnodeconfigurations" }, "x-ms-examples": { "List DSC node configurations by Automation Account": { "$ref": "./examples/listDscNodeConfigurations.json" }, "List Paged DSC node configurations by Automation Account with no filter": { "$ref": "./examples/listPagedDscNodeConfigurationsWithNoFilter.json" }, "List Paged DSC node configurations by Automation Account with name filter": { "$ref": "./examples/listPagedDscNodeConfigurationsWithNameFilter.json" } }, "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "The filter to apply on the operation." }, { "name": "$skip", "in": "query", "required": false, "type": "integer", "description": "The number of rows to skip." }, { "name": "$top", "in": "query", "required": false, "type": "integer", "description": "The number of rows to take." }, { "name": "$inlinecount", "in": "query", "required": false, "type": "string", "description": "Return total rows." } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DscNodeConfigurationListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-odata": "#/definitions/DscNodeConfiguration" } } }, "definitions": { "ContentHash": { "properties": { "algorithm": { "type": "string", "description": "Gets or sets the content hash algorithm used to hash the content." }, "value": { "type": "string", "description": "Gets or sets expected hash value of the content." } }, "required": [ "algorithm", "value" ], "description": "Definition of the runbook property type." }, "ContentSource": { "properties": { "hash": { "$ref": "#/definitions/ContentHash", "description": "Gets or sets the hash." }, "type": { "type": "string", "description": "Gets or sets the content source type.", "enum": [ "embeddedContent", "uri" ], "x-ms-enum": { "name": "ContentSourceType", "modelAsString": true } }, "value": { "type": "string", "description": "Gets or sets the value of the content. This is based on the content source type." }, "version": { "type": "string", "description": "Gets or sets the version of the content." } }, "description": "Definition of the content source." }, "DscNodeConfiguration": { "type": "object", "properties": { "properties": { "$ref": "#/definitions/DscNodeConfigurationProperties", "x-ms-client-flatten": true, "description": "Gets or sets the configuration properties." } }, "allOf": [ { "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" } ], "description": "Definition of the dsc node configuration." }, "DscNodeConfigurationProperties": { "description": "Properties for the DscNodeConfiguration", "properties": { "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time.", "x-nullable": false }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets creation time.", "x-nullable": false }, "configuration": { "$ref": "#/definitions/DscConfigurationAssociationProperty", "description": "Gets or sets the configuration of the node." }, "source": { "type": "string", "description": "Source of node configuration." }, "nodeCount": { "type": "integer", "format": "int64", "description": "Number of nodes with this node configuration assigned" }, "incrementNodeConfigurationBuild": { "type": "boolean", "description": "If a new build version of NodeConfiguration is required." } } }, "DscNodeConfigurationListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/DscNodeConfiguration" }, "description": "Gets or sets a list of Dsc node configurations." }, "nextLink": { "type": "string", "description": "Gets or sets the next link." }, "totalCount": { "type": "integer", "description": "Gets or sets the total rows in query." } }, "description": "The response model for the list job operation." }, "DscNodeExtensionHandlerAssociationProperty": { "properties": { "name": { "type": "string", "description": "Gets or sets the name of the extension handler." }, "version": { "type": "string", "description": "Gets or sets the version of the extension handler." } }, "description": "The dsc extensionHandler property associated with the node" }, "DscNodeConfigurationCreateOrUpdateParameters": { "description": "The parameters supplied to the create or update node configuration operation.", "properties": { "properties": { "$ref": "#/definitions/DscNodeConfigurationCreateOrUpdateParametersProperties", "x-ms-client-flatten": true, "description": "Node configuration properties" }, "name": { "type": "string", "description": "Name of the node configuration." }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Gets or sets the tags attached to the resource." } } }, "DscNodeConfigurationCreateOrUpdateParametersProperties": { "properties": { "source": { "$ref": "#/definitions/ContentSource", "description": "Gets or sets the source." }, "configuration": { "$ref": "#/definitions/DscConfigurationAssociationProperty", "description": "Gets or sets the configuration of the node." }, "incrementNodeConfigurationBuild": { "type": "boolean", "description": "If a new build version of NodeConfiguration is required." } }, "required": [ "source", "configuration" ], "description": "The parameter properties supplied to the create or update node configuration operation." }, "DscConfigurationAssociationProperty": { "properties": { "name": { "type": "string", "description": "Gets or sets the name of the Dsc configuration." } }, "description": "The Dsc configuration property associated with the entity." } }, "parameters": {} }