openapi-directory/api/azure.com/automation-dscNodeConfiguration.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"title":"AutomationManagement","version":"2018-01-15","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNodeConfiguration.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"automation-dscNodeConfiguration","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodeConfigurations":{"get":{"description":"Retrieve a list of dsc node configurations.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/dscnodeconfigurations"},"operationId":"DscNodeConfiguration_ListByAutomationAccount","parameters":[{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"List DSC node configurations by Automation Account":{"value":"rg"},"List Paged DSC node configurations by Automation Account with name filter":{"value":"rg"},"List Paged DSC node configurations by Automation Account with no filter":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"List DSC node configurations by Automation Account":{"value":"myAutomationAccount33"},"List Paged DSC node configurations by Automation Account with name filter":{"value":"myAutomationAccount33"},"List Paged DSC node configurations by Automation Account with no filter":{"value":"myAutomationAccount33"}}},{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List DSC node configurations by Automation Account":{"value":"subid"},"List Paged DSC node configurations by Automation Account with name filter":{"value":"subid"},"List Paged DSC node configurations by Automation Account with no filter":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List DSC node configurations by Automation Account":{"value":"2018-01-15"},"List Paged DSC node configurations by Automation Account with name filter":{"value":"2018-01-15"},"List Paged DSC node configurations by Automation Account with no filter":{"value":"2018-01-15"}}},{"description":"The filter to apply on the operation.","in":"query","name":"$filter","required":false,"schema":{"type":"string"},"examples":{"List Paged DSC node configurations by Automation Account with name filter":{"value":"contains('.localhost',name)"}}},{"description":"The number of rows to skip.","in":"query","name":"$skip","required":false,"schema":{"type":"integer"},"examples":{"List Paged DSC node configurations by Automation Account with name filter":{"value":0},"List Paged DSC node configurations by Automation Account with no filter":{"value":0}}},{"description":"The number of rows to take.","in":"query","name":"$top","required":false,"schema":{"type":"integer"},"examples":{"List Paged DSC node configurations by Automation Account with name filter":{"value":2},"List Paged DSC node configurations by Automation Account with no filter":{"value":4}}},{"description":"Return total rows.","in":"query","name":"$inlinecount","required":false,"schema":{"type":"string"},"examples":{"List Paged DSC node configurations by Automation Account with name filter":{"value":"allpages"},"List Paged DSC node configurations by Automation Account with no filter":{"value":"allpages"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DscNodeConfigurationListResult"},"examples":{"List DSC node configurations by Automation Account":{"$ref":"#/components/examples/List_DSC_node_configurations_by_Automation_Account"},"List Paged DSC node configurations by Automation Account with name filter":{"$ref":"#/components/examples/List_Paged_DSC_node_configurations_by_Automation_Account_with_name_filter"},"List Paged DSC node configurations by Automation Account with no filter":{"$ref":"#/components/examples/List_Paged_DSC_node_configurations_by_Automation_Account_with_no_filter"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["DscNodeConfiguration"],"x-ms-odata":"#/components/schemas/DscNodeConfiguration","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodeConfigurations/{nodeConfigurationName}":{"delete":{"description":"Delete the Dsc node configurations by node configuration.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/dscnodeconfigurations"},"operationId":"DscNodeConfiguration_Delete","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Delete a DSC node configuration":{"value":"subid"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Delete a DSC node configuration":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Delete a DSC node configuration":{"value":"myAutomationAccount20"}}},{"description":"The Dsc node configuration name.","in":"path","name":"nodeConfigurationName","required":true,"schema":{"type":"string"},"examples":{"Delete a DSC node configuration":{"value":"configName.nodeConfigName"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete a DSC node configuration":{"value":"2018-01-15"}}}],"responses":{"200":{"description":"OK"},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["DscNodeConfiguration"]},"get":{"description":"Retrieve the Dsc node configurations by node configuration.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/dscnodeconfigurations"},"operationId":"DscNodeConfiguration_Get","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get a DSC node configuration":{"value":"subid"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Get a DSC node configuration":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get a DSC node configuration":{"value":"myAutomationAccount33"}}},{"description":"The Dsc node configuration name.","in":"path","name":"nodeConfigurationName","required":true,"schema":{"type":"string"},"examples":{"Get a DSC node configuration":{"value":"SetupServer.localhost"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get a DSC node configuration":{"value":"2018-01-15"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DscNodeConfiguration"},"examples":{"Get a DSC node configuration":{"$ref":"#/components/examples/Get_a_DSC_node_configuration"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["DscNodeConfiguration"]},"put":{"description":"Create the node configuration identified by node configuration name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/dscnodeconfigurations"},"operationId":"DscNodeConfiguration_CreateOrUpdate","parameters":[{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Create node configuration":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Create node configuration":{"value":"myAutomationAccount20"}}},{"description":"The Dsc node configuration name.","in":"path","name":"nodeConfigurationName","required":true,"schema":{"type":"string"},"examples":{"Create node configuration":{"value":"configName.nodeConfigName"}}},{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Create node configuration":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create node configuration":{"value":"2018-01-15"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DscNodeConfigurationCreateOrUpdateParameters"}}},"description":"The create or update parameters for configuration.","required":true},"responses":{"200":{"description":"OK"},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DscNodeConfiguration"},"examples":{"Create node configuration":{"$ref":"#/components/examples/Create_node_configuration"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["DscNodeConfiguration"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_DSC_node_configurations_by_Automation_Account":{"value":{"value":[{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SetupServer.localhost","name":"SetupServer.localhost","properties":{"configuration":{"name":"SetupServer"},"creationTime":"2017-03-28T23:17:06.8901968+00:00","incrementNodeConfigurationBuild":false,"lastModifiedTime":"2017-03-28T23:17:06.8901968+00:00","nodeCount":0},"type":"Microsoft.Automation/AutomationAccounts/nodeConfigurations"},{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SetupServer.localhost","name":"SetupServer.localhost","properties":{"configuration":{"name":"SetupServer"},"creationTime":"2017-03-28T23:17:06.8901968+00:00","incrementNodeConfigurationBuild":false,"lastModifiedTime":"2017-03-28T23:17:06.8901968+00:00","nodeCount":0},"type":"Microsoft.Automation/AutomationAccounts/nodeConfigurations"}]}},"List_Paged_DSC_node_configurations_by_Automation_Account_with_name_filter":{"value":{"totalCount":6,"value":[{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SetupServer.localhost","name":"server.localhost","properties":{"configuration":{"name":"SetupServer"},"creationTime":"2017-03-28T23:17:06.8901968+00:00","lastModifiedTime":"2017-03-28T23:17:06.8901968+00:00","nodeCount":2},"type":"Microsoft.Automation/AutomationAccounts/nodeConfigurations"},{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SetupClient.localhost","name":"SetupClient.localhost","properties":{"configuration":{"name":"SetupClient"},"creationTime":"2017-03-28T23:17:06.8901968+00:00","lastModifiedTime":"2017-03-28T23:17:06.8901968+00:00","nodeCount":6},"type":"Microsoft.Automation/AutomationAccounts/nodeConfigurations"}]}},"List_Paged_DSC_node_configurations_by_Automation_Account_with_no_filter":{"value":{"totalCount":12,"value":[{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SetupServer.localhost","name":"server.localhost","properties":{"configuration":{"name":"SetupServer"},"creationTime":"2017-03-28T23:17:06.8901968+00:00","lastModifiedTime":"2017-03-28T23:17:06.8901968+00:00","nodeCount":2},"type":"Microsoft.Automation/AutomationAccounts/nodeConfigurations"},{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SetupClient.localhost","name":"SetupClient.localhost","properties":{"configuration":{"name":"SetupClient"},"creationTime":"2017-03-28T23:17:06.8901968+00:00","lastModifiedTime":"2017-03-28T23:17:06.8901968+00:00","nodeCount":6},"type":"Microsoft.Automation/AutomationAccounts/nodeConfigurations"},{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/webServer.localhost","name":"webServer.localhost","properties":{"configuration":{"name":"webServer"},"creationTime":"2017-03-28T23:17:06.8901968+00:00","lastModifiedTime":"2017-03-28T23:17:06.8901968+00:00","nodeCount":5},"type":"Microsoft.Automation/AutomationAccounts/nodeConfigurations"},{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SqlServer.localhost","name":"SqlServer.localhost","properties":{"configuration":{"name":"SqlServer"},"creationTime":"2017-03-28T23:17:06.8901968+00:00","lastModifiedTime":"2017-03-28T23:17:06.8901968+00:00","nodeCount":1},"type":"Microsoft.Automation/AutomationAccounts/nodeConfigurations"}]}},"Get_a_DSC_node_configuration":{"value":{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SetupServer.localhost","name":"SetupServer.localhost","properties":{"configuration":{"name":"SetupServer"},"creationTime":"2017-03-28T23:17:06.8901968+00:00","incrementNodeConfigurationBuild":false,"lastModifiedTime":"2017-03-28T23:17:06.8901968+00:00","nodeCount":0},"type":"Microsoft.Automation/AutomationAccounts/nodeConfigurations"}},"Create_node_configuration":{"value":{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount20/nodeConfigurations/configName.nodeConfigName","name":"configName.nodeConfigName","properties":{"configuration":{"name":"configName"},"creationTime":"2018-03-25T01:29:17.1205764+00:00","incrementNodeConfigurationBuild":false,"lastModifiedTime":"2018-03-25T01:29:17.1205764+00:00","nodeCount":0},"type":"Microsoft.Automation/AutomationAccounts/nodeConfigurations"}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"ContentHash":{"description":"Definition of the runbook property type.","properties":{"algorithm":{"description":"Gets or sets the content hash algorithm used to hash the content.","type":"string"},"value":{"description":"Gets or sets expected hash value of the content.","type":"string"}},"required":["algorithm","value"]},"ContentSource":{"description":"Definition of the content source.","properties":{"hash":{"$ref":"#/components/schemas/ContentHash"},"type":{"description":"Gets or sets the content source type.","enum":["embeddedContent","uri"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"ContentSourceType"}},"value":{"description":"Gets or sets the value of the content. This is based on the content source type.","type":"string"},"version":{"description":"Gets or sets the version of the content.","type":"string"}}},"DscConfigurationAssociationProperty":{"description":"The Dsc configuration property associated with the entity.","properties":{"name":{"description":"Gets or sets the name of the Dsc configuration.","type":"string"}}},"DscNodeConfiguration":{"allOf":[{"allOf":[{"description":"The core properties of ARM resources","properties":{"id":{"description":"Fully qualified resource Id for the resource","readOnly":true,"type":"string"},"name":{"description":"The name of the resource","readOnly":true,"type":"string"},"type":{"description":"The type of the resource.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"ARM proxy resource.","properties":{},"type":"object"}],"description":"Definition of the dsc node configuration.","properties":{"properties":{"$ref":"#/components/schemas/DscNodeConfigurationProperties"}},"type":"object"},"DscNodeConfigurationCreateOrUpdateParameters":{"description":"The parameters supplied to the create or update node configuration operation.","properties":{"name":{"description":"Name of the node configuration.","type":"string"},"properties":{"$ref":"#/components/schemas/DscNodeConfigurationCreateOrUpdateParametersProperties"},"tags":{"additionalProperties":{"type":"string"},"description":"Gets or sets the tags attached to the resource.","type":"object"}}},"DscNodeConfigurationCreateOrUpdateParametersProperties":{"description":"The parameter properties supplied to the create or update node configuration operation.","properties":{"configuration":{"$ref":"#/components/schemas/DscConfigurationAssociationProperty"},"incrementNodeConfigurationBuild":{"description":"If a new build version of NodeConfiguration is required.","type":"boolean"},"source":{"$ref":"#/components/schemas/ContentSource"}},"required":["source","configuration"]},"DscNodeConfigurationListResult":{"description":"The response model for the list job operation.","properties":{"nextLink":{"description":"Gets or sets the next link.","type":"string"},"totalCount":{"description":"Gets or sets the total rows in query.","type":"integer"},"value":{"description":"Gets or sets a list of Dsc node configurations.","items":{"$ref":"#/components/schemas/DscNodeConfiguration"},"type":"array"}}},"DscNodeConfigurationProperties":{"description":"Properties for the DscNodeConfiguration","properties":{"configuration":{"$ref":"#/components/schemas/DscConfigurationAssociationProperty"},"creationTime":{"description":"Gets or sets creation time.","format":"date-time","type":"string","nullable":false},"incrementNodeConfigurationBuild":{"description":"If a new build version of NodeConfiguration is required.","type":"boolean"},"lastModifiedTime":{"description":"Gets or sets the last modified time.","format":"date-time","type":"string","nullable":false},"nodeCount":{"description":"Number of nodes with this node configuration assigned","format":"int64","type":"integer"},"source":{"description":"Source of node configuration.","type":"string"}}},"DscNodeExtensionHandlerAssociationProperty":{"description":"The dsc extensionHandler property associated with the node","properties":{"name":{"description":"Gets or sets the name of the extension handler.","type":"string"},"version":{"description":"Gets or sets the version of the extension handler.","type":"string"}}}}}}