{ "swagger": "2.0", "info": { "title": "AutomationManagementClient", "version": "2024-10-23", "description": "Automation Client", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "Operations" }, { "name": "Software Update Configuration" }, { "name": "AutomationAccount" }, { "name": "NodeCountInformation" }, { "name": "PrivateLinkResources" }, { "name": "AgentRegistrationInformation" }, { "name": "ListDeletedRunbooks" }, { "name": "Statistics" }, { "name": "Usages" }, { "name": "ListKeys" }, { "name": "Job" }, { "name": "LinkedWorkspace" }, { "name": "ObjectDataTypes" }, { "name": "Software Update Configuration Machine Run" }, { "name": "Software Update Configuration Run" }, { "name": "Webhook" }, { "name": "DscNode" }, { "name": "NodeReports" }, { "name": "Certificate" }, { "name": "Connection" }, { "name": "ConnectionType" }, { "name": "Credential" }, { "name": "DscConfiguration" }, { "name": "DscNodeConfiguration" }, { "name": "HybridRunbookWorker" }, { "name": "HybridRunbookWorkerGroup" }, { "name": "ListAllHybridRunbookWorkerGroupInAutomationAccount" }, { "name": "JobStream" }, { "name": "JobSchedule" }, { "name": "Module" }, { "name": "Activity" }, { "name": "TypeFields" }, { "name": "Python2Package" }, { "name": "Python3Package" }, { "name": "Package" }, { "name": "RuntimeEnvironment" }, { "name": "PrivateEndpointConnections" }, { "name": "Runbook" }, { "name": "RunbookDraft" }, { "name": "TestJobStream" }, { "name": "TestJob" }, { "name": "Schedule" }, { "name": "SourceControl" }, { "name": "SourceControlSyncJob" }, { "name": "SourceControlSyncJobStreams" }, { "name": "Variable" }, { "name": "Watcher" }, { "name": "DeletedAutomationAccounts" } ], "paths": { "/providers/Microsoft.Automation/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "description": "Lists all of the available Automation REST API operations.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Lists all of the available Automation REST API operations.": { "$ref": "./examples/listRestAPIOperations.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Automation/automationAccounts": { "get": { "operationId": "AutomationAccount_List", "tags": [ "AutomationAccount" ], "summary": "Lists the Automation Accounts within an Azure subscription.", "description": "Retrieve a list of accounts within a given subscription.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AutomationAccountListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List automation accounts by resource group": { "$ref": "./examples/listAutomationAccountsBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Automation/deletedAutomationAccounts": { "get": { "operationId": "deletedAutomationAccounts_ListBySubscription", "tags": [ "DeletedAutomationAccounts" ], "description": "Retrieve deleted automation account.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DeletedAutomationAccountListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get deleted automation account": { "$ref": "./examples/getDeletedAutomationAccount.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts": { "get": { "operationId": "AutomationAccount_ListByResourceGroup", "tags": [ "AutomationAccount" ], "description": "Retrieve a list of accounts within a given resource group.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/automationaccountoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AutomationAccountListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List automation accounts by resource group": { "$ref": "./examples/listAutomationAccountsByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}": { "get": { "operationId": "AutomationAccount_Get", "tags": [ "AutomationAccount" ], "description": "Get information about an Automation Account.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/automationaccountoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AutomationAccount" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get automation account": { "$ref": "./examples/getAutomationAccount.json" } } }, "put": { "operationId": "AutomationAccount_CreateOrUpdate", "tags": [ "AutomationAccount" ], "description": "Create or update automation account.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/automationaccountoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the create or update automation account.", "required": true, "schema": { "$ref": "#/definitions/AutomationAccountCreateOrUpdateParameters" } } ], "responses": { "200": { "description": "Resource 'AutomationAccount' update operation succeeded", "schema": { "$ref": "#/definitions/AutomationAccount" } }, "201": { "description": "Resource 'AutomationAccount' create operation succeeded", "schema": { "$ref": "#/definitions/AutomationAccount" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update automation account": { "$ref": "./examples/createOrUpdateAutomationAccount.json" } } }, "patch": { "operationId": "AutomationAccount_Update", "tags": [ "AutomationAccount" ], "description": "Update an automation account.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/automationaccountoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the update automation account.", "required": true, "schema": { "$ref": "#/definitions/AutomationAccountUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AutomationAccount" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update an automation account": { "$ref": "./examples/updateAutomationAccount.json" } } }, "delete": { "operationId": "AutomationAccount_Delete", "tags": [ "AutomationAccount" ], "description": "Delete an automation account.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/automationaccountoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete automation account": { "$ref": "./examples/deleteAutomationAccount.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/agentRegistrationInformation": { "get": { "operationId": "AgentRegistrationInformation_Get", "tags": [ "AgentRegistrationInformation" ], "description": "Retrieve the automation agent registration information.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/agentregistrationoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AgentRegistration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get the agent registration information": { "$ref": "./examples/getAgentRegistration.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/agentRegistrationInformation/regenerateKey": { "post": { "operationId": "AgentRegistrationInformation_RegenerateKey", "tags": [ "AgentRegistrationInformation" ], "description": "Regenerate a primary or secondary agent registration key", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/agentregistrationoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The name of the agent registration key to be regenerated", "required": true, "schema": { "$ref": "#/definitions/AgentRegistrationRegenerateKeyParameter" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AgentRegistration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Regenerate registration key": { "$ref": "./examples/regenerateAgentRegistrationKey.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/certificates": { "get": { "operationId": "Certificate_ListByAutomationAccount", "tags": [ "Certificate" ], "description": "Retrieve a list of certificates.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/certificateoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CertificateListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List certificates": { "$ref": "./examples/listCertificatesByAutomationAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/certificates/{certificateName}": { "get": { "operationId": "Certificate_Get", "tags": [ "Certificate" ], "description": "Retrieve the certificate identified by certificate name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/certificateoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "certificateName", "in": "path", "description": "The name of certificate.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Certificate" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a certificate": { "$ref": "./examples/getCertificate.json" } } }, "put": { "operationId": "Certificate_CreateOrUpdate", "tags": [ "Certificate" ], "description": "Create a certificate.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/certificateoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "certificateName", "in": "path", "description": "The name of certificate.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters supplied to the create or update certificate operation.", "required": true, "schema": { "$ref": "#/definitions/CertificateCreateOrUpdateParameters" } } ], "responses": { "200": { "description": "Resource 'Certificate' update operation succeeded", "schema": { "$ref": "#/definitions/Certificate" } }, "201": { "description": "Resource 'Certificate' create operation succeeded", "schema": { "$ref": "#/definitions/Certificate" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update a certificate": { "$ref": "./examples/createOrUpdateCertificate.json" } } }, "patch": { "operationId": "Certificate_Update", "tags": [ "Certificate" ], "description": "Update a certificate.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/certificateoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "certificateName", "in": "path", "description": "The name of certificate.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters supplied to the update certificate operation.", "required": true, "schema": { "$ref": "#/definitions/CertificateUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Certificate" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a certificate": { "$ref": "./examples/updateCertificate.json" } } }, "delete": { "operationId": "Certificate_Delete", "tags": [ "Certificate" ], "description": "Delete the certificate.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/certificateoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "certificateName", "in": "path", "description": "The name of certificate.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a certificate": { "$ref": "./examples/deleteCertificate.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations": { "get": { "operationId": "DscConfiguration_ListByAutomationAccount", "tags": [ "DscConfiguration" ], "description": "Retrieve a list of configurations.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/configurationoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation.", "required": false, "type": "string" }, { "name": "$skip", "in": "query", "description": "The number of rows to skip.", "required": false, "type": "integer", "format": "int32" }, { "name": "$top", "in": "query", "description": "The number of rows to take.", "required": false, "type": "integer", "format": "int32" }, { "name": "$inlinecount", "in": "query", "description": "Return total rows.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DscConfigurationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get DSC Configuration": { "$ref": "./examples/getAllDscConfigurations.json" }, "List Paged DSC Configurations with name filter": { "$ref": "./examples/getPagedlDscConfigurationsWithNameFilter.json" }, "List Paged DSC Configurations with no filter": { "$ref": "./examples/getPagedDscConfigurationsWithNoFilter.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}": { "get": { "operationId": "DscConfiguration_Get", "tags": [ "DscConfiguration" ], "description": "Retrieve the configuration identified by configuration name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/configurationoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "configurationName", "in": "path", "description": "The configuration name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DscConfiguration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a DSC Configuration": { "$ref": "./examples/getDscConfiguration.json" } } }, "put": { "operationId": "DscConfiguration_CreateOrUpdate", "tags": [ "DscConfiguration" ], "description": "Create the configuration identified by configuration name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/configurationoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "configurationName", "in": "path", "description": "The configuration name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The create or update parameters for configuration.", "required": true, "schema": { "$ref": "#/definitions/DscConfigurationCreateOrUpdateParameters" } } ], "responses": { "200": { "description": "Resource 'DscConfiguration' update operation succeeded", "schema": { "$ref": "#/definitions/DscConfiguration" } }, "201": { "description": "Resource 'DscConfiguration' create operation succeeded", "schema": { "$ref": "#/definitions/DscConfiguration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or Update Configuration": { "$ref": "./examples/createOrUpdateDscConfiguration.json" } } }, "patch": { "operationId": "DscConfiguration_Update", "tags": [ "DscConfiguration" ], "description": "Create the configuration identified by configuration name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/configurationoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "configurationName", "in": "path", "description": "The configuration name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The create or update parameters for configuration.", "required": false, "schema": { "$ref": "#/definitions/DscConfigurationUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DscConfiguration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or Update Configuration": { "$ref": "./examples/updateDscConfiguration.json" } } }, "delete": { "operationId": "DscConfiguration_Delete", "tags": [ "DscConfiguration" ], "description": "Delete the dsc configuration identified by configuration name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/configurationoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "configurationName", "in": "path", "description": "The configuration name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete DSC Configuration": { "$ref": "./examples/deleteDscConfiguration.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}/content": { "get": { "operationId": "DscConfiguration_GetContent", "tags": [ "DscConfiguration" ], "description": "Retrieve the configuration script identified by configuration name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/configurationoperations" }, "produces": [ "text/powershell", "application/json" ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "configurationName", "in": "path", "description": "The configuration name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get DSC Configuration content": { "$ref": "./examples/getDscConfigurationContent.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connectionTypes": { "get": { "operationId": "ConnectionType_ListByAutomationAccount", "tags": [ "ConnectionType" ], "description": "Retrieve a list of connection types.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/connectiontypeoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConnectionTypeListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get connection types, first 100": { "$ref": "./examples/getAllConnectionTypes_First100.json" }, "Get connection types, next 100": { "$ref": "./examples/getAllConnectionTypes_Next100.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connectionTypes/{connectionTypeName}": { "get": { "operationId": "ConnectionType_Get", "tags": [ "ConnectionType" ], "description": "Retrieve the connection type identified by connection type name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/connectiontypeoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "connectionTypeName", "in": "path", "description": "The name of connection type.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConnectionType" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get connection type": { "$ref": "./examples/getConnectionType.json" } } }, "put": { "operationId": "ConnectionType_CreateOrUpdate", "tags": [ "ConnectionType" ], "description": "Create a connection type.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/connectiontypeoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "connectionTypeName", "in": "path", "description": "The name of connection type.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters supplied to the create or update connection type operation.", "required": true, "schema": { "$ref": "#/definitions/ConnectionTypeCreateOrUpdateParameters" } } ], "responses": { "201": { "description": "Resource 'ConnectionType' create operation succeeded", "schema": { "$ref": "#/definitions/ConnectionType" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update connection type": { "$ref": "./examples/createOrUpdateConnectionType.json" } } }, "delete": { "operationId": "ConnectionType_Delete", "tags": [ "ConnectionType" ], "description": "Delete the connection type.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/connectiontypeoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "connectionTypeName", "in": "path", "description": "The name of connection type.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete an existing connection type": { "$ref": "./examples/deleteConnectionType.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connections": { "get": { "operationId": "Connection_ListByAutomationAccount", "tags": [ "Connection" ], "description": "Retrieve a list of connections.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/connectionoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConnectionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List connections by automation account, first 100": { "$ref": "./examples/listConnectionsByAutomationAccount_First100.json" }, "List connections by automation account, next 100": { "$ref": "./examples/listConnectionsByAutomationAccount_Next100.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connections/{connectionName}": { "get": { "operationId": "Connection_Get", "tags": [ "Connection" ], "description": "Retrieve the connection identified by connection name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/connectionoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Connection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a connection": { "$ref": "./examples/getConnection.json" } } }, "put": { "operationId": "Connection_CreateOrUpdate", "tags": [ "Connection" ], "description": "Create or update a connection.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/connectionoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of connection.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters supplied to the create or update connection operation.", "required": true, "schema": { "$ref": "#/definitions/ConnectionCreateOrUpdateParameters" } } ], "responses": { "200": { "description": "Resource 'Connection' update operation succeeded", "schema": { "$ref": "#/definitions/Connection" } }, "201": { "description": "Resource 'Connection' create operation succeeded", "schema": { "$ref": "#/definitions/Connection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update connection": { "$ref": "./examples/createOrUpdateConnection.json" } } }, "patch": { "operationId": "Connection_Update", "tags": [ "Connection" ], "description": "Update a connection.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/connectionoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of connection.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters supplied to the update a connection operation.", "required": true, "schema": { "$ref": "#/definitions/ConnectionUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Connection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a connection": { "$ref": "./examples/updateConnection.json" } } }, "delete": { "operationId": "Connection_Delete", "tags": [ "Connection" ], "description": "Delete the connection.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/connectionoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete an existing connection": { "$ref": "./examples/deleteConnection.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/convertGraphRunbookContent": { "post": { "operationId": "convertGraphRunbookContent", "tags": [ "Operations" ], "description": "Post operation to serialize or deserialize GraphRunbookContent", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Input data describing the graphical runbook.", "required": true, "schema": { "$ref": "#/definitions/GraphicalRunbookContent" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GraphicalRunbookContent" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get Graphical raw runbook content from graphical runbook JSON object": { "$ref": "./examples/serializeGraphRunbookContent.json" }, "Get Graphical runbook content from raw content": { "$ref": "./examples/deserializeGraphRunbookContent.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/credentials": { "get": { "operationId": "Credential_ListByAutomationAccount", "tags": [ "Credential" ], "description": "Retrieve a list of credentials.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/credentialoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CredentialListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List credentials by automation account, first 100": { "$ref": "./examples/listCredentialsByAutomationAccount.json" }, "List credentials by automation account, next 100": { "$ref": "./examples/listCredentialsByAutomationAccount_next100_using_nextLink.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/credentials/{credentialName}": { "get": { "operationId": "Credential_Get", "tags": [ "Credential" ], "description": "Retrieve the credential identified by credential name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/credentialoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "credentialName", "in": "path", "description": "The name of credential.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Credential" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a credential": { "$ref": "./examples/getCredential.json" } } }, "put": { "operationId": "Credential_CreateOrUpdate", "tags": [ "Credential" ], "description": "Create a credential.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/credentialoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "credentialName", "in": "path", "description": "The name of credential.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters supplied to the create or update credential operation.", "required": true, "schema": { "$ref": "#/definitions/CredentialCreateOrUpdateParameters" } } ], "responses": { "200": { "description": "Resource 'Credential' update operation succeeded", "schema": { "$ref": "#/definitions/Credential" } }, "201": { "description": "Resource 'Credential' create operation succeeded", "schema": { "$ref": "#/definitions/Credential" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create a credential": { "$ref": "./examples/createOrUpdateCredential.json" } } }, "patch": { "operationId": "Credential_Update", "tags": [ "Credential" ], "description": "Update a credential.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/credentialoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "credentialName", "in": "path", "description": "The name of credential.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters supplied to the Update credential operation.", "required": true, "schema": { "$ref": "#/definitions/CredentialUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Credential" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a credential": { "$ref": "./examples/updateCredential_patch.json" } } }, "delete": { "operationId": "Credential_Delete", "tags": [ "Credential" ], "description": "Delete the credential.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/credentialoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "credentialName", "in": "path", "description": "The name of credential.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a credential": { "$ref": "./examples/deleteCredentialExisting.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups": { "get": { "operationId": "HybridRunbookWorkerGroup_ListByAutomationAccount", "tags": [ "HybridRunbookWorkerGroup" ], "description": "Retrieve a list of hybrid runbook worker groups.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/hybridrunbookworkergroupoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/HybridRunbookWorkerGroupsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List hybrid worker groups by Automation Account": { "$ref": "./examples/listHybridRunbookWorkerGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}": { "get": { "operationId": "HybridRunbookWorkerGroup_Get", "tags": [ "HybridRunbookWorkerGroup" ], "description": "Retrieve a hybrid runbook worker group.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/hybridrunbookworkergroupoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "hybridRunbookWorkerGroupName", "in": "path", "description": "The hybrid runbook worker group name", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/HybridRunbookWorkerGroup" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a hybrid worker group": { "$ref": "./examples/getHybridRunbookWorkerGroup.json" } } }, "put": { "operationId": "HybridRunbookWorkerGroup_Create", "tags": [ "HybridRunbookWorkerGroup" ], "description": "Create a hybrid runbook worker group.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/hybridrunbookworkergroupoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "hybridRunbookWorkerGroupName", "in": "path", "description": "The hybrid runbook worker group name", "required": true, "type": "string" }, { "name": "HybridRunbookWorkerGroupCreationParameters", "in": "body", "description": "The create or update parameters for hybrid runbook worker group.", "required": true, "schema": { "$ref": "#/definitions/HybridRunbookWorkerGroupCreateOrUpdateParameters" } } ], "responses": { "200": { "description": "Resource 'HybridRunbookWorkerGroup' update operation succeeded", "schema": { "$ref": "#/definitions/HybridRunbookWorkerGroup" } }, "201": { "description": "Resource 'HybridRunbookWorkerGroup' create operation succeeded", "schema": { "$ref": "#/definitions/HybridRunbookWorkerGroup" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create a hybrid worker group": { "$ref": "./examples/putHybridRunbookWorkerGroup.json" } } }, "patch": { "operationId": "HybridRunbookWorkerGroup_Update", "tags": [ "HybridRunbookWorkerGroup" ], "description": "Update a hybrid runbook worker group.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/hybridrunbookworkergroupoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "hybridRunbookWorkerGroupName", "in": "path", "description": "The hybrid runbook worker group name", "required": true, "type": "string" }, { "name": "HybridRunbookWorkerGroupUpdationParameters", "in": "body", "description": "The hybrid runbook worker group", "required": true, "schema": { "$ref": "#/definitions/HybridRunbookWorkerGroupCreateOrUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/HybridRunbookWorkerGroup" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update hybrid worker group": { "$ref": "./examples/updateHybridRunbookWorkerGroup.json" } } }, "delete": { "operationId": "HybridRunbookWorkerGroup_Delete", "tags": [ "ListAllHybridRunbookWorkerGroupInAutomationAccount" ], "description": "Delete a hybrid runbook worker group.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/hybridrunbookworkergroupoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "hybridRunbookWorkerGroupName", "in": "path", "description": "The hybrid runbook worker group name", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a hybrid worker group": { "$ref": "./examples/deleteHybridRunbookWorkerGroup.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}/hybridRunbookWorkers": { "get": { "operationId": "HybridRunbookWorkers_ListByHybridRunbookWorkerGroup", "tags": [ "HybridRunbookWorker" ], "description": "Retrieve a list of hybrid runbook workers.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/hybridrunbookworkeroperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "hybridRunbookWorkerGroupName", "in": "path", "description": "The hybrid runbook worker group name", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/HybridRunbookWorkersListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List hybrid workers by hybrid runbook worker group": { "$ref": "./examples/listHybridRunbookWorker.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}/hybridRunbookWorkers/{hybridRunbookWorkerId}": { "get": { "operationId": "HybridRunbookWorkers_Get", "tags": [ "HybridRunbookWorker" ], "description": "Retrieve a hybrid runbook worker.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/hybridrunbookworkeroperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "hybridRunbookWorkerGroupName", "in": "path", "description": "The hybrid runbook worker group name", "required": true, "type": "string" }, { "name": "hybridRunbookWorkerId", "in": "path", "description": "The hybrid runbook worker id", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/HybridRunbookWorker" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a V2 hybrid runbook worker": { "$ref": "./examples/getHybridRunbookWorker.json" } } }, "put": { "operationId": "HybridRunbookWorkers_Create", "tags": [ "HybridRunbookWorker" ], "description": "Create a hybrid runbook worker.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/hybridrunbookworkeroperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "hybridRunbookWorkerGroupName", "in": "path", "description": "The hybrid runbook worker group name", "required": true, "type": "string" }, { "name": "hybridRunbookWorkerId", "in": "path", "description": "The hybrid runbook worker id", "required": true, "type": "string" }, { "name": "HybridRunbookWorkerCreationParameters", "in": "body", "description": "The create or update parameters for hybrid runbook worker.", "required": true, "schema": { "$ref": "#/definitions/HybridRunbookWorkerCreateParameters" } } ], "responses": { "200": { "description": "Resource 'HybridRunbookWorker' update operation succeeded", "schema": { "$ref": "#/definitions/HybridRunbookWorker" } }, "201": { "description": "Resource 'HybridRunbookWorker' create operation succeeded", "schema": { "$ref": "#/definitions/HybridRunbookWorker" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create a V2 hybrid runbook worker": { "$ref": "./examples/putHybridRunbookWorker.json" } } }, "patch": { "operationId": "HybridRunbookWorkers_Patch", "tags": [ "HybridRunbookWorker" ], "description": "Update a hybrid runbook worker.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/hybridrunbookworkeroperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "hybridRunbookWorkerGroupName", "in": "path", "description": "The hybrid runbook worker group name", "required": true, "type": "string" }, { "name": "hybridRunbookWorkerId", "in": "path", "description": "The hybrid runbook worker id", "required": true, "type": "string" }, { "name": "HybridRunbookWorkerCreationParameters", "in": "body", "description": "The create or update parameters for hybrid runbook worker.", "required": false, "schema": { "$ref": "#/definitions/HybridRunbookWorkerCreateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/HybridRunbookWorker" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create a V2 hybrid runbook worker": { "$ref": "./examples/patchHybridRunbookWorker.json" } } }, "delete": { "operationId": "HybridRunbookWorkers_Delete", "tags": [ "HybridRunbookWorker" ], "description": "Delete a hybrid runbook worker.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/hybridrunbookworkeroperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "hybridRunbookWorkerGroupName", "in": "path", "description": "The hybrid runbook worker group name", "required": true, "type": "string" }, { "name": "hybridRunbookWorkerId", "in": "path", "description": "The hybrid runbook worker id", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a V2 hybrid runbook worker": { "$ref": "./examples/deleteHybridRunbookWorker.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}/hybridRunbookWorkers/{hybridRunbookWorkerId}/move": { "post": { "operationId": "HybridRunbookWorkers_Move", "tags": [ "HybridRunbookWorker" ], "description": "Move a hybrid worker to a different group.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/hybridrunbookworkeroperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "hybridRunbookWorkerGroupName", "in": "path", "description": "The hybrid runbook worker group name", "required": true, "type": "string" }, { "name": "hybridRunbookWorkerId", "in": "path", "description": "The hybrid runbook worker id", "required": true, "type": "string" }, { "name": "HybridRunbookWorkerMoveParameters", "in": "body", "description": "The hybrid runbook worker move parameters", "required": true, "schema": { "$ref": "#/definitions/HybridRunbookWorkerMoveParameters" } } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Move a V2 hybrid worker to a different group": { "$ref": "./examples/moveHybridRunbookWorker.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobSchedules": { "get": { "operationId": "JobSchedule_ListByAutomationAccount", "tags": [ "JobSchedule" ], "description": "Retrieve a list of job schedules.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/jobscheduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/JobScheduleListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all job schedules by automation account": { "$ref": "./examples/listAllJobSchedulesByAutomationAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobSchedules/{jobScheduleId}": { "get": { "operationId": "JobSchedule_Get", "tags": [ "JobSchedule" ], "description": "Retrieve the job schedule identified by job schedule name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/jobscheduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "jobScheduleId", "in": "path", "description": "The job schedule name.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/JobSchedule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a job schedule": { "$ref": "./examples/getJobSchedule.json" } } }, "put": { "operationId": "JobSchedule_Create", "tags": [ "JobSchedule" ], "description": "Create a job schedule.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/jobscheduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "jobScheduleId", "in": "path", "description": "The job schedule name.", "required": true, "type": "string", "format": "uuid" }, { "name": "parameters", "in": "body", "description": "The parameters supplied to the create job schedule operation.", "required": true, "schema": { "$ref": "#/definitions/JobScheduleCreateParameters" } } ], "responses": { "201": { "description": "Resource 'JobSchedule' create operation succeeded", "schema": { "$ref": "#/definitions/JobSchedule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create a job schedule": { "$ref": "./examples/createJobSchedule.json" } } }, "delete": { "operationId": "JobSchedule_Delete", "tags": [ "JobSchedule" ], "description": "Delete the job schedule identified by job schedule name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/jobscheduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "jobScheduleId", "in": "path", "description": "The job schedule name.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a job schedule": { "$ref": "./examples/deleteJobSchedule.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs": { "get": { "operationId": "Job_ListByAutomationAccount", "tags": [ "Job" ], "description": "Retrieve a list of jobs.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/joboperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation.", "required": false, "type": "string" }, { "name": "clientRequestId", "in": "header", "description": "Identifies this specific client request.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/JobListResultV2" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List jobs by automation account": { "$ref": "./examples/job/listJobsByAutomationAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}": { "get": { "operationId": "Job_Get", "tags": [ "Job" ], "description": "Retrieve the job identified by job name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/joboperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "jobName", "in": "path", "description": "The job name.", "required": true, "type": "string" }, { "name": "clientRequestId", "in": "header", "description": "Identifies this specific client request.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Job" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get job": { "$ref": "./examples/job/getJob.json" } } }, "put": { "operationId": "Job_Create", "tags": [ "Job" ], "description": "Create a job of the runbook.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/joboperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "jobName", "in": "path", "description": "The job name.", "required": true, "type": "string" }, { "name": "clientRequestId", "in": "header", "description": "Identifies this specific client request.", "required": false, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters supplied to the create job operation.", "required": true, "schema": { "$ref": "#/definitions/JobCreateParameters" } } ], "responses": { "201": { "description": "Resource 'Job' create operation succeeded", "schema": { "$ref": "#/definitions/Job" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create job": { "$ref": "./examples/job/createJob.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/output": { "get": { "operationId": "Job_GetOutput", "tags": [ "Job" ], "description": "Retrieve the job output identified by job name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/joboperations" }, "produces": [ "text/plain", "application/json" ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "jobName", "in": "path", "description": "The job name.", "required": true, "type": "string" }, { "name": "clientRequestId", "in": "header", "description": "Identifies this specific client request.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get Job Output": { "$ref": "./examples/job/getJobOutput.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/resume": { "post": { "operationId": "Job_Resume", "tags": [ "Job" ], "description": "Resume the job identified by jobName.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/joboperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "jobName", "in": "path", "description": "The job name.", "required": true, "type": "string" }, { "name": "clientRequestId", "in": "header", "description": "Identifies this specific client request.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Resume job": { "$ref": "./examples/job/resumeJob.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/runbookContent": { "get": { "operationId": "Job_GetRunbookContent", "tags": [ "Job" ], "description": "Retrieve the runbook content of the job identified by job name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/joboperations" }, "produces": [ "text/powershell", "application/json" ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "jobName", "in": "path", "description": "The job name.", "required": true, "type": "string" }, { "name": "clientRequestId", "in": "header", "description": "Identifies this specific client request.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get Job Runbook Content": { "$ref": "./examples/job/getJobRunbookContent.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/stop": { "post": { "operationId": "Job_Stop", "tags": [ "Job" ], "description": "Stop the job identified by jobName.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/joboperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "jobName", "in": "path", "description": "The job name.", "required": true, "type": "string" }, { "name": "clientRequestId", "in": "header", "description": "Identifies this specific client request.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Stop job": { "$ref": "./examples/job/stopJob.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/streams": { "get": { "operationId": "JobStream_ListByJob", "tags": [ "JobStream" ], "description": "Retrieve a list of jobs streams identified by job name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/jobstreamoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "jobName", "in": "path", "description": "The job name.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation.", "required": false, "type": "string" }, { "name": "clientRequestId", "in": "header", "description": "Identifies this specific client request.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/JobStreamListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List job streams by job name": { "$ref": "./examples/job/listJobStreamsByJob.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/streams/{jobStreamId}": { "get": { "operationId": "JobStream_Get", "tags": [ "JobStream" ], "description": "Retrieve the job stream identified by job stream id.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/jobstreamoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "jobName", "in": "path", "description": "The job name.", "required": true, "type": "string" }, { "name": "jobStreamId", "in": "path", "description": "The job stream id.", "required": true, "type": "string" }, { "name": "clientRequestId", "in": "header", "description": "Identifies this specific client request.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/JobStream" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get job stream": { "$ref": "./examples/job/getJobStream.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/suspend": { "post": { "operationId": "Job_Suspend", "tags": [ "Job" ], "description": "Suspend the job identified by job name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/joboperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "jobName", "in": "path", "description": "The job name.", "required": true, "type": "string" }, { "name": "clientRequestId", "in": "header", "description": "Identifies this specific client request.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Suspend job": { "$ref": "./examples/job/suspendJob.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/linkedWorkspace": { "get": { "operationId": "LinkedWorkspace_Get", "tags": [ "LinkedWorkspace" ], "description": "Retrieve the linked workspace for the account id.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/linkedworkspaceoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LinkedWorkspace" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get the linked workspace of an automation account": { "$ref": "./examples/getLinkedWorkspace.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/listDeletedRunbooks": { "post": { "operationId": "AutomationAccount_ListDeletedRunbooks", "tags": [ "ListDeletedRunbooks" ], "description": "Retrieve the deleted runbooks for an automation account.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeletedRunbookListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get lists of deleted runbooks in an automation account": { "$ref": "./examples/listAutomationAccountDeletedRunbooks.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/listKeys": { "post": { "operationId": "Keys_ListByAutomationAccount", "tags": [ "ListKeys" ], "description": "Retrieve the automation keys for an account.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/KeyListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get lists of an automation account": { "$ref": "./examples/listAutomationAccountKeys.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules": { "get": { "operationId": "Module_ListByAutomationAccount", "tags": [ "Module" ], "description": "Retrieve a list of modules.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/moduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ModuleListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List modules by automation account": { "$ref": "./examples/listModulesByAutomationAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}": { "get": { "operationId": "Module_Get", "tags": [ "Module" ], "description": "Retrieve the module identified by module name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/moduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "moduleName", "in": "path", "description": "The module name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Module" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a module": { "$ref": "./examples/getModule.json" } } }, "put": { "operationId": "Module_CreateOrUpdate", "tags": [ "Module" ], "description": "Create or Update the module identified by module name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/moduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "moduleName", "in": "path", "description": "The module name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The create or update parameters for module.", "required": true, "schema": { "$ref": "#/definitions/ModuleCreateOrUpdateParameters" } } ], "responses": { "200": { "description": "Resource 'Module' update operation succeeded", "schema": { "$ref": "#/definitions/Module" } }, "201": { "description": "Resource 'Module' create operation succeeded", "schema": { "$ref": "#/definitions/Module" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update a module": { "$ref": "./examples/createOrUpdateModule.json" } } }, "patch": { "operationId": "Module_Update", "tags": [ "Module" ], "description": "Update the module identified by module name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/moduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "moduleName", "in": "path", "description": "The module name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The update parameters for module.", "required": true, "schema": { "$ref": "#/definitions/ModuleUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Module" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a module": { "$ref": "./examples/updateModule.json" } } }, "delete": { "operationId": "Module_Delete", "tags": [ "Module" ], "description": "Delete the module by name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/moduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "moduleName", "in": "path", "description": "The module name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a module": { "$ref": "./examples/deleteModule.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/activities": { "get": { "operationId": "Activity_ListByModule", "tags": [ "Activity" ], "description": "Retrieve a list of activities in the module identified by module name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/activityoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "moduleName", "in": "path", "description": "The module name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ActivityListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List activities by a module": { "$ref": "./examples/listActivitiesByModule.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/activities/{activityName}": { "get": { "operationId": "Activity_Get", "tags": [ "Activity" ], "description": "Retrieve the activity in the module identified by module name and activity name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/activityoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "moduleName", "in": "path", "description": "The module name.", "required": true, "type": "string" }, { "name": "activityName", "in": "path", "description": "The name of activity.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Activity" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get Activity in a module": { "$ref": "./examples/getActivityInAModule.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/objectDataTypes/{typeName}/fields": { "get": { "operationId": "ObjectDataTypes_ListFieldsByModuleAndType", "tags": [ "ObjectDataTypes" ], "description": "Retrieve a list of fields of a given type identified by module name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/objectdatatypeoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "moduleName", "in": "path", "description": "The module name.", "required": true, "type": "string" }, { "name": "typeName", "in": "path", "description": "The name of type.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TypeFieldListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a list of fields of a given type": { "$ref": "./examples/ObjectDataTypeslistFieldsByModuleAndType.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/types/{typeName}/fields": { "get": { "operationId": "Fields_ListByType", "tags": [ "TypeFields" ], "description": "Retrieve a list of fields of a given type identified by module name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/typefieldoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "moduleName", "in": "path", "description": "The module name.", "required": true, "type": "string" }, { "name": "typeName", "in": "path", "description": "The name of type.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TypeFieldListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a list of fields of a given type": { "$ref": "./examples/listFieldsByModuleAndType.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodeConfigurations": { "get": { "operationId": "DscNodeConfiguration_ListByAutomationAccount", "tags": [ "DscNodeConfiguration" ], "description": "Retrieve a list of dsc node configurations.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/dscnodeconfigurations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation.", "required": false, "type": "string" }, { "name": "$skip", "in": "query", "description": "The number of rows to skip.", "required": false, "type": "integer", "format": "int32" }, { "name": "$top", "in": "query", "description": "The number of rows to take.", "required": false, "type": "integer", "format": "int32" }, { "name": "$inlinecount", "in": "query", "description": "Return total rows.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DscNodeConfigurationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List DSC node configurations by Automation Account": { "$ref": "./examples/listDscNodeConfigurations.json" }, "List Paged DSC node configurations by Automation Account with name filter": { "$ref": "./examples/listPagedDscNodeConfigurationsWithNameFilter.json" }, "List Paged DSC node configurations by Automation Account with no filter": { "$ref": "./examples/listPagedDscNodeConfigurationsWithNoFilter.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodeConfigurations/{nodeConfigurationName}": { "get": { "operationId": "DscNodeConfiguration_Get", "tags": [ "DscNodeConfiguration" ], "description": "Retrieve the Dsc node configurations by node configuration.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/dscnodeconfigurations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "nodeConfigurationName", "in": "path", "description": "The Dsc node configuration name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DscNodeConfiguration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a DSC node configuration": { "$ref": "./examples/getDscNodeConfiguration.json" } } }, "put": { "operationId": "DscNodeConfiguration_CreateOrUpdate", "tags": [ "DscNodeConfiguration" ], "description": "Create the node configuration identified by node configuration name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/dscnodeconfigurations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "nodeConfigurationName", "in": "path", "description": "The Dsc node configuration name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The create or update parameters for configuration.", "required": true, "schema": { "$ref": "#/definitions/DscNodeConfigurationCreateOrUpdateParameters" } } ], "responses": { "200": { "description": "The request has succeeded." }, "201": { "description": "Resource 'DscNodeConfiguration' create operation succeeded", "schema": { "$ref": "#/definitions/DscNodeConfiguration" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create node configuration": { "$ref": "./examples/createOrUpdateDscNodeConfiguration.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DscNodeConfiguration" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "DscNodeConfiguration_Delete", "tags": [ "DscNodeConfiguration" ], "description": "Delete the Dsc node configurations by node configuration.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/dscnodeconfigurations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "nodeConfigurationName", "in": "path", "description": "The Dsc node configuration name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a DSC node configuration": { "$ref": "./examples/deleteDscNodeConfiguration.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodecounts/{countType}": { "get": { "operationId": "NodeCountInformation_Get", "tags": [ "NodeCountInformation" ], "description": "Retrieve counts for Dsc Nodes.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/nodecounts" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "countType", "in": "path", "description": "The type of counts to retrieve", "required": true, "type": "string", "enum": [ "status", "nodeconfiguration" ], "x-ms-enum": { "name": "CountType", "modelAsString": true, "values": [ { "name": "status", "value": "status", "description": "status" }, { "name": "nodeconfiguration", "value": "nodeconfiguration", "description": "nodeconfiguration" } ] } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NodeCounts" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get node's node configuration counts": { "$ref": "./examples/listPagedDscNodeConfigurationCounts.json" }, "Get node's status counts": { "$ref": "./examples/listPagedDscNodeStatusCounts.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes": { "get": { "operationId": "DscNode_ListByAutomationAccount", "tags": [ "DscNode" ], "description": "Retrieve a list of dsc nodes.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/dscnodeoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation.", "required": false, "type": "string" }, { "name": "$skip", "in": "query", "description": "The number of rows to skip.", "required": false, "type": "integer", "format": "int32" }, { "name": "$top", "in": "query", "description": "The number of rows to take.", "required": false, "type": "integer", "format": "int32" }, { "name": "$inlinecount", "in": "query", "description": "Return total rows.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DscNodeListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List DSC nodes by Automation Account": { "$ref": "./examples/listAllDscNodesByAutomationAccount.json" }, "List Paged DSC nodes by Automation Account where Node Configurations are not assigned filter": { "$ref": "./examples/listPagedDscNodesByAutomationAccountWithNodeConfigurationNotAssignedFilter.json" }, "List Paged DSC nodes by Automation Account with Node Configuration Custom filter": { "$ref": "./examples/listPagedDscNodesByAutomationAccountWithNodeConfigurationCustomFilter.json" }, "List Paged DSC nodes by Automation Account with name filter": { "$ref": "./examples/listPagedDscNodesByAutomationAccountWithNameFilter.json" }, "List Paged DSC nodes by Automation Account with no filters": { "$ref": "./examples/listPagedDscNodesByAutomationAccountWithNoFilter.json" }, "List Paged DSC nodes by Automation Account with node status filter": { "$ref": "./examples/listPagedDscNodesByAutomationAccountWithStatusFilter.json" }, "List Paged DSC nodes by Automation Account with version filter": { "$ref": "./examples/listPagedDscNodesByAutomationAccountWithVersionFilter.json" }, "List Paged DSC nodes with filters separated by 'and'": { "$ref": "./examples/listPagedDscNodesByAutomationAccountWithCompositeFilter.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}": { "get": { "operationId": "DscNode_Get", "tags": [ "DscNode" ], "description": "Retrieve the dsc node identified by node id.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/dscnodeoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "nodeId", "in": "path", "description": "The node id.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DscNode" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a node": { "$ref": "./examples/getDscNode.json" } } }, "patch": { "operationId": "DscNode_Update", "tags": [ "DscNode" ], "description": "Update the dsc node.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/dscnodeoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "nodeId", "in": "path", "description": "The node id.", "required": true, "type": "string" }, { "name": "dscNodeUpdateParameters", "in": "body", "description": "Parameters supplied to the update dsc node.", "required": true, "schema": { "$ref": "#/definitions/DscNodeUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DscNode" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a node": { "$ref": "./examples/updateDscNode.json" } } }, "delete": { "operationId": "DscNode_Delete", "tags": [ "DscNode" ], "description": "Delete the dsc node identified by node id.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/dscnodeoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "nodeId", "in": "path", "description": "The node id.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a DSC Node": { "$ref": "./examples/deleteDscNode.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}/reports": { "get": { "operationId": "NodeReports_ListByNode", "tags": [ "NodeReports" ], "description": "Retrieve the Dsc node report list by node id.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/dscnodereportoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "nodeId", "in": "path", "description": "The node id.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DscNodeReportListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List DSC reports by node id.": { "$ref": "./examples/listDscNodeReportsByNode.json" }, "List Paged DSC reports by node id.": { "$ref": "./examples/listPagedDscNodeReportsByNode.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}/reports/{reportId}": { "get": { "operationId": "NodeReports_Get", "tags": [ "NodeReports" ], "description": "Retrieve the Dsc node report data by node id and report id.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/dscnodereportoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "nodeId", "in": "path", "description": "The node id.", "required": true, "type": "string" }, { "name": "reportId", "in": "path", "description": "The report id.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DscNodeReport" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get Dsc node report data by node id and report id. ": { "$ref": "./examples/getDscNodeReport.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}/reports/{reportId}/content": { "get": { "operationId": "NodeReports_GetContent", "tags": [ "NodeReports" ], "description": "Retrieve the Dsc node reports by node id and report id.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/dscnodereportoperations" }, "produces": [ "text/plain", "application/json" ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "nodeId", "in": "path", "description": "The node id.", "required": true, "type": "string" }, { "name": "reportId", "in": "path", "description": "The report id.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "type": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get content of node": { "$ref": "./examples/getDscNodeReportContent.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/objectDataTypes/{typeName}/fields": { "get": { "operationId": "ObjectDataTypes_ListFieldsByType", "tags": [ "ObjectDataTypes" ], "description": "Retrieve a list of fields of a given type across all accessible modules.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/objectdatatypeoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "typeName", "in": "path", "description": "The name of type.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TypeFieldListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a list of fields of a given type across all accessible modules": { "$ref": "./examples/listFieldsByType.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/privateEndpointConnections": { "get": { "operationId": "PrivateEndpointConnections_ListByAutomationAccount", "tags": [ "PrivateEndpointConnections" ], "description": "List all private endpoint connections on a Automation account.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets private endpoint connection.": { "$ref": "./examples/privateEndpointConnection/PrivateEndpointConnectionListGet.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/privateEndpointConnections/{privateEndpointConnectionName}": { "get": { "operationId": "PrivateEndpointConnections_Get", "tags": [ "PrivateEndpointConnections" ], "description": "Gets a private endpoint connection.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The name of the private endpoint connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets private endpoint connection.": { "$ref": "./examples/privateEndpointConnection/PrivateEndpointConnectionGet.json" } } }, "put": { "operationId": "PrivateEndpointConnections_CreateOrUpdate", "tags": [ "PrivateEndpointConnections" ], "description": "Approve or reject a private endpoint connection with a given name.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The name of the private endpoint connection.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } } ], "responses": { "200": { "description": "Resource 'PrivateEndpointConnection' update operation succeeded", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Approve or reject a private endpoint connection with a given name.": { "$ref": "./examples/privateEndpointConnection/PrivateEndpointConnectionUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/PrivateEndpointConnection" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "PrivateEndpointConnections_Delete", "tags": [ "PrivateEndpointConnections" ], "description": "Deletes a private endpoint connection with a given name.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The name of the private endpoint connection.", "required": true, "type": "string" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Deletes a private endpoint connection with a given name.": { "$ref": "./examples/privateEndpointConnection/PrivateEndpointConnectionDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/privateLinkResources": { "get": { "operationId": "PrivateLinkResources_Automation", "tags": [ "PrivateLinkResources" ], "description": "Gets the private link resources that need to be created for Automation account.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateLinkResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets private endpoint connection.": { "$ref": "./examples/PrivateLinkResourceListGet.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/python2Packages": { "get": { "operationId": "Python2Package_ListByAutomationAccount", "tags": [ "Python2Package" ], "description": "Retrieve a list of python 2 packages.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/moduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ModuleListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List python 2 packages by automation account": { "$ref": "./examples/listPython2PackagesByAutomationAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/python2Packages/{packageName}": { "get": { "operationId": "Python2Package_Get", "tags": [ "Python2Package" ], "description": "Retrieve the python 2 package identified by package name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/moduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "packageName", "in": "path", "description": "The python package name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Module" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a python 2 package": { "$ref": "./examples/getPython2Package.json" } } }, "put": { "operationId": "Python2Package_CreateOrUpdate", "tags": [ "Python2Package" ], "description": "Create or Update the python 2 package identified by package name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/moduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "packageName", "in": "path", "description": "The python package name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The create or update parameters for python package.", "required": true, "schema": { "$ref": "#/definitions/PythonPackageCreateParameters" } } ], "responses": { "200": { "description": "Resource 'Module' update operation succeeded", "schema": { "$ref": "#/definitions/Module" } }, "201": { "description": "Resource 'Module' create operation succeeded", "schema": { "$ref": "#/definitions/Module" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update a python 2 package": { "$ref": "./examples/createOrUpdatePython2Package.json" } } }, "patch": { "operationId": "Python2Package_Update", "tags": [ "Python2Package" ], "description": "Update the python 2 package identified by package name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/moduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "packageName", "in": "path", "description": "The python package name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The update parameters for python package.", "required": true, "schema": { "$ref": "#/definitions/PythonPackageUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Module" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a module": { "$ref": "./examples/updatePython2Package.json" } } }, "delete": { "operationId": "Python2Package_Delete", "tags": [ "Python2Package" ], "description": "Delete the python 2 package by name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/moduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "packageName", "in": "path", "description": "The python package name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a python 2 package": { "$ref": "./examples/deletePython2Package.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/python3Packages": { "get": { "operationId": "Python3Package_ListByAutomationAccount", "tags": [ "Python3Package" ], "description": "Retrieve a list of python 3 packages.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/moduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ModuleListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List python 3 packages by automation account": { "$ref": "./examples/listPython3PackagesByAutomationAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/python3Packages/{packageName}": { "get": { "operationId": "Python3Package_Get", "tags": [ "Python3Package" ], "description": "Retrieve the python 3 package identified by package name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/moduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "packageName", "in": "path", "description": "The python package name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Module" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a python 3 package": { "$ref": "./examples/getPython3Package.json" } } }, "put": { "operationId": "Python3Package_CreateOrUpdate", "tags": [ "Python3Package" ], "description": "Create or Update the python 3 package identified by package name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/moduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "packageName", "in": "path", "description": "The python package name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The create or update parameters for python package.", "required": true, "schema": { "$ref": "#/definitions/PythonPackageCreateParameters" } } ], "responses": { "200": { "description": "Resource 'Module' update operation succeeded", "schema": { "$ref": "#/definitions/Module" } }, "201": { "description": "Resource 'Module' create operation succeeded", "schema": { "$ref": "#/definitions/Module" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update a python 3 package": { "$ref": "./examples/createOrUpdatePython3Package.json" } } }, "patch": { "operationId": "Python3Package_Update", "tags": [ "Python3Package" ], "description": "Update the python 3 package identified by package name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/moduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "packageName", "in": "path", "description": "The python package name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The update parameters for python package.", "required": true, "schema": { "$ref": "#/definitions/PythonPackageUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Module" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a module": { "$ref": "./examples/updatePython3Package.json" } } }, "delete": { "operationId": "Python3Package_Delete", "tags": [ "Python3Package" ], "description": "Delete the python 3 package by name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/moduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "packageName", "in": "path", "description": "The python package name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a python 3 package": { "$ref": "./examples/deletePython3Package.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks": { "get": { "operationId": "Runbook_ListByAutomationAccount", "tags": [ "Runbook" ], "description": "Retrieve a list of runbooks.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/runbookoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RunbookListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List runbooks by automation account": { "$ref": "./examples/runbook/listRunbooksByAutomationAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}": { "get": { "operationId": "Runbook_Get", "tags": [ "Runbook" ], "description": "Retrieve the runbook identified by runbook name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/runbookoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runbookName", "in": "path", "description": "The runbook name.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Runbook" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get runbook": { "$ref": "./examples/runbook/getRunbook.json" } } }, "put": { "operationId": "Runbook_CreateOrUpdate", "tags": [ "Runbook" ], "description": "Create the runbook identified by runbook name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/runbookoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runbookName", "in": "path", "description": "The runbook name.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" }, { "name": "parameters", "in": "body", "description": "The create or update parameters for runbook. Provide either content link for a published runbook or draft, not both.", "required": true, "schema": { "$ref": "#/definitions/RunbookCreateOrUpdateParameters" } } ], "responses": { "200": { "description": "Resource 'Runbook' update operation succeeded", "schema": { "$ref": "#/definitions/Runbook" } }, "201": { "description": "Resource 'Runbook' create operation succeeded", "schema": { "$ref": "#/definitions/Runbook" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update runbook and publish it": { "$ref": "./examples/runbook/createOrUpdateRunbook.json" }, "Create runbook as draft": { "$ref": "./examples/runbook/createRunbookAsDraft.json" } } }, "patch": { "operationId": "Runbook_Update", "tags": [ "Runbook" ], "description": "Update the runbook identified by runbook name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/runbookoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runbookName", "in": "path", "description": "The runbook name.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" }, { "name": "parameters", "in": "body", "description": "The update parameters for runbook.", "required": true, "schema": { "$ref": "#/definitions/RunbookUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Runbook" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update runbook": { "$ref": "./examples/runbook/updateRunbook.json" } } }, "delete": { "operationId": "Runbook_Delete", "tags": [ "Runbook" ], "description": "Delete the runbook by name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/runbookoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runbookName", "in": "path", "description": "The runbook name.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a runbook": { "$ref": "./examples/runbook/deleteRunbook.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/content": { "get": { "operationId": "Runbook_GetContent", "tags": [ "Runbook" ], "description": "Retrieve the content of runbook identified by runbook name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/runbookoperations" }, "produces": [ "text/plain", "application/json" ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runbookName", "in": "path", "description": "The runbook name.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get runbook content": { "$ref": "./examples/runbook/getRunbookContent.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft": { "get": { "operationId": "RunbookDraft_Get", "tags": [ "RunbookDraft" ], "description": "Retrieve the runbook draft identified by runbook name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/runbookdraftoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runbookName", "in": "path", "description": "The runbook name.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RunbookDraft" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get runbook draft": { "$ref": "./examples/runbook/getRunbookDraft.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/content": { "get": { "operationId": "RunbookDraft_GetContent", "tags": [ "RunbookDraft" ], "description": "Retrieve the content of runbook draft identified by runbook name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/runbookdraftoperations" }, "produces": [ "text/plain", "application/json" ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runbookName", "in": "path", "description": "The runbook name.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get runbook draft content": { "$ref": "./examples/runbook/getRunbookDraftContent.json" } } }, "put": { "operationId": "RunbookDraft_ReplaceContent", "tags": [ "RunbookDraft" ], "description": "Replaces the runbook draft content.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/runbookdraftoperations" }, "consumes": [ "text/plain" ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runbookName", "in": "path", "description": "The runbook name.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" }, { "name": "runbookContent", "in": "body", "description": "The runbook draft content.", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update runbook draft": { "$ref": "./examples/runbook/replaceRunbookDraftContent.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob": { "get": { "operationId": "TestJob_Get", "tags": [ "TestJob" ], "description": "Retrieve the test job for the specified runbook.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/testjoboperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runbookName", "in": "path", "description": "The runbook name.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TestJob" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get test job": { "$ref": "./examples/runbook/getTestJob.json" } } }, "put": { "operationId": "TestJob_Create", "tags": [ "TestJob" ], "description": "Create a test job of the runbook.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/testjoboperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runbookName", "in": "path", "description": "The runbook name.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" }, { "name": "parameters", "in": "body", "description": "The parameters supplied to the create test job operation.", "required": true, "schema": { "$ref": "#/definitions/TestJobCreateParameters" } } ], "responses": { "201": { "description": "Resource 'TestJob' create operation succeeded", "schema": { "$ref": "#/definitions/TestJob" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create test job": { "$ref": "./examples/runbook/createTestJob.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/resume": { "post": { "operationId": "TestJob_Resume", "tags": [ "TestJob" ], "description": "Resume the test job.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/testjoboperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runbookName", "in": "path", "description": "The runbook name.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Resume test job": { "$ref": "./examples/runbook/resumeTestJob.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/stop": { "post": { "operationId": "TestJob_Stop", "tags": [ "TestJob" ], "description": "Stop the test job.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/testjoboperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runbookName", "in": "path", "description": "The runbook name.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Stop test job": { "$ref": "./examples/runbook/stopTestJob.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/streams": { "get": { "operationId": "TestJobStreams_ListByTestJob", "tags": [ "TestJobStream" ], "description": "Retrieve a list of test job streams identified by runbook name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/jobstreamoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runbookName", "in": "path", "description": "The runbook name.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/JobStreamListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List job streams by job name": { "$ref": "./examples/runbook/listTestJobStreamsByJob.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/streams/{jobStreamId}": { "get": { "operationId": "TestJobStreams_Get", "tags": [ "TestJobStream" ], "description": "Retrieve a test job stream of the test job identified by runbook name and stream id.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/jobstreamoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runbookName", "in": "path", "description": "The runbook name.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" }, { "name": "jobStreamId", "in": "path", "description": "The job stream id.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/JobStream" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get test job stream": { "$ref": "./examples/runbook/getTestJobStream.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/suspend": { "post": { "operationId": "TestJob_Suspend", "tags": [ "TestJob" ], "description": "Suspend the test job.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/testjoboperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runbookName", "in": "path", "description": "The runbook name.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Suspend test job": { "$ref": "./examples/runbook/suspendTestJob.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/undoEdit": { "post": { "operationId": "RunbookDraft_UndoEdit", "tags": [ "RunbookDraft" ], "description": "Undo draft edit to last known published state identified by runbook name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/runbookdraftoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runbookName", "in": "path", "description": "The runbook name.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RunbookDraftUndoEditResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Undo draft edit to last known published state": { "$ref": "./examples/runbook/undoDraftEditToLastKnownPublishedState.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/publish": { "post": { "operationId": "Runbook_Publish", "tags": [ "Runbook" ], "description": "Publish runbook draft.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/runbookdraftoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runbookName", "in": "path", "description": "The runbook name.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Publish runbook draft": { "$ref": "./examples/runbook/publishRunbook.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments": { "get": { "operationId": "RuntimeEnvironments_ListByAutomationAccount", "tags": [ "RuntimeEnvironment" ], "description": "Retrieve a list of RuntimeEnvironments.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/runbookoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RuntimeEnvironmentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List runbooks by automation account": { "$ref": "./examples/runtimeEnvironment/listRuntimeEnvironmentsByAutomationAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments/{runtimeEnvironmentName}": { "get": { "operationId": "RuntimeEnvironments_Get", "tags": [ "RuntimeEnvironment" ], "description": "Get information about the Runtime Environment", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/runtimeEnvironmentOperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runtimeEnvironmentName", "in": "path", "description": "The name of the Runtime Environment.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RuntimeEnvironment" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get automation account": { "$ref": "./examples/runtimeEnvironment/getRuntimeEnvironment.json" } } }, "put": { "operationId": "RuntimeEnvironments_Create", "tags": [ "RuntimeEnvironment" ], "description": "Create or update Runtime Environment", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/runtimeEnvironmentOperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runtimeEnvironmentName", "in": "path", "description": "The name of the Runtime Environment.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the create the runtime environment.", "required": true, "schema": { "$ref": "#/definitions/RuntimeEnvironment" } } ], "responses": { "200": { "description": "Resource 'RuntimeEnvironment' update operation succeeded", "schema": { "$ref": "#/definitions/RuntimeEnvironment" } }, "201": { "description": "Resource 'RuntimeEnvironment' create operation succeeded", "schema": { "$ref": "#/definitions/RuntimeEnvironment" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update automation account": { "$ref": "./examples/runtimeEnvironment/createRuntimeEnvironment.json" } } }, "patch": { "operationId": "RuntimeEnvironments_Update", "tags": [ "RuntimeEnvironment" ], "description": "Update an Runtime Environment.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/automationaccountoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runtimeEnvironmentName", "in": "path", "description": "The name of the Runtime Environment.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the Runtime Environment", "required": true, "schema": { "$ref": "#/definitions/RuntimeEnvironmentUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RuntimeEnvironment" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update an automation account": { "$ref": "./examples/runtimeEnvironment/updateRuntimeEnvironment.json" } } }, "delete": { "operationId": "RuntimeEnvironments_Delete", "tags": [ "RuntimeEnvironment" ], "description": "Delete the Runtime Environment.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/runtimeEnvironmentOperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runtimeEnvironmentName", "in": "path", "description": "The name of the Runtime Environment.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete Runtime Environment": { "$ref": "./examples/runtimeEnvironment/deleteRuntimeEnvironment.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments/{runtimeEnvironmentName}/packages": { "get": { "operationId": "Package_ListByRuntimeEnvironment", "tags": [ "Package" ], "description": "Retrieve the a list of Packages", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/packageoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runtimeEnvironmentName", "in": "path", "description": "The name of the Runtime Environment.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PackageListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a package": { "$ref": "./examples/package/listPackagesByRuntimeEnvironment.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments/{runtimeEnvironmentName}/packages/{packageName}": { "get": { "operationId": "Package_Get", "tags": [ "Package" ], "description": "Retrieve the Package identified by Package name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/packageoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runtimeEnvironmentName", "in": "path", "description": "The name of the Runtime Environment.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" }, { "name": "packageName", "in": "path", "description": "The Package name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Package" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a package": { "$ref": "./examples/package/getPackage.json" } } }, "put": { "operationId": "Package_CreateOrUpdate", "tags": [ "Package" ], "description": "Create or update the package identified by package name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/packageoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runtimeEnvironmentName", "in": "path", "description": "The name of the Runtime Environment.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" }, { "name": "packageName", "in": "path", "description": "The Package name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The create or update parameters for Package.", "required": true, "schema": { "$ref": "#/definitions/PackageCreateOrUpdateParameters" } } ], "responses": { "200": { "description": "Resource 'Package' update operation succeeded", "schema": { "$ref": "#/definitions/Package" } }, "201": { "description": "Resource 'Package' create operation succeeded", "schema": { "$ref": "#/definitions/Package" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update a package": { "$ref": "./examples/package/createOrUpdatePackage.json" } } }, "patch": { "operationId": "Package_Update", "tags": [ "Package" ], "description": "Update the Package identified by Package name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/packageoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runtimeEnvironmentName", "in": "path", "description": "The name of the Runtime Environment.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" }, { "name": "packageName", "in": "path", "description": "The Package name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The update parameters for Package.", "required": true, "schema": { "$ref": "#/definitions/PackageUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Package" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a package": { "$ref": "./examples/package/updatePackage.json" } } }, "delete": { "operationId": "Package_Delete", "tags": [ "Package" ], "description": "Delete the package by name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/packageoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "runtimeEnvironmentName", "in": "path", "description": "The name of the Runtime Environment.", "required": true, "type": "string", "pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$" }, { "name": "packageName", "in": "path", "description": "The Package name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a package": { "$ref": "./examples/package/deletePackage.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/schedules": { "get": { "operationId": "Schedule_ListByAutomationAccount", "tags": [ "Schedule" ], "description": "Retrieve a list of schedules.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/scheduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ScheduleListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List schedules by automation account, first 100": { "$ref": "./examples/listSchedulesByAutomationAccount_First100.json" }, "List schedules by automation account, next 100": { "$ref": "./examples/listSchedulesByAutomationAccount_Next100.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/schedules/{scheduleName}": { "get": { "operationId": "Schedule_Get", "tags": [ "Schedule" ], "description": "Retrieve the schedule identified by schedule name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/scheduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "scheduleName", "in": "path", "description": "The schedule name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Schedule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a schedule": { "$ref": "./examples/getSchedule.json" } } }, "put": { "operationId": "Schedule_CreateOrUpdate", "tags": [ "Schedule" ], "description": "Create a schedule.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/scheduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "scheduleName", "in": "path", "description": "The schedule name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters supplied to the create or update schedule operation.", "required": true, "schema": { "$ref": "#/definitions/ScheduleCreateOrUpdateParameters" } } ], "responses": { "200": { "description": "Resource 'Schedule' update operation succeeded", "schema": { "$ref": "#/definitions/Schedule" } }, "201": { "description": "Resource 'Schedule' create operation succeeded", "schema": { "$ref": "#/definitions/Schedule" } }, "409": { "description": "The request conflicts with the current state of the server." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update a schedule": { "$ref": "./examples/createOrUpdateSchedule.json" } } }, "patch": { "operationId": "Schedule_Update", "tags": [ "Schedule" ], "description": "Update the schedule identified by schedule name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/scheduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "scheduleName", "in": "path", "description": "The schedule name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters supplied to the update schedule operation.", "required": true, "schema": { "$ref": "#/definitions/ScheduleUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Schedule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a schedule": { "$ref": "./examples/updateSchedule.json" } } }, "delete": { "operationId": "Schedule_Delete", "tags": [ "Schedule" ], "description": "Delete the schedule identified by schedule name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/scheduleoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "scheduleName", "in": "path", "description": "The schedule name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete schedule": { "$ref": "./examples/deleteSchedule.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationMachineRuns": { "get": { "operationId": "SoftwareUpdateConfigurationMachineRuns_List", "tags": [ "Software Update Configuration Machine Run" ], "description": "Return list of software update configuration machine runs", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/softwareupdateconfigurationoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "clientRequestId", "in": "header", "description": "Identifies this specific client request.", "required": false, "type": "string" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation. You can use the following filters: 'properties/osType', 'properties/status', 'properties/startTime', and 'properties/softwareUpdateConfiguration/name'", "required": false, "type": "string" }, { "name": "$skip", "in": "query", "description": "number of entries you skip before returning results", "required": false, "type": "string" }, { "name": "$top", "in": "query", "description": "Maximum number of entries returned in the results collection", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/softwareUpdateConfigurationMachineRunListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List software update configuration machine runs": { "$ref": "./examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRuns.json" }, "List software update configuration machine runs for a specific software update configuration run": { "$ref": "./examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRunsByRun.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationMachineRuns/{softwareUpdateConfigurationMachineRunId}": { "get": { "operationId": "SoftwareUpdateConfigurationMachineRuns_GetById", "tags": [ "Software Update Configuration Machine Run" ], "description": "Get a single software update configuration machine run by Id.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/softwareupdateconfigurationoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "softwareUpdateConfigurationMachineRunId", "in": "path", "description": "The Id of the software update configuration machine run.", "required": true, "type": "string", "format": "uuid" }, { "name": "clientRequestId", "in": "header", "description": "Identifies this specific client request.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/softwareUpdateConfigurationMachineRun" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get software update configuration machine run": { "$ref": "./examples/softwareUpdateConfigurationMachineRun/getSoftwareUpdateConfigurationMachineRunById.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationRuns": { "get": { "operationId": "SoftwareUpdateConfigurationRuns_List", "tags": [ "Software Update Configuration Run" ], "description": "Return list of software update configuration runs", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/softwareupdateconfigurationoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "clientRequestId", "in": "header", "description": "Identifies this specific client request.", "required": false, "type": "string" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation. You can use the following filters: 'properties/osType', 'properties/status', 'properties/startTime', and 'properties/softwareUpdateConfiguration/name'", "required": false, "type": "string" }, { "name": "$skip", "in": "query", "description": "Number of entries you skip before returning results", "required": false, "type": "string" }, { "name": "$top", "in": "query", "description": "Maximum number of entries returned in the results collection", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/softwareUpdateConfigurationRunListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List software update configuration machine run with status equal to 'Failed'": { "$ref": "./examples/softwareUpdateConfigurationRun/listFailedSoftwareUpdateConfigurationRuns.json" }, "List software update configuration machine runs": { "$ref": "./examples/softwareUpdateConfigurationRun/listSoftwareUpdateConfigurationRuns.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationRuns/{softwareUpdateConfigurationRunId}": { "get": { "operationId": "SoftwareUpdateConfigurationRuns_GetById", "tags": [ "Software Update Configuration Run" ], "description": "Get a single software update configuration Run by Id.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/softwareupdateconfigurationrunoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "softwareUpdateConfigurationRunId", "in": "path", "description": "The Id of the software update configuration run.", "required": true, "type": "string", "format": "uuid" }, { "name": "clientRequestId", "in": "header", "description": "Identifies this specific client request.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/softwareUpdateConfigurationRun" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get software update configuration runs by Id": { "$ref": "./examples/softwareUpdateConfigurationRun/getSoftwareUpdateConfigurationRunById.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurations": { "get": { "operationId": "SoftwareUpdateConfigurations_List", "tags": [ "Software Update Configuration" ], "description": "Get all software update configurations for the account.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/softwareupdateconfigurationoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "clientRequestId", "in": "header", "description": "Identifies this specific client request.", "required": false, "type": "string" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/softwareUpdateConfigurationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List software update configurations": { "$ref": "./examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurations.json" }, "List software update configurations Targeting a specific azure virtual machine": { "$ref": "./examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurationsByVm.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurations/{softwareUpdateConfigurationName}": { "get": { "operationId": "SoftwareUpdateConfigurations_GetByName", "tags": [ "Software Update Configuration" ], "description": "Get a single software update configuration by name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/softwareupdateconfigurationoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "softwareUpdateConfigurationName", "in": "path", "description": "The name of the software update configuration to be created.", "required": true, "type": "string" }, { "name": "clientRequestId", "in": "header", "description": "Identifies this specific client request.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/softwareUpdateConfiguration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get software update configuration by name": { "$ref": "./examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json" } } }, "put": { "operationId": "SoftwareUpdateConfigurations_Create", "tags": [ "Software Update Configuration" ], "description": "Create a new software update configuration with the name given in the URI.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/softwareupdateconfigurationoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "softwareUpdateConfigurationName", "in": "path", "description": "The name of the software update configuration to be created.", "required": true, "type": "string" }, { "name": "clientRequestId", "in": "header", "description": "Identifies this specific client request.", "required": false, "type": "string" }, { "name": "parameters", "in": "body", "description": "Request body.", "required": true, "schema": { "$ref": "#/definitions/softwareUpdateConfiguration" } } ], "responses": { "200": { "description": "Resource 'softwareUpdateConfiguration' update operation succeeded", "schema": { "$ref": "#/definitions/softwareUpdateConfiguration" } }, "201": { "description": "Resource 'softwareUpdateConfiguration' create operation succeeded", "schema": { "$ref": "#/definitions/softwareUpdateConfiguration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create software update configuration": { "$ref": "./examples/softwareUpdateConfiguration/createSoftwareUpdateConfiguration.json" } } }, "delete": { "operationId": "SoftwareUpdateConfigurations_Delete", "tags": [ "Software Update Configuration" ], "description": "delete a specific software update configuration.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/softwareupdateconfigurationoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "softwareUpdateConfigurationName", "in": "path", "description": "The name of the software update configuration to be created.", "required": true, "type": "string" }, { "name": "clientRequestId", "in": "header", "description": "Identifies this specific client request.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete software update configuration": { "$ref": "./examples/softwareUpdateConfiguration/deleteSoftwareUpdateConfiguration.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls": { "get": { "operationId": "SourceControl_ListByAutomationAccount", "tags": [ "SourceControl" ], "description": "Retrieve a list of source controls.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/sourcecontroloperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SourceControlListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List sourceControls": { "$ref": "./examples/sourceControl/getAllSourceControls.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}": { "get": { "operationId": "SourceControl_Get", "tags": [ "SourceControl" ], "description": "Retrieve the source control identified by source control name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/sourcecontroloperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "sourceControlName", "in": "path", "description": "The name of source control.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SourceControl" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a source control": { "$ref": "./examples/sourceControl/getSourceControl.json" } } }, "put": { "operationId": "SourceControl_CreateOrUpdate", "tags": [ "SourceControl" ], "description": "Create a source control.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/sourcecontroloperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "sourceControlName", "in": "path", "description": "The name of source control.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters supplied to the create or update source control operation.", "required": true, "schema": { "$ref": "#/definitions/SourceControlCreateOrUpdateParameters" } } ], "responses": { "200": { "description": "Resource 'SourceControl' update operation succeeded", "schema": { "$ref": "#/definitions/SourceControl" } }, "201": { "description": "Resource 'SourceControl' create operation succeeded", "schema": { "$ref": "#/definitions/SourceControl" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update a source control": { "$ref": "./examples/sourceControl/createOrUpdateSourceControl.json" } } }, "patch": { "operationId": "SourceControl_Update", "tags": [ "SourceControl" ], "description": "Update a source control.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/sourcecontroloperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "sourceControlName", "in": "path", "description": "The name of source control.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters supplied to the update source control operation.", "required": true, "schema": { "$ref": "#/definitions/SourceControlUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SourceControl" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a source control": { "$ref": "./examples/sourceControl/updateSourceControl_patch.json" } } }, "delete": { "operationId": "SourceControl_Delete", "tags": [ "SourceControl" ], "description": "Delete the source control.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/sourcecontroloperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "sourceControlName", "in": "path", "description": "The name of source control.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a source control": { "$ref": "./examples/sourceControl/deleteSourceControl.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}/sourceControlSyncJobs": { "get": { "operationId": "SourceControlSyncJob_ListByAutomationAccount", "tags": [ "SourceControlSyncJob" ], "description": "Retrieve a list of source control sync jobs.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/sourcecontrolsyncjoboperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "sourceControlName", "in": "path", "description": "The name of source control.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SourceControlSyncJobListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a list of source control sync jobs": { "$ref": "./examples/sourceControlSyncJob/getAllSourceControlSyncJobs.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}/sourceControlSyncJobs/{sourceControlSyncJobId}": { "get": { "operationId": "SourceControlSyncJob_Get", "tags": [ "SourceControlSyncJob" ], "description": "Retrieve the source control sync job identified by job id.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/sourcecontrolsyncjoboperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "sourceControlName", "in": "path", "description": "The name of source control.", "required": true, "type": "string" }, { "name": "sourceControlSyncJobId", "in": "path", "description": "The source control sync job id.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SourceControlSyncJobById" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a source control sync job by job id": { "$ref": "./examples/sourceControlSyncJob/getSourceControlSyncJob.json" } } }, "put": { "operationId": "SourceControlSyncJob_Create", "tags": [ "SourceControlSyncJob" ], "description": "Creates the sync job for a source control.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/sourcecontrolsyncjoboperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "sourceControlName", "in": "path", "description": "The name of source control.", "required": true, "type": "string" }, { "name": "sourceControlSyncJobId", "in": "path", "description": "The source control sync job id.", "required": true, "type": "string", "format": "uuid" }, { "name": "parameters", "in": "body", "description": "The parameters supplied to the create source control sync job operation.", "required": true, "schema": { "$ref": "#/definitions/SourceControlSyncJobCreateParameters" } } ], "responses": { "201": { "description": "Resource 'SourceControlSyncJob' create operation succeeded", "schema": { "$ref": "#/definitions/SourceControlSyncJob" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update a source control sync job": { "$ref": "./examples/sourceControlSyncJob/createSourceControlSyncJob.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}/sourceControlSyncJobs/{sourceControlSyncJobId}/streams": { "get": { "operationId": "SourceControlSyncJobStreams_ListBySyncJob", "tags": [ "SourceControlSyncJobStreams" ], "description": "Retrieve a list of sync job streams identified by sync job id.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/sourcecontrolsyncjoboperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "sourceControlName", "in": "path", "description": "The name of source control.", "required": true, "type": "string" }, { "name": "sourceControlSyncJobId", "in": "path", "description": "The source control sync job id.", "required": true, "type": "string", "format": "uuid" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SourceControlSyncJobStreamsListBySyncJob" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a list of sync job streams identified by sync job id": { "$ref": "./examples/sourceControlSyncJobStreams/getSourceControlSyncJobStreams.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}/sourceControlSyncJobs/{sourceControlSyncJobId}/streams/{streamId}": { "get": { "operationId": "SourceControlSyncJobStreams_Get", "tags": [ "SourceControlSyncJobStreams" ], "description": "Retrieve a sync job stream identified by stream id.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/sourcecontrolsyncjoboperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "sourceControlName", "in": "path", "description": "The name of source control.", "required": true, "type": "string" }, { "name": "sourceControlSyncJobId", "in": "path", "description": "The source control sync job id.", "required": true, "type": "string", "format": "uuid" }, { "name": "streamId", "in": "path", "description": "The id of the sync job stream.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SourceControlSyncJobStreamById" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a sync job stream identified by sync job stream id.": { "$ref": "./examples/sourceControlSyncJobStreams/getSourceControlSyncJobStreamsByStreamId.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/statistics": { "get": { "operationId": "Statistics_ListByAutomationAccount", "tags": [ "Statistics" ], "description": "Retrieve the statistics for the account.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/statisticsoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/StatisticsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get statistics of an automation account": { "$ref": "./examples/getStatisticsOfAutomationAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/usages": { "get": { "operationId": "Usages_ListByAutomationAccount", "tags": [ "Usages" ], "description": "Retrieve the usage for the account id.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/usageoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/UsageListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get usages of an automation account": { "$ref": "./examples/getUsagesOfAutomationAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/variables": { "get": { "operationId": "Variable_ListByAutomationAccount", "tags": [ "Variable" ], "description": "Retrieve a list of variables.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/variableoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VariableListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List variables, First 100": { "$ref": "./examples/listVariables_First100.json" }, "List variables, Next 100": { "$ref": "./examples/listVariables_Next100.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/variables/{variableName}": { "get": { "operationId": "Variable_Get", "tags": [ "Variable" ], "description": "Retrieve the variable identified by variable name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/variableoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "variableName", "in": "path", "description": "The name of variable.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Variable" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a variable": { "$ref": "./examples/getVariable.json" } } }, "put": { "operationId": "Variable_CreateOrUpdate", "tags": [ "Variable" ], "description": "Create a variable.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/variableoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "variableName", "in": "path", "description": "The name of variable.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters supplied to the create or update variable operation.", "required": true, "schema": { "$ref": "#/definitions/VariableCreateOrUpdateParameters" } } ], "responses": { "200": { "description": "Resource 'Variable' update operation succeeded", "schema": { "$ref": "#/definitions/Variable" } }, "201": { "description": "Resource 'Variable' create operation succeeded", "schema": { "$ref": "#/definitions/Variable" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update a variable": { "$ref": "./examples/createOrUpdateVariable.json" } } }, "patch": { "operationId": "Variable_Update", "tags": [ "Variable" ], "description": "Update a variable.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/variableoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "variableName", "in": "path", "description": "The name of variable.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The parameters supplied to the update variable operation.", "required": true, "schema": { "$ref": "#/definitions/VariableUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Variable" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a variable": { "$ref": "./examples/updateVariable_patch.json" } } }, "delete": { "operationId": "Variable_Delete", "tags": [ "Variable" ], "description": "Delete the variable.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/variableoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "variableName", "in": "path", "description": "The name of variable.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a variable": { "$ref": "./examples/deleteVariable.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers": { "get": { "operationId": "Watcher_ListByAutomationAccount", "tags": [ "Watcher" ], "description": "Retrieve a list of watchers.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/watcheroperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WatcherListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List watchers by Automation Account": { "$ref": "./examples/listWatchersByAutomationAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName}": { "get": { "operationId": "Watcher_Get", "tags": [ "Watcher" ], "description": "Retrieve the watcher identified by watcher name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/watcheroperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "watcherName", "in": "path", "description": "The watcher name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Watcher" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get watcher": { "$ref": "./examples/getWatcher.json" } } }, "put": { "operationId": "Watcher_CreateOrUpdate", "tags": [ "Watcher" ], "description": "Create the watcher identified by watcher name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/watcheroperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "watcherName", "in": "path", "description": "The watcher name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The create or update parameters for watcher.", "required": true, "schema": { "$ref": "#/definitions/Watcher" } } ], "responses": { "200": { "description": "Resource 'Watcher' update operation succeeded", "schema": { "$ref": "#/definitions/Watcher" } }, "201": { "description": "Resource 'Watcher' create operation succeeded", "schema": { "$ref": "#/definitions/Watcher" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update watcher": { "$ref": "./examples/createOrUpdateWatcher.json" } } }, "patch": { "operationId": "Watcher_Update", "tags": [ "Watcher" ], "description": "Update the watcher identified by watcher name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/watcheroperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "watcherName", "in": "path", "description": "The watcher name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The update parameters for watcher.", "required": true, "schema": { "$ref": "#/definitions/WatcherUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Watcher" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update watcher": { "$ref": "./examples/updateWatcher.json" } } }, "delete": { "operationId": "Watcher_Delete", "tags": [ "Watcher" ], "description": "Delete the watcher by name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/watcheroperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "watcherName", "in": "path", "description": "The watcher name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete watcher": { "$ref": "./examples/deleteWatcher.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName}/start": { "post": { "operationId": "Watcher_Start", "tags": [ "Watcher" ], "description": "Resume the watcher identified by watcher name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/watcheroperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "watcherName", "in": "path", "description": "The watcher name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Start Watcher": { "$ref": "./examples/startWatcher.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName}/stop": { "post": { "operationId": "Watcher_Stop", "tags": [ "Watcher" ], "description": "Resume the watcher identified by watcher name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/watcheroperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "watcherName", "in": "path", "description": "The watcher name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Start Watcher": { "$ref": "./examples/stopWatcher.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks": { "get": { "operationId": "Webhook_ListByAutomationAccount", "tags": [ "Webhook" ], "description": "Retrieve a list of webhooks.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/webhookoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WebhookListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List webhooks by Automation Account": { "$ref": "./examples/listWebhooksByAutomationAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/{webhookName}": { "get": { "operationId": "Webhook_Get", "tags": [ "Webhook" ], "description": "Retrieve the webhook identified by webhook name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/webhookoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "webhookName", "in": "path", "description": "The webhook name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Webhook" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get webhook": { "$ref": "./examples/getWebhook.json" } } }, "put": { "operationId": "Webhook_CreateOrUpdate", "tags": [ "Webhook" ], "description": "Create the webhook identified by webhook name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/webhookoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "webhookName", "in": "path", "description": "The webhook name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The create or update parameters for webhook.", "required": true, "schema": { "$ref": "#/definitions/WebhookCreateOrUpdateParameters" } } ], "responses": { "200": { "description": "Resource 'Webhook' update operation succeeded", "schema": { "$ref": "#/definitions/Webhook" } }, "201": { "description": "Resource 'Webhook' create operation succeeded", "schema": { "$ref": "#/definitions/Webhook" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update webhook": { "$ref": "./examples/createOrUpdateWebhook.json" } } }, "patch": { "operationId": "Webhook_Update", "tags": [ "Webhook" ], "description": "Update the webhook identified by webhook name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/webhookoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "webhookName", "in": "path", "description": "The webhook name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The update parameters for webhook.", "required": true, "schema": { "$ref": "#/definitions/WebhookUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Webhook" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update webhook": { "$ref": "./examples/updateWebhook.json" } } }, "delete": { "operationId": "Webhook_Delete", "tags": [ "Webhook" ], "description": "Delete the webhook by name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/webhookoperations" }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" }, { "name": "webhookName", "in": "path", "description": "The webhook name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete webhook": { "$ref": "./examples/deleteWebhook.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/generateUri": { "post": { "operationId": "Webhook_GenerateUri", "tags": [ "Webhook" ], "description": "Generates a Uri for use in creating a webhook.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/webhookoperations" }, "produces": [ "text/plain", "application/json" ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "automationAccountName", "in": "path", "description": "The name of the automation account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Generate webhook uri": { "$ref": "./examples/webhookGenerateUri.json" } } } } }, "definitions": { "Activity": { "type": "object", "description": "Definition of the activity.", "properties": { "id": { "type": "string", "description": "Gets or sets the id of the resource." }, "name": { "type": "string", "description": "Gets the name of the activity.", "readOnly": true }, "properties": { "$ref": "#/definitions/ActivityProperties", "description": "Gets or sets the properties of the activity.", "x-ms-client-flatten": true } } }, "ActivityListResult": { "type": "object", "description": "The response model for the list activity operation.", "properties": { "value": { "type": "array", "description": "The Activity items on this page", "items": { "$ref": "#/definitions/Activity" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ActivityOutputType": { "type": "object", "description": "Definition of the activity output type.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the activity output type." }, "type": { "type": "string", "description": "Gets or sets the type of the activity output type." } } }, "ActivityParameter": { "type": "object", "description": "Definition of the activity parameter.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the activity parameter." }, "type": { "type": "string", "description": "Gets or sets the type of the activity parameter." }, "isMandatory": { "type": "boolean", "description": "Gets or sets a Boolean value that indicates true if the parameter is required. If the value is false, the parameter is optional." }, "isDynamic": { "type": "boolean", "description": "Gets or sets a Boolean value that indicates true if the parameter is dynamic." }, "position": { "type": "integer", "format": "int64", "description": "Gets or sets the position of the activity parameter." }, "valueFromPipeline": { "type": "boolean", "description": "Gets or sets a Boolean value that indicates true if the parameter can take values from the incoming pipeline objects. This setting is used if the cmdlet must access the complete input object. false indicates that the parameter cannot take values from the complete input object." }, "valueFromPipelineByPropertyName": { "type": "boolean", "description": "Gets or sets a Boolean value that indicates true if the parameter can be filled from a property of the incoming pipeline object that has the same name as this parameter. false indicates that the parameter cannot be filled from the incoming pipeline object property with the same name." }, "valueFromRemainingArguments": { "type": "boolean", "description": "Gets or sets a Boolean value that indicates true if the cmdlet parameter accepts all the remaining command-line arguments that are associated with this parameter in the form of an array. false if the cmdlet parameter does not accept all the remaining argument values." }, "description": { "type": "string", "description": "Gets or sets the description of the activity parameter." }, "validationSet": { "type": "array", "description": "Gets or sets the validation set of activity parameter.", "items": { "$ref": "#/definitions/ActivityParameterValidationSet" }, "x-ms-identifiers": [] } } }, "ActivityParameterSet": { "type": "object", "description": "Definition of the activity parameter set.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the activity parameter set." }, "parameters": { "type": "array", "description": "Gets or sets the parameters of the activity parameter set.", "items": { "$ref": "#/definitions/ActivityParameter" }, "x-ms-identifiers": [] } } }, "ActivityParameterValidationSet": { "type": "object", "description": "Definition of the activity parameter validation set.", "properties": { "memberValue": { "type": "string", "description": "Gets or sets the name of the activity parameter validation set member." } } }, "ActivityProperties": { "type": "object", "description": "Properties of the activity.", "properties": { "definition": { "type": "string", "description": "Gets or sets the user name of the activity." }, "parameterSets": { "type": "array", "description": "Gets or sets the parameter sets of the activity.", "items": { "$ref": "#/definitions/ActivityParameterSet" }, "x-ms-identifiers": [ "name" ] }, "outputTypes": { "type": "array", "description": "Gets or sets the output types of the activity.", "items": { "$ref": "#/definitions/ActivityOutputType" }, "x-ms-identifiers": [ "name" ] }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the creation time." }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time." }, "description": { "type": "string", "description": "Gets or sets the description." } } }, "AdvancedSchedule": { "type": "object", "description": "The properties of the create Advanced Schedule.", "properties": { "weekDays": { "type": "array", "description": "Days of the week that the job should execute on.", "items": { "type": "string" } }, "monthDays": { "type": "array", "description": "Days of the month that the job should execute on. Must be between 1 and 31.", "items": { "type": "integer", "format": "int32" } }, "monthlyOccurrences": { "type": "array", "description": "Occurrences of days within a month.", "items": { "$ref": "#/definitions/AdvancedScheduleMonthlyOccurrence" }, "x-ms-identifiers": [] } } }, "AdvancedScheduleMonthlyOccurrence": { "type": "object", "description": "The properties of the create advanced schedule monthly occurrence.", "properties": { "occurrence": { "type": "integer", "format": "int32", "description": "Occurrence of the week within the month. Must be between 1 and 5" }, "day": { "$ref": "#/definitions/ScheduleDay", "description": "Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday." } } }, "AgentRegistration": { "type": "object", "description": "Definition of the agent registration information type.", "properties": { "dscMetaConfiguration": { "type": "string", "description": "Gets or sets the dsc meta configuration." }, "endpoint": { "type": "string", "description": "Gets or sets the dsc server endpoint." }, "keys": { "$ref": "#/definitions/AgentRegistrationKeys", "description": "Gets or sets the agent registration keys." }, "id": { "type": "string", "description": "Gets or sets the id." } } }, "AgentRegistrationKeyName": { "type": "string", "description": "Gets or sets the agent registration key name - primary or secondary.", "enum": [ "primary", "secondary" ], "x-ms-enum": { "name": "AgentRegistrationKeyName", "modelAsString": true, "values": [ { "name": "primary", "value": "primary", "description": "primary" }, { "name": "secondary", "value": "secondary", "description": "secondary" } ] } }, "AgentRegistrationKeys": { "type": "object", "description": "Definition of the agent registration keys.", "properties": { "primary": { "type": "string", "description": "Gets or sets the primary key." }, "secondary": { "type": "string", "description": "Gets or sets the secondary key." } } }, "AgentRegistrationRegenerateKeyParameter": { "type": "object", "description": "The parameters supplied to the regenerate keys operation.", "properties": { "keyName": { "$ref": "#/definitions/AgentRegistrationKeyName", "description": "Gets or sets the agent registration key name - primary or secondary." } }, "required": [ "keyName" ] }, "AutomationAccount": { "type": "object", "description": "Definition of the automation account type.", "properties": { "properties": { "$ref": "#/definitions/AutomationAccountProperties", "description": "Gets or sets the automation account properties.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "Gets or sets the etag of the resource." }, "identity": { "$ref": "#/definitions/Identity", "description": "Identity for the resource." } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "AutomationAccountCreateOrUpdateParameters": { "type": "object", "description": "The parameters supplied to the create or update automation account operation.", "properties": { "properties": { "$ref": "#/definitions/AutomationAccountCreateOrUpdateProperties", "description": "Gets or sets account create or update properties.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Gets or sets name of the resource." }, "location": { "type": "string", "description": "Gets or sets the location of the resource." }, "identity": { "$ref": "#/definitions/Identity", "description": "Sets the identity property for automation account" }, "tags": { "type": "object", "description": "Gets or sets the tags attached to the resource.", "additionalProperties": { "type": "string" } } } }, "AutomationAccountCreateOrUpdateProperties": { "type": "object", "description": "The parameters supplied to the create or update account properties.", "properties": { "sku": { "$ref": "#/definitions/Sku", "description": "Gets or sets account SKU." }, "encryption": { "$ref": "#/definitions/EncryptionProperties", "description": "Set the encryption properties for the automation account" }, "publicNetworkAccess": { "type": "boolean", "description": "Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet" }, "disableLocalAuth": { "type": "boolean", "description": "Indicates whether requests using non-AAD authentication are blocked" } } }, "AutomationAccountListResult": { "type": "object", "description": "The response of a AutomationAccount list operation.", "properties": { "value": { "type": "array", "description": "The AutomationAccount items on this page", "items": { "$ref": "#/definitions/AutomationAccount" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "AutomationAccountProperties": { "type": "object", "description": "Definition of the account property.", "properties": { "sku": { "$ref": "#/definitions/Sku", "description": "Gets or sets the SKU of account." }, "lastModifiedBy": { "type": "string", "description": "Gets or sets the last modified by." }, "state": { "$ref": "#/definitions/AutomationAccountState", "description": "Gets status of account.", "readOnly": true }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets the creation time.", "readOnly": true }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets the last modified time.", "readOnly": true }, "description": { "type": "string", "description": "Gets or sets the description." }, "encryption": { "$ref": "#/definitions/EncryptionProperties", "description": "Encryption properties for the automation account" }, "privateEndpointConnections": { "type": "array", "description": "List of Automation operations supported by the Automation resource provider.", "items": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "publicNetworkAccess": { "type": "boolean", "description": "Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet" }, "disableLocalAuth": { "type": "boolean", "description": "Indicates whether requests using non-AAD authentication are blocked" }, "automationHybridServiceUrl": { "type": "string", "description": "URL of automation hybrid service which is used for hybrid worker on-boarding." } } }, "AutomationAccountState": { "type": "string", "description": "Gets status of account.", "enum": [ "Ok", "Unavailable", "Suspended" ], "x-ms-enum": { "name": "AutomationAccountState", "modelAsString": true, "values": [ { "name": "Ok", "value": "Ok", "description": "Ok" }, { "name": "Unavailable", "value": "Unavailable", "description": "Unavailable" }, { "name": "Suspended", "value": "Suspended", "description": "Suspended" } ] } }, "AutomationAccountUpdateParameters": { "type": "object", "description": "The parameters supplied to the update automation account operation.", "properties": { "properties": { "$ref": "#/definitions/AutomationAccountUpdateProperties", "description": "Gets or sets account update properties.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Gets or sets the name of the resource." }, "location": { "type": "string", "description": "Gets or sets the location of the resource." }, "identity": { "$ref": "#/definitions/Identity", "description": "Sets the identity property for automation account" }, "tags": { "type": "object", "description": "Gets or sets the tags attached to the resource.", "additionalProperties": { "type": "string" } } } }, "AutomationAccountUpdateProperties": { "type": "object", "description": "The parameters supplied to the update account properties.", "properties": { "sku": { "$ref": "#/definitions/Sku", "description": "Gets or sets account SKU." }, "encryption": { "$ref": "#/definitions/EncryptionProperties", "description": "Set the encryption properties for the automation account" }, "publicNetworkAccess": { "type": "boolean", "description": "Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet" }, "disableLocalAuth": { "type": "boolean", "description": "Indicates whether requests using non-AAD authentication are blocked" } } }, "AutomationErrorResponse": { "type": "object", "description": "Error response of an operation failure", "properties": { "code": { "type": "string", "description": "Error code" }, "message": { "type": "string", "description": "Error message indicating why the operation failed." } } }, "AutomationKeyName": { "type": "string", "description": "Automation key name.", "enum": [ "Primary", "Secondary" ], "x-ms-enum": { "name": "AutomationKeyName", "modelAsString": true, "values": [ { "name": "Primary", "value": "Primary", "description": "Primary" }, { "name": "Secondary", "value": "Secondary", "description": "Secondary" } ] } }, "AutomationKeyPermissions": { "type": "string", "description": "Automation key permissions.", "enum": [ "Read", "Full" ], "x-ms-enum": { "name": "AutomationKeyPermissions", "modelAsString": true, "values": [ { "name": "Read", "value": "Read", "description": "Read" }, { "name": "Full", "value": "Full", "description": "Full" } ] } }, "AzureQueryProperties": { "type": "object", "description": "Azure query for the update configuration.", "properties": { "scope": { "type": "array", "description": "List of Subscription or Resource Group ARM Ids.", "items": { "type": "string" } }, "locations": { "type": "array", "description": "List of locations to scope the query to.", "items": { "type": "string" } }, "tagSettings": { "$ref": "#/definitions/TagSettingsProperties", "description": "Tag settings for the VM." } } }, "Certificate": { "type": "object", "description": "Definition of the certificate.", "properties": { "properties": { "$ref": "#/definitions/CertificateProperties", "description": "Gets or sets the properties of the certificate.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "CertificateCreateOrUpdateParameters": { "type": "object", "description": "The parameters supplied to the create or update or replace certificate operation.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the certificate." }, "properties": { "$ref": "#/definitions/CertificateCreateOrUpdateProperties", "description": "Gets or sets the properties of the certificate.", "x-ms-client-flatten": true } }, "required": [ "name", "properties" ] }, "CertificateCreateOrUpdateProperties": { "type": "object", "description": "The properties of the create certificate operation.", "properties": { "base64Value": { "type": "string", "description": "Gets or sets the base64 encoded value of the certificate." }, "description": { "type": "string", "description": "Gets or sets the description of the certificate." }, "thumbprint": { "type": "string", "description": "Gets or sets the thumbprint of the certificate." }, "isExportable": { "type": "boolean", "description": "Gets or sets the is exportable flag of the certificate." } }, "required": [ "base64Value" ] }, "CertificateListResult": { "type": "object", "description": "The response of a Certificate list operation.", "properties": { "value": { "type": "array", "description": "The Certificate items on this page", "items": { "$ref": "#/definitions/Certificate" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "CertificateProperties": { "type": "object", "description": "Properties of the certificate.", "properties": { "thumbprint": { "type": "string", "description": "Gets the thumbprint of the certificate.", "readOnly": true }, "expiryTime": { "type": "string", "format": "date-time", "description": "Gets the expiry time of the certificate.", "readOnly": true }, "isExportable": { "type": "boolean", "description": "Gets the is exportable flag of the certificate.", "readOnly": true }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets the creation time.", "readOnly": true }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets the last modified time.", "readOnly": true }, "description": { "type": "string", "description": "Gets or sets the description." } } }, "CertificateUpdateParameters": { "type": "object", "description": "The parameters supplied to the update certificate operation.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the certificate." }, "properties": { "$ref": "#/definitions/CertificateUpdateProperties", "description": "Gets or sets the properties of the certificate.", "x-ms-client-flatten": true } } }, "CertificateUpdateProperties": { "type": "object", "description": "The properties of the update certificate operation", "properties": { "description": { "type": "string", "description": "Gets or sets the description of the certificate." } } }, "Connection": { "type": "object", "description": "Definition of the connection.", "properties": { "properties": { "$ref": "#/definitions/ConnectionProperties", "description": "Gets or sets the properties of the connection.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ConnectionCreateOrUpdateParameters": { "type": "object", "description": "The parameters supplied to the create or update connection operation.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the connection." }, "properties": { "$ref": "#/definitions/ConnectionCreateOrUpdateProperties", "description": "Gets or sets the properties of the connection.", "x-ms-client-flatten": true } }, "required": [ "name", "properties" ] }, "ConnectionCreateOrUpdateProperties": { "type": "object", "description": "The properties of the create connection properties", "properties": { "description": { "type": "string", "description": "Gets or sets the description of the connection." }, "connectionType": { "$ref": "#/definitions/ConnectionTypeAssociationProperty", "description": "Gets or sets the connectionType of the connection." }, "fieldDefinitionValues": { "type": "object", "description": "Gets or sets the field definition properties of the connection.", "additionalProperties": { "type": "string" } } }, "required": [ "connectionType" ] }, "ConnectionListResult": { "type": "object", "description": "The response of a Connection list operation.", "properties": { "value": { "type": "array", "description": "The Connection items on this page", "items": { "$ref": "#/definitions/Connection" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ConnectionProperties": { "type": "object", "description": "Definition of the connection properties.", "properties": { "connectionType": { "$ref": "#/definitions/ConnectionTypeAssociationProperty", "description": "Gets or sets the connectionType of the connection." }, "fieldDefinitionValues": { "type": "object", "description": "Gets the field definition values of the connection.", "additionalProperties": { "type": "string" }, "readOnly": true }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets the creation time.", "readOnly": true }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets the last modified time.", "readOnly": true }, "description": { "type": "string", "description": "Gets or sets the description." } } }, "ConnectionType": { "type": "object", "description": "Definition of the connection type.", "properties": { "properties": { "$ref": "#/definitions/ConnectionTypeProperties", "description": "Gets or sets the properties of the connection type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ConnectionTypeAssociationProperty": { "type": "object", "description": "The connection type property associated with the entity.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the connection type." } } }, "ConnectionTypeCreateOrUpdateParameters": { "type": "object", "description": "The parameters supplied to the create or update connection type operation.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the connection type." }, "properties": { "$ref": "#/definitions/ConnectionTypeCreateOrUpdateProperties", "description": "Gets or sets the value of the connection type.", "x-ms-client-flatten": true } }, "required": [ "name", "properties" ] }, "ConnectionTypeCreateOrUpdateProperties": { "type": "object", "description": "The properties of the create connection type.", "properties": { "isGlobal": { "type": "boolean", "description": "Gets or sets a Boolean value to indicate if the connection type is global." }, "fieldDefinitions": { "type": "object", "description": "Gets or sets the field definitions of the connection type.", "additionalProperties": { "$ref": "#/definitions/FieldDefinition" } } }, "required": [ "fieldDefinitions" ] }, "ConnectionTypeListResult": { "type": "object", "description": "The response of a ConnectionType list operation.", "properties": { "value": { "type": "array", "description": "The ConnectionType items on this page", "items": { "$ref": "#/definitions/ConnectionType" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ConnectionTypeProperties": { "type": "object", "description": "Properties of the connection type.", "properties": { "isGlobal": { "type": "boolean", "description": "Gets or sets a Boolean value to indicate if the connection type is global." }, "fieldDefinitions": { "type": "object", "description": "Gets the field definitions of the connection type.", "additionalProperties": { "$ref": "#/definitions/FieldDefinition" }, "readOnly": true }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets the creation time.", "readOnly": true }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time." }, "description": { "type": "string", "description": "Gets or sets the description." } } }, "ConnectionUpdateParameters": { "type": "object", "description": "The parameters supplied to the update connection operation.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the connection." }, "properties": { "$ref": "#/definitions/ConnectionUpdateProperties", "description": "Gets or sets the properties of the connection.", "x-ms-client-flatten": true } } }, "ConnectionUpdateProperties": { "type": "object", "description": "The properties of the update connection operation.", "properties": { "description": { "type": "string", "description": "Gets or sets the description of the connection." }, "fieldDefinitionValues": { "type": "object", "description": "Gets or sets the field definition values of the connection.", "additionalProperties": { "type": "string" } } } }, "ContentHash": { "type": "object", "description": "Definition of the runbook property type.", "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" ] }, "ContentLink": { "type": "object", "description": "Definition of the content link.", "properties": { "uri": { "type": "string", "description": "Gets or sets the uri of content." }, "contentHash": { "$ref": "#/definitions/ContentHash", "description": "Gets or sets the hash." }, "version": { "type": "string", "description": "Gets or sets the version of the content." } } }, "ContentSource": { "type": "object", "description": "Definition of the content source.", "properties": { "hash": { "$ref": "#/definitions/ContentHash", "description": "Gets or sets the hash." }, "type": { "$ref": "#/definitions/ContentSourceType", "description": "Gets or sets the content source type." }, "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." } } }, "ContentSourceType": { "type": "string", "description": "Gets or sets the content source type.", "enum": [ "embeddedContent", "uri" ], "x-ms-enum": { "name": "ContentSourceType", "modelAsString": true, "values": [ { "name": "embeddedContent", "value": "embeddedContent", "description": "embeddedContent" }, { "name": "uri", "value": "uri", "description": "uri" } ] } }, "CountType": { "type": "string", "enum": [ "status", "nodeconfiguration" ], "x-ms-enum": { "name": "CountType", "modelAsString": true, "values": [ { "name": "status", "value": "status", "description": "status" }, { "name": "nodeconfiguration", "value": "nodeconfiguration", "description": "nodeconfiguration" } ] } }, "CreatedByType": { "type": "string", "description": "The type of identity that created the resource.", "enum": [ "User", "Application", "ManagedIdentity", "Key" ], "x-ms-enum": { "name": "CreatedByType", "modelAsString": true, "values": [ { "name": "User", "value": "User", "description": "User" }, { "name": "Application", "value": "Application", "description": "Application" }, { "name": "ManagedIdentity", "value": "ManagedIdentity", "description": "ManagedIdentity" }, { "name": "Key", "value": "Key", "description": "Key" } ] } }, "Credential": { "type": "object", "description": "Definition of the credential.", "properties": { "properties": { "$ref": "#/definitions/CredentialProperties", "description": "Gets or sets the properties of the credential.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "CredentialCreateOrUpdateParameters": { "type": "object", "description": "The parameters supplied to the create or update credential operation.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the credential." }, "properties": { "$ref": "#/definitions/CredentialCreateOrUpdateProperties", "description": "Gets or sets the properties of the credential.", "x-ms-client-flatten": true } }, "required": [ "name", "properties" ] }, "CredentialCreateOrUpdateProperties": { "type": "object", "description": "The properties of the create credential operation.", "properties": { "userName": { "type": "string", "description": "Gets or sets the user name of the credential." }, "password": { "type": "string", "description": "Gets or sets the password of the credential." }, "description": { "type": "string", "description": "Gets or sets the description of the credential." } }, "required": [ "userName", "password" ] }, "CredentialListResult": { "type": "object", "description": "The response of a Credential list operation.", "properties": { "value": { "type": "array", "description": "The Credential items on this page", "items": { "$ref": "#/definitions/Credential" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "CredentialProperties": { "type": "object", "description": "Definition of the credential properties", "properties": { "userName": { "type": "string", "description": "Gets the user name of the credential.", "readOnly": true }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets the creation time.", "readOnly": true }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets the last modified time.", "readOnly": true }, "description": { "type": "string", "description": "Gets or sets the description." } } }, "CredentialUpdateParameters": { "type": "object", "description": "The parameters supplied to the Update credential operation.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the credential." }, "properties": { "$ref": "#/definitions/CredentialUpdateProperties", "description": "Gets or sets the properties of the variable.", "x-ms-client-flatten": true } } }, "CredentialUpdateProperties": { "type": "object", "description": "The properties of the Update credential", "properties": { "userName": { "type": "string", "description": "Gets or sets the user name of the credential." }, "password": { "type": "string", "description": "Gets or sets the password of the credential." }, "description": { "type": "string", "description": "Gets or sets the description of the credential." } } }, "DeletedAutomationAccount": { "type": "object", "description": "Definition of the deleted automation account type.", "properties": { "properties": { "$ref": "#/definitions/DeletedAutomationAccountProperties", "description": "Gets or sets the automation account properties.", "x-ms-client-flatten": true }, "id": { "type": "string", "description": "The resource id." }, "name": { "type": "string", "description": "Gets or sets name of the resource." }, "type": { "type": "string", "description": "The resource type." }, "location": { "type": "string", "description": "Gets or sets the location of the resource." } } }, "DeletedAutomationAccountListResult": { "type": "object", "description": "The response model for the list deleted automation account.", "properties": { "value": { "type": "array", "description": "Gets or sets the list of deleted automation accounts.", "items": { "$ref": "#/definitions/DeletedAutomationAccount" } } } }, "DeletedAutomationAccountProperties": { "type": "object", "description": "Definition of the deleted automation account properties.", "properties": { "automationAccountResourceId": { "type": "string", "description": "Gets or sets the Automation Account Resource Id." }, "automationAccountId": { "type": "string", "description": "Gets or sets the Automation Account Id." }, "location": { "type": "string", "description": "Gets or sets the location of the resource." }, "deletionTime": { "type": "string", "format": "date-time", "description": "Gets the deletion time.", "readOnly": true } } }, "DeletedRunbook": { "type": "object", "description": "Definition of deleted runbook.", "properties": { "properties": { "$ref": "#/definitions/DeletedRunbookProperties", "description": "Gets or sets the runbook properties.", "x-ms-client-flatten": true }, "id": { "type": "string", "description": "The resource id." }, "name": { "type": "string", "description": "Gets or sets name of the resource." }, "location": { "type": "string", "description": "Gets or sets the location of the resource." } } }, "DeletedRunbookListResult": { "type": "object", "description": "The response model for the list deleted runbook.", "properties": { "value": { "type": "array", "description": "The DeletedRunbook items on this page", "items": { "$ref": "#/definitions/DeletedRunbook" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "DeletedRunbookProperties": { "type": "object", "description": "Definition of the deleted runbook property.", "properties": { "runbookId": { "type": "string", "description": "Gets or sets the Runbook Id." }, "runbookType": { "type": "string", "description": "Type of the runbook." }, "runtime": { "type": "string", "description": "Gets or sets runtime of the runbook." }, "runtimeEnvironment": { "type": "string", "description": "Environment of the runbook.", "x-nullable": true }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the creation time." }, "deletionTime": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time." } } }, "Dimension": { "type": "object", "description": "Dimension of the metric.", "properties": { "name": { "type": "string", "description": "The name of the dimension." }, "displayName": { "type": "string", "description": "The display name of the dimension." } } }, "DscConfiguration": { "type": "object", "description": "Definition of the configuration type.", "properties": { "properties": { "$ref": "#/definitions/DscConfigurationProperties", "description": "Gets or sets the configuration properties.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "Gets or sets the etag of the resource." } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "DscConfigurationAssociationProperty": { "type": "object", "description": "The Dsc configuration property associated with the entity.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the Dsc configuration." } } }, "DscConfigurationCreateOrUpdateParameters": { "type": "object", "description": "The parameters supplied to the create or update configuration operation.", "properties": { "properties": { "$ref": "#/definitions/DscConfigurationCreateOrUpdateProperties", "description": "Gets or sets configuration create or update properties.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Gets or sets name of the resource." }, "location": { "type": "string", "description": "Gets or sets the location of the resource." }, "tags": { "type": "object", "description": "Gets or sets the tags attached to the resource.", "additionalProperties": { "type": "string" } } }, "required": [ "properties" ] }, "DscConfigurationCreateOrUpdateProperties": { "type": "object", "description": "The properties to create or update configuration.", "properties": { "logVerbose": { "type": "boolean", "description": "Gets or sets verbose log option." }, "logProgress": { "type": "boolean", "description": "Gets or sets progress log option." }, "source": { "$ref": "#/definitions/ContentSource", "description": "Gets or sets the source." }, "parameters": { "type": "object", "description": "Gets or sets the configuration parameters.", "additionalProperties": { "$ref": "#/definitions/DscConfigurationParameter" } }, "description": { "type": "string", "description": "Gets or sets the description of the configuration." } }, "required": [ "source" ] }, "DscConfigurationListResult": { "type": "object", "description": "The response model for the list configuration operation.", "properties": { "value": { "type": "array", "description": "Gets or sets a list of configurations.", "items": { "$ref": "#/definitions/DscConfiguration" } }, "nextLink": { "type": "string", "description": "Gets or sets the next link." }, "totalCount": { "type": "integer", "format": "int32", "description": "Gets the total number of configurations matching filter criteria." } } }, "DscConfigurationParameter": { "type": "object", "description": "Definition of the configuration parameter type.", "properties": { "type": { "type": "string", "description": "Gets or sets the type of the parameter." }, "isMandatory": { "type": "boolean", "description": "Gets or sets a Boolean value to indicate whether the parameter is mandatory or not." }, "position": { "type": "integer", "format": "int32", "description": "Get or sets the position of the parameter." }, "defaultValue": { "type": "string", "description": "Gets or sets the default value of parameter." } } }, "DscConfigurationProperties": { "type": "object", "description": "Definition of the configuration property type.", "properties": { "provisioningState": { "type": "string", "description": "Gets or sets the provisioning state of the configuration.", "enum": [ "Succeeded" ], "x-ms-enum": { "modelAsString": false } }, "jobCount": { "type": "integer", "format": "int32", "description": "Gets or sets the job count of the configuration." }, "parameters": { "type": "object", "description": "Gets or sets the configuration parameters.", "additionalProperties": { "$ref": "#/definitions/DscConfigurationParameter" } }, "source": { "$ref": "#/definitions/ContentSource", "description": "Gets or sets the source." }, "state": { "$ref": "#/definitions/DscConfigurationState", "description": "Gets or sets the state of the configuration." }, "logVerbose": { "type": "boolean", "description": "Gets or sets verbose log option." }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the creation time." }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time." }, "nodeConfigurationCount": { "type": "integer", "format": "int32", "description": "Gets the number of compiled node configurations." }, "description": { "type": "string", "description": "Gets or sets the description." } } }, "DscConfigurationState": { "type": "string", "description": "Gets or sets the state of the configuration.", "enum": [ "New", "Edit", "Published" ], "x-ms-enum": { "name": "DscConfigurationState", "modelAsString": true, "values": [ { "name": "New", "value": "New", "description": "New" }, { "name": "Edit", "value": "Edit", "description": "Edit" }, { "name": "Published", "value": "Published", "description": "Published" } ] } }, "DscConfigurationUpdateParameters": { "type": "object", "description": "The parameters supplied to the create or update configuration operation.", "properties": { "properties": { "$ref": "#/definitions/DscConfigurationCreateOrUpdateProperties", "description": "Gets or sets configuration create or update properties.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Gets or sets name of the resource." }, "tags": { "type": "object", "description": "Gets or sets the tags attached to the resource.", "additionalProperties": { "type": "string" } } } }, "DscMetaConfiguration": { "type": "object", "description": "Definition of the DSC Meta Configuration.", "properties": { "configurationModeFrequencyMins": { "type": "integer", "format": "int32", "description": "Gets or sets the ConfigurationModeFrequencyMins value of the meta configuration." }, "rebootNodeIfNeeded": { "type": "boolean", "description": "Gets or sets the RebootNodeIfNeeded value of the meta configuration." }, "configurationMode": { "type": "string", "description": "Gets or sets the ConfigurationMode value of the meta configuration." }, "actionAfterReboot": { "type": "string", "description": "Gets or sets the ActionAfterReboot value of the meta configuration." }, "certificateId": { "type": "string", "description": "Gets or sets the CertificateId value of the meta configuration." }, "refreshFrequencyMins": { "type": "integer", "format": "int32", "description": "Gets or sets the RefreshFrequencyMins value of the meta configuration." }, "allowModuleOverwrite": { "type": "boolean", "description": "Gets or sets the AllowModuleOverwrite value of the meta configuration." } } }, "DscNode": { "type": "object", "description": "Definition of a DscNode", "properties": { "properties": { "$ref": "#/definitions/DscNodeProperties", "description": "The properties of a DscNode.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "DscNodeConfiguration": { "type": "object", "description": "Definition of the dsc node configuration.", "properties": { "properties": { "$ref": "#/definitions/DscNodeConfigurationProperties", "description": "Gets or sets the configuration properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "DscNodeConfigurationAssociationProperty": { "type": "object", "description": "The dsc node configuration property associated with the entity.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the dsc node configuration." } } }, "DscNodeConfigurationCreateOrUpdateParameters": { "type": "object", "description": "The parameters supplied to the create or update node configuration operation.", "properties": { "properties": { "$ref": "#/definitions/DscNodeConfigurationCreateOrUpdateParametersProperties", "description": "Node configuration properties", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the node configuration." }, "tags": { "type": "object", "description": "Gets or sets the tags attached to the resource.", "additionalProperties": { "type": "string" } } } }, "DscNodeConfigurationCreateOrUpdateParametersProperties": { "type": "object", "description": "The parameter properties supplied to the create or update node configuration operation.", "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" ] }, "DscNodeConfigurationListResult": { "type": "object", "description": "The response model for the list job operation.", "properties": { "value": { "type": "array", "description": "Gets or sets a list of Dsc node configurations.", "items": { "$ref": "#/definitions/DscNodeConfiguration" } }, "nextLink": { "type": "string", "description": "Gets or sets the next link." }, "totalCount": { "type": "integer", "format": "int32", "description": "Gets or sets the total rows in query." } } }, "DscNodeConfigurationProperties": { "type": "object", "description": "Properties for the DscNodeConfiguration", "properties": { "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time." }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets creation time." }, "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." } } }, "DscNodeExtensionHandlerAssociationProperty": { "type": "object", "description": "The dsc extensionHandler property associated with the node", "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." } } }, "DscNodeListResult": { "type": "object", "description": "The response model for the list dsc nodes operation.", "properties": { "value": { "type": "array", "description": "Gets or sets a list of dsc nodes.", "items": { "$ref": "#/definitions/DscNode" } }, "nextLink": { "type": "string", "description": "Gets or sets the next link." }, "totalCount": { "type": "integer", "format": "int32", "description": "Gets the total number of nodes matching filter criteria." } } }, "DscNodeProperties": { "type": "object", "description": "The properties of a DscNode", "properties": { "lastSeen": { "type": "string", "format": "date-time", "description": "Gets or sets the last seen time of the node." }, "registrationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the registration time of the node." }, "ip": { "type": "string", "description": "Gets or sets the ip of the node." }, "accountId": { "type": "string", "description": "Gets or sets the account id of the node." }, "nodeConfiguration": { "$ref": "#/definitions/DscNodeConfigurationAssociationProperty", "description": "Gets or sets the configuration of the node.", "x-nullable": true, "x-ms-client-flatten": true }, "status": { "type": "string", "description": "Gets or sets the status of the node." }, "nodeId": { "type": "string", "description": "Gets or sets the node id." }, "etag": { "type": "string", "description": "Gets or sets the etag of the resource." }, "totalCount": { "type": "integer", "format": "int32", "description": "Gets the total number of records matching filter criteria." }, "extensionHandler": { "type": "array", "description": "Gets or sets the list of extensionHandler properties for a Node.", "items": { "$ref": "#/definitions/DscNodeExtensionHandlerAssociationProperty" }, "x-ms-identifiers": [ "name" ] } } }, "DscNodeReport": { "type": "object", "description": "Definition of the dsc node report type.", "properties": { "endTime": { "type": "string", "format": "date-time", "description": "Gets or sets the end time of the node report.", "x-nullable": true }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets or sets the lastModifiedTime of the node report." }, "startTime": { "type": "string", "format": "date-time", "description": "Gets or sets the start time of the node report.", "x-nullable": true }, "type": { "type": "string", "description": "Gets or sets the type of the node report." }, "reportId": { "type": "string", "description": "Gets or sets the id of the node report." }, "status": { "type": "string", "description": "Gets or sets the status of the node report." }, "refreshMode": { "type": "string", "description": "Gets or sets the refreshMode of the node report." }, "rebootRequested": { "type": "string", "description": "Gets or sets the rebootRequested of the node report." }, "reportFormatVersion": { "type": "string", "description": "Gets or sets the reportFormatVersion of the node report." }, "configurationVersion": { "type": "string", "description": "Gets or sets the configurationVersion of the node report." }, "id": { "type": "string", "description": "Gets or sets the id." }, "errors": { "type": "array", "description": "Gets or sets the errors for the node report.", "items": { "$ref": "#/definitions/DscReportError" }, "x-ms-identifiers": [ "errorMessage", "resourceId" ] }, "resources": { "type": "array", "description": "Gets or sets the resource for the node report.", "items": { "$ref": "#/definitions/DscReportResource" }, "x-ms-identifiers": [ "resourceId" ] }, "metaConfiguration": { "$ref": "#/definitions/DscMetaConfiguration", "description": "Gets or sets the metaConfiguration of the node at the time of the report." }, "hostName": { "type": "string", "description": "Gets or sets the hostname of the node that sent the report." }, "iPV4Addresses": { "type": "array", "description": "Gets or sets the IPv4 address of the node that sent the report.", "items": { "type": "string" } }, "iPV6Addresses": { "type": "array", "description": "Gets or sets the IPv6 address of the node that sent the report.", "items": { "type": "string" } }, "numberOfResources": { "type": "integer", "format": "int32", "description": "Gets or sets the number of resource in the node report." }, "rawErrors": { "type": "string", "description": "Gets or sets the unparsed errors for the node report." } } }, "DscNodeReportListResult": { "type": "object", "description": "The response model for the list dsc nodes operation.", "properties": { "value": { "type": "array", "description": "The DscNodeReport items on this page", "items": { "$ref": "#/definitions/DscNodeReport" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "DscNodeUpdateParameters": { "type": "object", "description": "The parameters supplied to the update dsc node operation.", "properties": { "nodeId": { "type": "string", "description": "Gets or sets the id of the dsc node." }, "properties": { "$ref": "#/definitions/DscNodeUpdateParametersProperties" } } }, "DscNodeUpdateParametersProperties": { "type": "object", "properties": { "nodeConfiguration": { "$ref": "#/definitions/DscNodeConfigurationAssociationProperty", "description": "Gets or sets the configuration of the node.", "x-ms-client-flatten": true } } }, "DscReportError": { "type": "object", "description": "Definition of the dsc node report error type.", "properties": { "errorSource": { "type": "string", "description": "Gets or sets the source of the error." }, "resourceId": { "type": "string", "description": "Gets or sets the resource ID which generated the error." }, "errorCode": { "type": "string", "description": "Gets or sets the error code." }, "errorMessage": { "type": "string", "description": "Gets or sets the error message." }, "locale": { "type": "string", "description": "Gets or sets the locale of the error." }, "errorDetails": { "type": "string", "description": "Gets or sets the error details." } } }, "DscReportResource": { "type": "object", "description": "Definition of the DSC Report Resource.", "properties": { "resourceId": { "type": "string", "description": "Gets or sets the ID of the resource." }, "sourceInfo": { "type": "string", "description": "Gets or sets the source info of the resource." }, "dependsOn": { "type": "array", "description": "Gets or sets the Resource Navigation values for resources the resource depends on.", "items": { "$ref": "#/definitions/DscReportResourceNavigation" }, "x-ms-identifiers": [ "resourceId" ] }, "moduleName": { "type": "string", "description": "Gets or sets the module name of the resource." }, "moduleVersion": { "type": "string", "description": "Gets or sets the module version of the resource." }, "resourceName": { "type": "string", "description": "Gets or sets the name of the resource." }, "error": { "type": "string", "description": "Gets or sets the error of the resource." }, "status": { "type": "string", "description": "Gets or sets the status of the resource." }, "durationInSeconds": { "type": "number", "format": "double", "description": "Gets or sets the duration in seconds for the resource." }, "startDate": { "type": "string", "format": "date-time", "description": "Gets or sets the start date of the resource." } } }, "DscReportResourceNavigation": { "type": "object", "description": "Navigation for DSC Report Resource.", "properties": { "resourceId": { "type": "string", "description": "Gets or sets the ID of the resource to navigate to." } } }, "EncryptionKeySourceType": { "type": "string", "description": "Encryption Key Source", "enum": [ "Microsoft.Automation", "Microsoft.Keyvault" ], "x-ms-enum": { "name": "EncryptionKeySourceType", "modelAsString": false, "values": [ { "name": "Microsoft.Automation", "value": "Microsoft.Automation", "description": "Microsoft.Automation" }, { "name": "Microsoft.Keyvault", "value": "Microsoft.Keyvault", "description": "Microsoft.Keyvault" } ] } }, "EncryptionProperties": { "type": "object", "description": "The encryption settings for automation account", "properties": { "keyVaultProperties": { "$ref": "#/definitions/KeyVaultProperties", "description": "Key vault properties." }, "keySource": { "$ref": "#/definitions/EncryptionKeySourceType", "description": "Encryption Key Source" }, "identity": { "$ref": "#/definitions/EncryptionPropertiesIdentity", "description": "User identity used for CMK." } } }, "EncryptionPropertiesIdentity": { "type": "object", "description": "User identity used for CMK.", "properties": { "userAssignedIdentity": { "description": "The user identity used for CMK. It will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." } } }, "FieldDefinition": { "type": "object", "description": "Definition of the connection fields.", "properties": { "isEncrypted": { "type": "boolean", "description": "Gets or sets the isEncrypted flag of the connection field definition." }, "isOptional": { "type": "boolean", "description": "Gets or sets the isOptional flag of the connection field definition." }, "type": { "type": "string", "description": "Gets or sets the type of the connection field definition." } }, "required": [ "type" ] }, "GraphRunbookType": { "type": "string", "description": "Runbook Type", "enum": [ "GraphPowerShell", "GraphPowerShellWorkflow" ], "x-ms-enum": { "name": "GraphRunbookType", "modelAsString": true, "values": [ { "name": "GraphPowerShell", "value": "GraphPowerShell", "description": "GraphPowerShell" }, { "name": "GraphPowerShellWorkflow", "value": "GraphPowerShellWorkflow", "description": "GraphPowerShellWorkflow" } ] } }, "GraphicalRunbookContent": { "type": "object", "description": "Graphical Runbook Content", "properties": { "rawContent": { "$ref": "#/definitions/RawGraphicalRunbookContent", "description": "Raw graphical Runbook content.", "x-nullable": true }, "graphRunbookJson": { "type": "string", "description": "Graphical Runbook content as JSON", "x-nullable": true } } }, "GroupTypeEnum": { "type": "string", "description": "Type of the HybridWorkerGroup.", "enum": [ "User", "System" ], "x-ms-enum": { "name": "GroupTypeEnum", "modelAsString": true, "values": [ { "name": "User", "value": "User", "description": "User" }, { "name": "System", "value": "System", "description": "System" } ] } }, "HttpStatusCode": { "type": "string", "enum": [ "Continue", "SwitchingProtocols", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultipleChoices", "Ambiguous", "MovedPermanently", "Moved", "Found", "Redirect", "SeeOther", "RedirectMethod", "NotModified", "UseProxy", "Unused", "TemporaryRedirect", "RedirectKeepVerb", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "RequestEntityTooLarge", "RequestUriTooLong", "UnsupportedMediaType", "RequestedRangeNotSatisfiable", "ExpectationFailed", "UpgradeRequired", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HttpVersionNotSupported" ], "x-ms-enum": { "name": "HttpStatusCode", "modelAsString": true, "values": [ { "name": "Continue", "value": "Continue", "description": "Continue" }, { "name": "SwitchingProtocols", "value": "SwitchingProtocols", "description": "SwitchingProtocols" }, { "name": "OK", "value": "OK", "description": "OK" }, { "name": "Created", "value": "Created", "description": "Created" }, { "name": "Accepted", "value": "Accepted", "description": "Accepted" }, { "name": "NonAuthoritativeInformation", "value": "NonAuthoritativeInformation", "description": "NonAuthoritativeInformation" }, { "name": "NoContent", "value": "NoContent", "description": "NoContent" }, { "name": "ResetContent", "value": "ResetContent", "description": "ResetContent" }, { "name": "PartialContent", "value": "PartialContent", "description": "PartialContent" }, { "name": "MultipleChoices", "value": "MultipleChoices", "description": "MultipleChoices" }, { "name": "Ambiguous", "value": "Ambiguous", "description": "Ambiguous" }, { "name": "MovedPermanently", "value": "MovedPermanently", "description": "MovedPermanently" }, { "name": "Moved", "value": "Moved", "description": "Moved" }, { "name": "Found", "value": "Found", "description": "Found" }, { "name": "Redirect", "value": "Redirect", "description": "Redirect" }, { "name": "SeeOther", "value": "SeeOther", "description": "SeeOther" }, { "name": "RedirectMethod", "value": "RedirectMethod", "description": "RedirectMethod" }, { "name": "NotModified", "value": "NotModified", "description": "NotModified" }, { "name": "UseProxy", "value": "UseProxy", "description": "UseProxy" }, { "name": "Unused", "value": "Unused", "description": "Unused" }, { "name": "TemporaryRedirect", "value": "TemporaryRedirect", "description": "TemporaryRedirect" }, { "name": "RedirectKeepVerb", "value": "RedirectKeepVerb", "description": "RedirectKeepVerb" }, { "name": "BadRequest", "value": "BadRequest", "description": "BadRequest" }, { "name": "Unauthorized", "value": "Unauthorized", "description": "Unauthorized" }, { "name": "PaymentRequired", "value": "PaymentRequired", "description": "PaymentRequired" }, { "name": "Forbidden", "value": "Forbidden", "description": "Forbidden" }, { "name": "NotFound", "value": "NotFound", "description": "NotFound" }, { "name": "MethodNotAllowed", "value": "MethodNotAllowed", "description": "MethodNotAllowed" }, { "name": "NotAcceptable", "value": "NotAcceptable", "description": "NotAcceptable" }, { "name": "ProxyAuthenticationRequired", "value": "ProxyAuthenticationRequired", "description": "ProxyAuthenticationRequired" }, { "name": "RequestTimeout", "value": "RequestTimeout", "description": "RequestTimeout" }, { "name": "Conflict", "value": "Conflict", "description": "Conflict" }, { "name": "Gone", "value": "Gone", "description": "Gone" }, { "name": "LengthRequired", "value": "LengthRequired", "description": "LengthRequired" }, { "name": "PreconditionFailed", "value": "PreconditionFailed", "description": "PreconditionFailed" }, { "name": "RequestEntityTooLarge", "value": "RequestEntityTooLarge", "description": "RequestEntityTooLarge" }, { "name": "RequestUriTooLong", "value": "RequestUriTooLong", "description": "RequestUriTooLong" }, { "name": "UnsupportedMediaType", "value": "UnsupportedMediaType", "description": "UnsupportedMediaType" }, { "name": "RequestedRangeNotSatisfiable", "value": "RequestedRangeNotSatisfiable", "description": "RequestedRangeNotSatisfiable" }, { "name": "ExpectationFailed", "value": "ExpectationFailed", "description": "ExpectationFailed" }, { "name": "UpgradeRequired", "value": "UpgradeRequired", "description": "UpgradeRequired" }, { "name": "InternalServerError", "value": "InternalServerError", "description": "InternalServerError" }, { "name": "NotImplemented", "value": "NotImplemented", "description": "NotImplemented" }, { "name": "BadGateway", "value": "BadGateway", "description": "BadGateway" }, { "name": "ServiceUnavailable", "value": "ServiceUnavailable", "description": "ServiceUnavailable" }, { "name": "GatewayTimeout", "value": "GatewayTimeout", "description": "GatewayTimeout" }, { "name": "HttpVersionNotSupported", "value": "HttpVersionNotSupported", "description": "HttpVersionNotSupported" } ] } }, "HybridRunbookWorker": { "type": "object", "description": "Definition of hybrid runbook worker.", "properties": { "properties": { "$ref": "#/definitions/HybridRunbookWorkerProperties", "description": "Gets or sets the hybrid worker group properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "HybridRunbookWorkerCreateOrUpdateParameters": { "type": "object", "description": "The parameters supplied to the create or update hybrid runbook worker operation.", "properties": { "vmResourceId": { "type": "string", "description": "Azure Resource Manager Id for a virtual machine." } } }, "HybridRunbookWorkerCreateParameters": { "type": "object", "description": "The parameters supplied to the create hybrid runbook worker operation.", "properties": { "properties": { "$ref": "#/definitions/HybridRunbookWorkerCreateOrUpdateParameters", "description": "Gets or sets hybrid runbook worker group create or update properties.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Gets or sets the name of the resource.", "readOnly": true } } }, "HybridRunbookWorkerGroup": { "type": "object", "description": "Definition of hybrid runbook worker group.", "properties": { "properties": { "$ref": "#/definitions/HybridRunbookWorkerGroupProperties", "description": "Gets or sets the hybrid worker group properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "HybridRunbookWorkerGroupCreateOrUpdateParameters": { "type": "object", "description": "The parameters supplied to the create hybrid runbook worker group operation.", "properties": { "properties": { "$ref": "#/definitions/HybridRunbookWorkerGroupCreateOrUpdateProperties", "description": "Gets or sets hybrid runbook worker group create or update properties.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Gets or sets the name of the resource." } } }, "HybridRunbookWorkerGroupCreateOrUpdateProperties": { "type": "object", "description": "The hybrid runbook worker group properties.", "properties": { "credential": { "$ref": "#/definitions/RunAsCredentialAssociationProperty", "description": "Sets the credential of a worker group." } } }, "HybridRunbookWorkerGroupProperties": { "type": "object", "description": "Definition of hybrid runbook worker group property.", "properties": { "groupType": { "$ref": "#/definitions/GroupTypeEnum", "description": "Type of the HybridWorkerGroup." }, "credential": { "$ref": "#/definitions/RunAsCredentialAssociationProperty", "description": "Sets the credential of a worker group." } } }, "HybridRunbookWorkerGroupsListResult": { "type": "object", "description": "The response of a HybridRunbookWorkerGroup list operation.", "properties": { "value": { "type": "array", "description": "The HybridRunbookWorkerGroup items on this page", "items": { "$ref": "#/definitions/HybridRunbookWorkerGroup" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "HybridRunbookWorkerMoveParameters": { "type": "object", "description": "Parameters supplied to move hybrid worker operation.", "properties": { "hybridRunbookWorkerGroupName": { "type": "string", "description": "Gets or sets the target hybrid runbook worker group." } } }, "HybridRunbookWorkerProperties": { "type": "object", "description": "Definition of hybrid runbook worker property.", "properties": { "ip": { "type": "string", "description": "Gets or sets the assigned machine IP address." }, "registeredDateTime": { "type": "string", "format": "date-time", "description": "Gets or sets the registration time of the worker machine." }, "lastSeenDateTime": { "type": "string", "format": "date-time", "description": "Last Heartbeat from the Worker" }, "vmResourceId": { "type": "string", "description": "Azure Resource Manager Id for a virtual machine." }, "workerType": { "$ref": "#/definitions/WorkerType", "description": "Type of the HybridWorker." }, "workerName": { "type": "string", "description": "Name of the HybridWorker." } } }, "HybridRunbookWorkersListResult": { "type": "object", "description": "The response of a HybridRunbookWorker list operation.", "properties": { "value": { "type": "array", "description": "The HybridRunbookWorker items on this page", "items": { "$ref": "#/definitions/HybridRunbookWorker" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "Identity": { "type": "object", "description": "Identity for the resource.", "properties": { "principalId": { "type": "string", "description": "The principal ID of resource identity. The value must be an UUID.", "readOnly": true }, "tenantId": { "type": "string", "description": "The tenant ID of resource.", "readOnly": true }, "type": { "$ref": "#/definitions/ResourceIdentityType", "description": "The identity type." }, "userAssignedIdentities": { "type": "object", "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", "additionalProperties": { "$ref": "#/definitions/UserAssignedIdentitiesProperties" } } } }, "Job": { "type": "object", "description": "Definition of the job.", "properties": { "properties": { "$ref": "#/definitions/JobProperties", "description": "The properties of the job.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "JobCollectionItem": { "type": "object", "description": "Job collection item properties.", "properties": { "properties": { "$ref": "#/definitions/JobCollectionItemProperties", "description": "Job properties.", "x-ms-client-flatten": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "JobCollectionItemProperties": { "type": "object", "description": "Job collection item properties.", "properties": { "runbook": { "$ref": "#/definitions/RunbookAssociationProperty", "description": "The runbook association.", "readOnly": true }, "jobId": { "type": "string", "format": "uuid", "description": "The id of the job.", "readOnly": true }, "startedBy": { "type": "string", "description": "Gets or sets the job started by.", "x-nullable": true, "readOnly": true }, "creationTime": { "type": "string", "format": "date-time", "description": "The creation time of the job.", "readOnly": true }, "status": { "$ref": "#/definitions/JobStatus", "description": "The status of the job.", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "The start time of the job.", "x-nullable": true, "readOnly": true }, "endTime": { "type": "string", "format": "date-time", "description": "The end time of the job.", "x-nullable": true, "readOnly": true }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "The last modified time of the job.", "x-nullable": true, "readOnly": true }, "provisioningState": { "type": "string", "description": "The provisioning state of a resource.", "readOnly": true }, "jobRuntimeEnvironment": { "$ref": "#/definitions/JobRuntimeEnvironment", "description": "Runtime Environment Property" }, "runOn": { "type": "string", "description": "Specifies the runOn group name where the job was executed." } } }, "JobCreateParameters": { "type": "object", "description": "The parameters supplied to the create job operation.", "properties": { "properties": { "$ref": "#/definitions/JobCreateProperties", "description": "Gets or sets the list of job properties.", "x-ms-client-flatten": true } }, "required": [ "properties" ] }, "JobCreateProperties": { "type": "object", "properties": { "runbook": { "$ref": "#/definitions/RunbookAssociationProperty", "description": "Gets or sets the runbook." }, "parameters": { "type": "object", "description": "Gets or sets the parameters of the job.", "additionalProperties": { "type": "string" } }, "runOn": { "type": "string", "description": "Gets or sets the runOn which specifies the group name where the job is to be executed." } } }, "JobListResultV2": { "type": "object", "description": "The response model for the list job operation.", "properties": { "value": { "type": "array", "description": "The JobCollectionItem items on this page", "items": { "$ref": "#/definitions/JobCollectionItem" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "JobProperties": { "type": "object", "description": "Definition of job properties.", "properties": { "runbook": { "$ref": "#/definitions/RunbookAssociationProperty", "description": "Gets or sets the runbook." }, "startedBy": { "type": "string", "description": "Gets or sets the job started by." }, "runOn": { "type": "string", "description": "Gets or sets the runOn which specifies the group name where the job is to be executed." }, "jobRuntimeEnvironment": { "$ref": "#/definitions/JobRuntimeEnvironment", "description": "Runtime Environment Property" }, "jobId": { "type": "string", "format": "uuid", "description": "Gets or sets the id of the job." }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the creation time of the job." }, "status": { "$ref": "#/definitions/JobStatus", "description": "Gets or sets the status of the job." }, "statusDetails": { "type": "string", "description": "Gets or sets the status details of the job." }, "startTime": { "type": "string", "format": "date-time", "description": "Gets or sets the start time of the job.", "x-nullable": true }, "endTime": { "type": "string", "format": "date-time", "description": "Gets or sets the end time of the job.", "x-nullable": true }, "exception": { "type": "string", "description": "Gets or sets the exception of the job." }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time of the job.", "x-nullable": true }, "lastStatusModifiedTime": { "type": "string", "format": "date-time", "description": "Gets or sets the last status modified time of the job.", "x-nullable": true }, "parameters": { "type": "object", "description": "Gets or sets the parameters of the job.", "additionalProperties": { "type": "string" } }, "provisioningState": { "$ref": "#/definitions/JobProvisioningState", "description": "The current provisioning state of the job.", "readOnly": true } } }, "JobProvisioningState": { "type": "string", "description": "The provisioning state of the resource.", "enum": [ "Failed", "Succeeded", "Suspended", "Processing" ], "x-ms-enum": { "name": "JobProvisioningState", "modelAsString": true, "values": [ { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "Suspended", "value": "Suspended", "description": "Suspended" }, { "name": "Processing", "value": "Processing", "description": "Processing" } ] } }, "JobRuntimeEnvironment": { "type": "object", "description": "The runbook property associated with the entity.", "properties": { "runtimeEnvironmentName": { "type": "string", "description": "Name of Runtime Environment." } } }, "JobSchedule": { "type": "object", "description": "Definition of the job schedule.", "properties": { "properties": { "$ref": "#/definitions/JobScheduleProperties", "description": "Gets or sets the properties of the job schedule.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "JobScheduleCreateParameters": { "type": "object", "description": "The parameters supplied to the create job schedule operation.", "properties": { "properties": { "$ref": "#/definitions/JobScheduleCreateProperties", "description": "Gets or sets the list of job schedule properties.", "x-ms-client-flatten": true } }, "required": [ "properties" ] }, "JobScheduleCreateProperties": { "type": "object", "description": "The parameters supplied to the create job schedule operation.", "properties": { "schedule": { "$ref": "#/definitions/ScheduleAssociationProperty", "description": "Gets or sets the schedule." }, "runbook": { "$ref": "#/definitions/RunbookAssociationProperty", "description": "Gets or sets the runbook." }, "runOn": { "type": "string", "description": "Gets or sets the hybrid worker group that the scheduled job should run on." }, "parameters": { "type": "object", "description": "Gets or sets a list of job properties.", "additionalProperties": { "type": "string" } } }, "required": [ "schedule", "runbook" ] }, "JobScheduleListResult": { "type": "object", "description": "The response of a JobSchedule list operation.", "properties": { "value": { "type": "array", "description": "The JobSchedule items on this page", "items": { "$ref": "#/definitions/JobSchedule" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "JobScheduleProperties": { "type": "object", "description": "Definition of job schedule parameters.", "properties": { "jobScheduleId": { "type": "string", "description": "Gets or sets the id of job schedule." }, "schedule": { "$ref": "#/definitions/ScheduleAssociationProperty", "description": "Gets or sets the schedule." }, "runbook": { "$ref": "#/definitions/RunbookAssociationProperty", "description": "Gets or sets the runbook." }, "runOn": { "type": "string", "description": "Gets or sets the hybrid worker group that the scheduled job should run on." }, "parameters": { "type": "object", "description": "Gets or sets the parameters of the job schedule.", "additionalProperties": { "type": "string" } } } }, "JobStatus": { "type": "string", "description": "Gets or sets the status of the job.", "enum": [ "New", "Activating", "Running", "Completed", "Failed", "Stopped", "Blocked", "Suspended", "Disconnected", "Suspending", "Stopping", "Resuming", "Removing" ], "x-ms-enum": { "name": "JobStatus", "modelAsString": true, "values": [ { "name": "New", "value": "New", "description": "New" }, { "name": "Activating", "value": "Activating", "description": "Activating" }, { "name": "Running", "value": "Running", "description": "Running" }, { "name": "Completed", "value": "Completed", "description": "Completed" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Stopped", "value": "Stopped", "description": "Stopped" }, { "name": "Blocked", "value": "Blocked", "description": "Blocked" }, { "name": "Suspended", "value": "Suspended", "description": "Suspended" }, { "name": "Disconnected", "value": "Disconnected", "description": "Disconnected" }, { "name": "Suspending", "value": "Suspending", "description": "Suspending" }, { "name": "Stopping", "value": "Stopping", "description": "Stopping" }, { "name": "Resuming", "value": "Resuming", "description": "Resuming" }, { "name": "Removing", "value": "Removing", "description": "Removing" } ] } }, "JobStream": { "type": "object", "description": "Definition of the job stream.", "properties": { "id": { "type": "string", "description": "Gets or sets the id of the resource." }, "properties": { "$ref": "#/definitions/JobStreamProperties", "description": "Gets or sets the id of the job stream.", "x-ms-client-flatten": true } } }, "JobStreamListResult": { "type": "object", "description": "The response model for the list job stream operation.", "properties": { "value": { "type": "array", "description": "The JobStream items on this page", "items": { "$ref": "#/definitions/JobStream" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "JobStreamProperties": { "type": "object", "description": "Definition of the job stream.", "properties": { "jobStreamId": { "type": "string", "description": "Gets or sets the id of the job stream." }, "time": { "type": "string", "format": "date-time", "description": "Gets or sets the creation time of the job." }, "streamType": { "$ref": "#/definitions/JobStreamType", "description": "Gets or sets the stream type." }, "streamText": { "type": "string", "description": "Gets or sets the stream text." }, "summary": { "type": "string", "description": "Gets or sets the summary.", "x-nullable": true }, "value": { "type": "object", "description": "Gets or sets the values of the job stream.", "additionalProperties": {} } } }, "JobStreamType": { "type": "string", "description": "Gets or sets the stream type.", "enum": [ "Progress", "Output", "Warning", "Error", "Debug", "Verbose", "Any" ], "x-ms-enum": { "name": "JobStreamType", "modelAsString": true, "values": [ { "name": "Progress", "value": "Progress", "description": "Progress" }, { "name": "Output", "value": "Output", "description": "Output" }, { "name": "Warning", "value": "Warning", "description": "Warning" }, { "name": "Error", "value": "Error", "description": "Error" }, { "name": "Debug", "value": "Debug", "description": "Debug" }, { "name": "Verbose", "value": "Verbose", "description": "Verbose" }, { "name": "Any", "value": "Any", "description": "Any" } ] } }, "Key": { "type": "object", "description": "Automation key which is used to register a DSC Node", "properties": { "KeyName": { "$ref": "#/definitions/AutomationKeyName", "description": "Automation key name.", "readOnly": true }, "Permissions": { "$ref": "#/definitions/AutomationKeyPermissions", "description": "Automation key permissions.", "readOnly": true }, "Value": { "type": "string", "description": "Value of the Automation Key used for registration.", "readOnly": true } } }, "KeyListResult": { "type": "object", "properties": { "keys": { "type": "array", "description": "Lists the automation keys.", "items": { "$ref": "#/definitions/Key" }, "x-ms-identifiers": [ "KeyName" ] } } }, "KeyVaultProperties": { "type": "object", "description": "Settings concerning key vault encryption for a configuration store.", "properties": { "keyvaultUri": { "type": "string", "description": "The URI of the key vault key used to encrypt data." }, "keyName": { "type": "string", "description": "The name of key used to encrypt data." }, "keyVersion": { "type": "string", "description": "The key version of the key used to encrypt data." } } }, "LinkedWorkspace": { "type": "object", "description": "Definition of the linked workspace.", "properties": { "id": { "type": "string", "description": "Gets the id of the linked workspace.", "readOnly": true } } }, "LinuxProperties": { "type": "object", "description": "Linux specific update configuration.", "properties": { "includedPackageClassifications": { "$ref": "#/definitions/LinuxUpdateClasses", "description": "Update classifications included in the software update configuration." }, "excludedPackageNameMasks": { "type": "array", "description": "packages excluded from the software update configuration.", "items": { "type": "string" } }, "includedPackageNameMasks": { "type": "array", "description": "packages included from the software update configuration.", "items": { "type": "string" } }, "rebootSetting": { "type": "string", "description": "Reboot setting for the software update configuration." } } }, "LinuxUpdateClasses": { "type": "string", "description": "Update classifications included in the software update configuration.", "enum": [ "Unclassified", "Critical", "Security", "Other" ], "x-ms-enum": { "name": "LinuxUpdateClasses", "modelAsString": true, "values": [ { "name": "Unclassified", "value": "Unclassified", "description": "Unclassified" }, { "name": "Critical", "value": "Critical", "description": "Critical" }, { "name": "Security", "value": "Security", "description": "Security" }, { "name": "Other", "value": "Other", "description": "Other" } ] } }, "LogSpecification": { "type": "object", "description": "Description of logging specification.", "properties": { "name": { "type": "string", "description": "The name of the specification." }, "displayName": { "type": "string", "description": "The display name of the specification." }, "blobDuration": { "type": "string", "description": "Duration of the blob." } } }, "MetricSpecification": { "type": "object", "description": "Description of metrics specification.", "properties": { "name": { "type": "string", "description": "The name of the metric." }, "displayName": { "type": "string", "description": "The display name of the metric." }, "displayDescription": { "type": "string", "description": "The description of the metric." }, "unit": { "type": "string", "description": "Units the metric to be displayed in." }, "aggregationType": { "type": "string", "description": "The aggregation type." }, "dimensions": { "type": "array", "description": "List of dimensions.", "items": { "$ref": "#/definitions/Dimension" }, "x-ms-identifiers": [] } } }, "Module": { "type": "object", "description": "Definition of the module type.", "properties": { "properties": { "$ref": "#/definitions/ModuleProperties", "description": "Gets or sets the module properties.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "Gets or sets the etag of the resource." } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "ModuleCreateOrUpdateParameters": { "type": "object", "description": "The parameters supplied to the create or update module operation.", "properties": { "properties": { "$ref": "#/definitions/ModuleCreateOrUpdateProperties", "description": "Gets or sets the module create properties.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Gets or sets name of the resource." }, "location": { "type": "string", "description": "Gets or sets the location of the resource." }, "tags": { "type": "object", "description": "Gets or sets the tags attached to the resource.", "additionalProperties": { "type": "string" } } }, "required": [ "properties" ] }, "ModuleCreateOrUpdateProperties": { "type": "object", "description": "The parameters supplied to the create or update module properties.", "properties": { "contentLink": { "$ref": "#/definitions/ContentLink", "description": "Gets or sets the module content link." } }, "required": [ "contentLink" ] }, "ModuleErrorInfo": { "type": "object", "description": "Definition of the module error info type.", "properties": { "code": { "type": "string", "description": "Gets or sets the error code." }, "message": { "type": "string", "description": "Gets or sets the error message." } } }, "ModuleListResult": { "type": "object", "description": "The response of a Module list operation.", "properties": { "value": { "type": "array", "description": "The Module items on this page", "items": { "$ref": "#/definitions/Module" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ModuleProperties": { "type": "object", "description": "Definition of the module property type.", "properties": { "isGlobal": { "type": "boolean", "description": "Gets or sets the isGlobal flag of the module." }, "version": { "type": "string", "description": "Gets or sets the version of the module." }, "sizeInBytes": { "type": "integer", "format": "int64", "description": "Gets or sets the size in bytes of the module." }, "activityCount": { "type": "integer", "format": "int32", "description": "Gets or sets the activity count of the module." }, "provisioningState": { "$ref": "#/definitions/ModuleProvisioningState", "description": "Gets or sets the provisioning state of the module." }, "contentLink": { "$ref": "#/definitions/ContentLink", "description": "Gets or sets the contentLink of the module." }, "error": { "$ref": "#/definitions/ModuleErrorInfo", "description": "Gets or sets the error info of the module." }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the creation time." }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time." }, "description": { "type": "string", "description": "Gets or sets the description." }, "isComposite": { "type": "boolean", "description": "Gets or sets type of module, if its composite or not." } } }, "ModuleProvisioningState": { "type": "string", "description": "Gets or sets the provisioning state of the module.", "enum": [ "Created", "Creating", "StartingImportModuleRunbook", "RunningImportModuleRunbook", "ContentRetrieved", "ContentDownloaded", "ContentValidated", "ConnectionTypeImported", "ContentStored", "ModuleDataStored", "ActivitiesStored", "ModuleImportRunbookComplete", "Succeeded", "Failed", "Canceled", "Updating" ], "x-ms-enum": { "name": "ModuleProvisioningState", "modelAsString": true, "values": [ { "name": "Created", "value": "Created", "description": "Created" }, { "name": "Creating", "value": "Creating", "description": "Creating" }, { "name": "StartingImportModuleRunbook", "value": "StartingImportModuleRunbook", "description": "StartingImportModuleRunbook" }, { "name": "RunningImportModuleRunbook", "value": "RunningImportModuleRunbook", "description": "RunningImportModuleRunbook" }, { "name": "ContentRetrieved", "value": "ContentRetrieved", "description": "ContentRetrieved" }, { "name": "ContentDownloaded", "value": "ContentDownloaded", "description": "ContentDownloaded" }, { "name": "ContentValidated", "value": "ContentValidated", "description": "ContentValidated" }, { "name": "ConnectionTypeImported", "value": "ConnectionTypeImported", "description": "ConnectionTypeImported" }, { "name": "ContentStored", "value": "ContentStored", "description": "ContentStored" }, { "name": "ModuleDataStored", "value": "ModuleDataStored", "description": "ModuleDataStored" }, { "name": "ActivitiesStored", "value": "ActivitiesStored", "description": "ActivitiesStored" }, { "name": "ModuleImportRunbookComplete", "value": "ModuleImportRunbookComplete", "description": "ModuleImportRunbookComplete" }, { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Canceled", "value": "Canceled", "description": "Canceled" }, { "name": "Updating", "value": "Updating", "description": "Updating" } ] } }, "ModuleUpdateParameters": { "type": "object", "description": "The parameters supplied to the update module operation.", "properties": { "properties": { "$ref": "#/definitions/ModuleUpdateProperties", "description": "Gets or sets the module update properties.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Gets or sets name of the resource.", "readOnly": true }, "location": { "type": "string", "description": "Gets or sets the location of the resource.", "readOnly": true }, "tags": { "type": "object", "description": "Gets or sets the tags attached to the resource.", "additionalProperties": { "type": "string" } } } }, "ModuleUpdateProperties": { "type": "object", "description": "The parameters supplied to the update properties.", "properties": { "contentLink": { "$ref": "#/definitions/ContentLink", "description": "Gets or sets the module content link." } } }, "NodeCount": { "type": "object", "description": "Number of nodes based on the Filter", "properties": { "name": { "type": "string", "description": "Gets the name of a count type" }, "properties": { "$ref": "#/definitions/NodeCountProperties" } } }, "NodeCountProperties": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "description": "Gets the count for the name" } } }, "NodeCounts": { "type": "object", "description": "Gets the count of nodes by count type", "properties": { "value": { "type": "array", "description": "Gets an array of counts", "items": { "$ref": "#/definitions/NodeCount" }, "x-ms-identifiers": [ "name" ] }, "totalCount": { "type": "integer", "format": "int32", "description": "Gets the total number of records matching countType criteria." } } }, "NonAzureQueryProperties": { "type": "object", "description": "Non Azure query for the update configuration.", "properties": { "functionAlias": { "type": "string", "description": "Log Analytics Saved Search name." }, "workspaceId": { "type": "string", "description": "Workspace Id for Log Analytics in which the saved Search is resided." } } }, "OperatingSystemType": { "type": "string", "description": "Target operating system for the software update configuration.", "enum": [ "Windows", "Linux" ], "x-ms-enum": { "name": "OperatingSystemType", "modelAsString": false, "values": [ { "name": "Windows", "value": "Windows", "description": "Windows" }, { "name": "Linux", "value": "Linux", "description": "Linux" } ] } }, "Operation": { "type": "object", "description": "Automation REST API operation", "properties": { "name": { "type": "string", "description": "Operation name: {provider}/{resource}/{operation}" }, "display": { "$ref": "#/definitions/OperationDisplay", "description": "Provider, Resource and Operation values" }, "origin": { "type": "string", "description": "Origin of the operation." }, "properties": { "$ref": "#/definitions/OperationPropertiesFormat", "description": "Operation properties format.", "x-ms-client-flatten": true } } }, "OperationDisplay": { "type": "object", "description": "Provider, Resource and Operation values", "properties": { "provider": { "type": "string", "description": "Service provider: Microsoft.Automation" }, "resource": { "type": "string", "description": "Resource on which the operation is performed: Runbooks, Jobs etc." }, "operation": { "type": "string", "description": "Operation type: Read, write, delete, etc." }, "description": { "type": "string", "description": "Description of the operation." } } }, "OperationListResult": { "type": "object", "description": "The response model for the list of Automation operations", "properties": { "value": { "type": "array", "description": "List of Automation operations supported by the Automation resource provider.", "items": { "$ref": "#/definitions/Operation" }, "x-ms-identifiers": [ "name" ] }, "nextLink": { "type": "string", "description": "The URL to get the next set of results, if any." } }, "required": [ "value" ] }, "OperationPropertiesFormat": { "type": "object", "description": "Description of operation properties format.", "properties": { "serviceSpecification": { "$ref": "#/definitions/OperationPropertiesFormatServiceSpecification", "description": "Specification of the service." } } }, "OperationPropertiesFormatServiceSpecification": { "type": "object", "description": "Specification of the service.", "properties": { "metricSpecifications": { "type": "array", "description": "Operation service specification.", "items": { "$ref": "#/definitions/MetricSpecification" }, "x-ms-identifiers": [] }, "logSpecifications": { "type": "array", "description": "Operation log specification.", "items": { "$ref": "#/definitions/LogSpecification" }, "x-ms-identifiers": [] } } }, "Package": { "type": "object", "description": "Definition of the Package type.", "properties": { "properties": { "$ref": "#/definitions/PackageProperties", "description": "Gets or sets the Package properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "PackageCreateOrUpdateParameters": { "type": "object", "description": "The parameters supplied to the create or update package operation.", "properties": { "properties": { "$ref": "#/definitions/PackageCreateOrUpdateProperties", "description": "Gets or sets the package create properties.", "x-ms-client-flatten": true }, "allOf": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource", "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'" } }, "required": [ "properties" ] }, "PackageCreateOrUpdateProperties": { "type": "object", "description": "The parameters supplied to the create or update package properties.", "properties": { "contentLink": { "$ref": "#/definitions/ContentLink", "description": "Gets or sets the package content link." } }, "required": [ "contentLink" ] }, "PackageErrorInfo": { "type": "object", "description": "Definition of the package error info type.", "properties": { "code": { "type": "string", "description": "Package import error code." }, "message": { "type": "string", "description": "Package import error message." } } }, "PackageListResult": { "type": "object", "description": "The response of a Package list operation.", "properties": { "value": { "type": "array", "description": "The Package items on this page", "items": { "$ref": "#/definitions/Package" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PackageProperties": { "type": "object", "description": "Definition of the package property type.", "properties": { "default": { "type": "boolean", "description": "Gets or sets the isGlobal flag of the package." }, "version": { "type": "string", "description": "Gets or sets the version of the Package." }, "sizeInBytes": { "type": "integer", "format": "int64", "description": "Gets or sets the size in bytes of the Package." }, "provisioningState": { "$ref": "#/definitions/PackageProvisioningState", "description": "Gets or sets the provisioning state of the Package.", "readOnly": true }, "contentLink": { "$ref": "#/definitions/ContentLink", "description": "Gets or sets the contentLink of the Package." }, "error": { "$ref": "#/definitions/PackageErrorInfo", "description": "Gets or sets the error info of the Package." }, "allOf": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "Metadata pertaining to creation and last modification of the resource." } } }, "PackageProvisioningState": { "type": "string", "description": "Gets or sets the provisioning state of the Package.", "enum": [ "Created", "Creating", "StartingImportModuleRunbook", "RunningImportModuleRunbook", "ContentRetrieved", "ContentDownloaded", "ContentValidated", "ConnectionTypeImported", "ContentStored", "ModuleDataStored", "ActivitiesStored", "ModuleImportRunbookComplete", "Succeeded", "Failed", "Canceled", "Updating" ], "x-ms-enum": { "name": "PackageProvisioningState", "modelAsString": true, "values": [ { "name": "Created", "value": "Created", "description": "Created" }, { "name": "Creating", "value": "Creating", "description": "Creating" }, { "name": "StartingImportModuleRunbook", "value": "StartingImportModuleRunbook", "description": "StartingImportModuleRunbook" }, { "name": "RunningImportModuleRunbook", "value": "RunningImportModuleRunbook", "description": "RunningImportModuleRunbook" }, { "name": "ContentRetrieved", "value": "ContentRetrieved", "description": "ContentRetrieved" }, { "name": "ContentDownloaded", "value": "ContentDownloaded", "description": "ContentDownloaded" }, { "name": "ContentValidated", "value": "ContentValidated", "description": "ContentValidated" }, { "name": "ConnectionTypeImported", "value": "ConnectionTypeImported", "description": "ConnectionTypeImported" }, { "name": "ContentStored", "value": "ContentStored", "description": "ContentStored" }, { "name": "ModuleDataStored", "value": "ModuleDataStored", "description": "ModuleDataStored" }, { "name": "ActivitiesStored", "value": "ActivitiesStored", "description": "ActivitiesStored" }, { "name": "ModuleImportRunbookComplete", "value": "ModuleImportRunbookComplete", "description": "ModuleImportRunbookComplete" }, { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Canceled", "value": "Canceled", "description": "Canceled" }, { "name": "Updating", "value": "Updating", "description": "Updating" } ] } }, "PackageUpdateParameters": { "type": "object", "description": "The parameters supplied to the update package operation.", "properties": { "properties": { "$ref": "#/definitions/PackageUpdateProperties", "description": "Gets or sets the package update properties.", "x-ms-client-flatten": true }, "allOf": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource", "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'" } } }, "PackageUpdateProperties": { "type": "object", "description": "The parameters supplied to the update properties.", "properties": { "contentLink": { "$ref": "#/definitions/ContentLink", "description": "Gets or sets the package content link." } } }, "PrivateEndpointConnection": { "type": "object", "description": "A private endpoint connection", "properties": { "properties": { "$ref": "#/definitions/PrivateEndpointConnectionProperties", "description": "Resource properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "PrivateEndpointConnectionListResult": { "type": "object", "description": "A list of private endpoint connections", "properties": { "value": { "type": "array", "description": "Array of private endpoint connections", "items": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "nextLink": { "type": "string" } } }, "PrivateEndpointConnectionProperties": { "type": "object", "description": "Properties of a private endpoint connection.", "properties": { "privateEndpoint": { "$ref": "#/definitions/PrivateEndpointProperty", "description": "Private endpoint which the connection belongs to." }, "groupIds": { "type": "array", "description": "Gets the groupIds.", "items": { "type": "string" } }, "privateLinkServiceConnectionState": { "$ref": "#/definitions/PrivateLinkServiceConnectionStateProperty", "description": "Connection State of the Private Endpoint Connection." } } }, "PrivateEndpointProperty": { "type": "object", "description": "Private endpoint which the connection belongs to.", "properties": { "id": { "type": "string", "description": "Resource id of the private endpoint." } } }, "PrivateLinkResource": { "type": "object", "description": "A private link resource", "properties": { "properties": { "$ref": "#/definitions/PrivateLinkResourceProperties", "description": "Resource properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "PrivateLinkResourceListResult": { "type": "object", "description": "A list of private link resources", "properties": { "value": { "type": "array", "description": "Array of private link resources", "items": { "$ref": "#/definitions/PrivateLinkResource" } }, "nextLink": { "type": "string" } } }, "PrivateLinkResourceProperties": { "type": "object", "description": "Properties of a private link resource.", "properties": { "groupId": { "type": "string", "description": "The private link resource group id.", "readOnly": true }, "requiredMembers": { "type": "array", "description": "The private link resource required member names.", "items": { "type": "string" }, "readOnly": true } } }, "PrivateLinkServiceConnectionStateProperty": { "type": "object", "description": "Connection State of the Private Endpoint Connection.", "properties": { "status": { "type": "string", "description": "The private link service connection status." }, "description": { "type": "string", "description": "The private link service connection description." }, "actionsRequired": { "type": "string", "description": "Any action that is required beyond basic workflow (approve/ reject/ disconnect)", "readOnly": true } } }, "ProvisioningState": { "type": "string", "description": "The provisioning state of the job.", "enum": [ "Completed", "Failed", "Running" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true, "values": [ { "name": "Completed", "value": "Completed", "description": "Completed" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Running", "value": "Running", "description": "Running" } ] } }, "PythonPackageCreateParameters": { "type": "object", "description": "The parameters supplied to the create or update module operation.", "properties": { "properties": { "$ref": "#/definitions/PythonPackageCreateProperties", "description": "Gets or sets the module create properties.", "x-ms-client-flatten": true }, "tags": { "type": "object", "description": "Gets or sets the tags attached to the resource.", "additionalProperties": { "type": "string" } } }, "required": [ "properties" ] }, "PythonPackageCreateProperties": { "type": "object", "description": "The parameters supplied to the create or update module properties.", "properties": { "contentLink": { "$ref": "#/definitions/ContentLink", "description": "Gets or sets the module content link." } }, "required": [ "contentLink" ] }, "PythonPackageUpdateParameters": { "type": "object", "description": "The parameters supplied to the update module operation.", "properties": { "tags": { "type": "object", "description": "Gets or sets the tags attached to the resource.", "additionalProperties": { "type": "string" } } } }, "RawGraphicalRunbookContent": { "type": "object", "description": "Raw Graphical Runbook content", "properties": { "schemaVersion": { "type": "string", "description": "Schema version of the serializer." }, "runbookDefinition": { "type": "string", "description": "Serialized Graphical runbook" }, "runbookType": { "$ref": "#/definitions/GraphRunbookType", "description": "Runbook Type" } } }, "ResourceIdentityType": { "type": "string", "description": "The identity type.", "enum": [ "SystemAssigned", "UserAssigned", "SystemAssigned, UserAssigned", "None" ], "x-ms-enum": { "name": "ResourceIdentityType", "modelAsString": false, "values": [ { "name": "SystemAssigned", "value": "SystemAssigned", "description": "SystemAssigned" }, { "name": "UserAssigned", "value": "UserAssigned", "description": "UserAssigned" }, { "name": "SystemAssigned, UserAssigned", "value": "SystemAssigned, UserAssigned", "description": "SystemAssigned, UserAssigned" }, { "name": "None", "value": "None", "description": "None" } ] } }, "RunAsCredentialAssociationProperty": { "type": "object", "description": "Definition of RunAs credential to use for hybrid worker.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the credential." } } }, "Runbook": { "type": "object", "description": "Definition of the runbook type.", "properties": { "properties": { "$ref": "#/definitions/RunbookProperties", "description": "Gets or sets the runbook properties.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "Gets or sets the etag of the resource." } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "RunbookAssociationProperty": { "type": "object", "description": "The runbook property associated with the entity.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the runbook." } } }, "RunbookCreateOrUpdateDraftParameters": { "type": "object", "description": "The parameters supplied to the create or update runbook operation.", "properties": { "runbookContent": { "type": "string", "description": "Content of the Runbook." } }, "required": [ "runbookContent" ] }, "RunbookCreateOrUpdateDraftProperties": { "type": "object", "description": "The parameters supplied to the create or update draft runbook properties.", "properties": { "logVerbose": { "type": "boolean", "description": "Gets or sets verbose log option." }, "logProgress": { "type": "boolean", "description": "Gets or sets progress log option." }, "runtimeEnvironment": { "type": "string", "description": "Environment of the runbook." }, "runbookType": { "$ref": "#/definitions/RunbookTypeEnum", "description": "Gets or sets the type of the runbook." }, "draft": { "$ref": "#/definitions/RunbookDraft", "description": "Gets or sets the draft runbook properties." }, "description": { "type": "string", "description": "Gets or sets the description of the runbook." }, "logActivityTrace": { "type": "integer", "format": "int32", "description": "Gets or sets the activity-level tracing options of the runbook." } }, "required": [ "runbookType", "draft" ] }, "RunbookCreateOrUpdateParameters": { "type": "object", "description": "The parameters supplied to the create or update runbook operation.", "properties": { "properties": { "$ref": "#/definitions/RunbookCreateOrUpdateProperties", "description": "Gets or sets runbook create or update properties.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Gets or sets the name of the resource." }, "location": { "type": "string", "description": "Gets or sets the location of the resource." }, "tags": { "type": "object", "description": "Gets or sets the tags attached to the resource.", "additionalProperties": { "type": "string" } } }, "required": [ "properties" ] }, "RunbookCreateOrUpdateProperties": { "type": "object", "description": "The parameters supplied to the create or update runbook properties.", "properties": { "logVerbose": { "type": "boolean", "description": "Gets or sets verbose log option." }, "logProgress": { "type": "boolean", "description": "Gets or sets progress log option." }, "runtimeEnvironment": { "type": "string", "description": "Environment of the runbook." }, "runbookType": { "$ref": "#/definitions/RunbookTypeEnum", "description": "Gets or sets the type of the runbook." }, "draft": { "$ref": "#/definitions/RunbookDraft", "description": "Gets or sets the draft runbook properties." }, "publishContentLink": { "$ref": "#/definitions/ContentLink", "description": "Gets or sets the published runbook content link." }, "description": { "type": "string", "description": "Gets or sets the description of the runbook." }, "logActivityTrace": { "type": "integer", "format": "int32", "description": "Gets or sets the activity-level tracing options of the runbook." } }, "required": [ "runbookType" ] }, "RunbookDraft": { "type": "object", "properties": { "inEdit": { "type": "boolean", "description": "Gets or sets whether runbook is in edit mode." }, "draftContentLink": { "$ref": "#/definitions/ContentLink", "description": "Gets or sets the draft runbook content link." }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the creation time of the runbook draft." }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time of the runbook draft." }, "parameters": { "type": "object", "description": "Gets or sets the runbook draft parameters.", "additionalProperties": { "$ref": "#/definitions/RunbookParameter" } }, "outputTypes": { "type": "array", "description": "Gets or sets the runbook output types.", "items": { "type": "string" } } } }, "RunbookDraftUndoEditResult": { "type": "object", "description": "The response model for the undo edit runbook operation.", "properties": { "statusCode": { "$ref": "#/definitions/HttpStatusCode" }, "requestId": { "type": "string" } } }, "RunbookListResult": { "type": "object", "description": "The response of a Runbook list operation.", "properties": { "value": { "type": "array", "description": "The Runbook items on this page", "items": { "$ref": "#/definitions/Runbook" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "RunbookParameter": { "type": "object", "description": "Definition of the runbook parameter type.", "properties": { "type": { "type": "string", "description": "Gets or sets the type of the parameter." }, "isMandatory": { "type": "boolean", "description": "Gets or sets a Boolean value to indicate whether the parameter is mandatory or not." }, "position": { "type": "integer", "format": "int32", "description": "Get or sets the position of the parameter." }, "defaultValue": { "type": "string", "description": "Gets or sets the default value of parameter." } } }, "RunbookProperties": { "type": "object", "description": "Definition of the runbook property type.", "properties": { "runtimeEnvironment": { "type": "string", "description": "Runtime Environment of the runbook execution." }, "runbookType": { "$ref": "#/definitions/RunbookTypeEnum", "description": "Gets or sets the type of the runbook." }, "publishContentLink": { "$ref": "#/definitions/ContentLink", "description": "Gets or sets the published runbook content link." }, "state": { "$ref": "#/definitions/RunbookState", "description": "Gets or sets the state of the runbook." }, "logVerbose": { "type": "boolean", "description": "Gets or sets verbose log option." }, "logProgress": { "type": "boolean", "description": "Gets or sets progress log option." }, "logActivityTrace": { "type": "integer", "format": "int32", "description": "Gets or sets the option to log activity trace of the runbook." }, "jobCount": { "type": "integer", "format": "int32", "description": "Gets or sets the job count of the runbook." }, "parameters": { "type": "object", "description": "Gets or sets the runbook parameters.", "additionalProperties": { "$ref": "#/definitions/RunbookParameter" } }, "outputTypes": { "type": "array", "description": "Gets or sets the runbook output types.", "items": { "type": "string" } }, "draft": { "$ref": "#/definitions/RunbookDraft", "description": "Gets or sets the draft runbook properties." }, "provisioningState": { "type": "string", "description": "Gets or sets the provisioning state of the runbook.", "enum": [ "Succeeded" ], "x-ms-enum": { "modelAsString": false } }, "lastModifiedBy": { "type": "string", "description": "Gets or sets the last modified by." }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the creation time." }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time." }, "description": { "type": "string", "description": "Gets or sets the description." } } }, "RunbookState": { "type": "string", "description": "Gets or sets the state of the runbook.", "enum": [ "New", "Edit", "Published" ], "x-ms-enum": { "name": "RunbookState", "modelAsString": true, "values": [ { "name": "New", "value": "New", "description": "New" }, { "name": "Edit", "value": "Edit", "description": "Edit" }, { "name": "Published", "value": "Published", "description": "Published" } ] } }, "RunbookTypeEnum": { "type": "string", "description": "Gets or sets the type of the runbook.", "enum": [ "Script", "Graph", "PowerShellWorkflow", "PowerShell", "GraphPowerShellWorkflow", "GraphPowerShell", "Python2", "Python3", "Python", "PowerShell72" ], "x-ms-enum": { "name": "RunbookTypeEnum", "modelAsString": true, "values": [ { "name": "Script", "value": "Script", "description": "Script" }, { "name": "Graph", "value": "Graph", "description": "Graph" }, { "name": "PowerShellWorkflow", "value": "PowerShellWorkflow", "description": "PowerShellWorkflow" }, { "name": "PowerShell", "value": "PowerShell", "description": "PowerShell" }, { "name": "GraphPowerShellWorkflow", "value": "GraphPowerShellWorkflow", "description": "GraphPowerShellWorkflow" }, { "name": "GraphPowerShell", "value": "GraphPowerShell", "description": "GraphPowerShell" }, { "name": "Python2", "value": "Python2", "description": "Python2" }, { "name": "Python3", "value": "Python3", "description": "Python3" }, { "name": "Python", "value": "Python", "description": "Python" }, { "name": "PowerShell72", "value": "PowerShell72", "description": "PowerShell72" } ] } }, "RunbookUpdateParameters": { "type": "object", "description": "The parameters supplied to the update runbook operation.", "properties": { "properties": { "$ref": "#/definitions/RunbookUpdateProperties", "description": "Gets or sets the runbook update properties.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Gets or sets the name of the resource." }, "location": { "type": "string", "description": "Gets or sets the location of the resource." }, "tags": { "type": "object", "description": "Gets or sets the tags attached to the resource.", "additionalProperties": { "type": "string" } } } }, "RunbookUpdateProperties": { "type": "object", "description": "The parameters supplied to the update runbook properties.", "properties": { "description": { "type": "string", "description": "Gets or sets the description of the runbook." }, "logVerbose": { "type": "boolean", "description": "Gets or sets verbose log option." }, "logProgress": { "type": "boolean", "description": "Gets or sets progress log option." }, "logActivityTrace": { "type": "integer", "format": "int32", "description": "Gets or sets the activity-level tracing options of the runbook." } } }, "RuntimeEnvironment": { "type": "object", "description": "Definition of the Runtime Environment type.", "properties": { "properties": { "$ref": "#/definitions/RuntimeEnvironmentProperties", "description": "Gets or sets the Runtime Environment properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "RuntimeEnvironmentListResult": { "type": "object", "description": "The response of a RuntimeEnvironment list operation.", "properties": { "value": { "type": "array", "description": "The RuntimeEnvironment items on this page", "items": { "$ref": "#/definitions/RuntimeEnvironment" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "RuntimeEnvironmentProperties": { "type": "object", "description": "Runtime Environment properties.", "properties": { "runtime": { "$ref": "#/definitions/RuntimeProperties", "description": "Runtime properties.", "x-ms-client-flatten": true }, "defaultPackages": { "type": "object", "description": "List of Default packages for Environment", "additionalProperties": { "type": "string" } }, "description": { "type": "string", "description": "Gets or sets the description." } } }, "RuntimeEnvironmentUpdateParameters": { "type": "object", "description": "The parameters supplied to the update automation account operation.", "properties": { "properties": { "$ref": "#/definitions/RuntimeEnvironmentUpdateProperties", "description": "Gets or sets Runtime update properties.", "x-ms-client-flatten": true }, "systemData": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "Metadata pertaining to creation and last modification of the resource." } } }, "RuntimeEnvironmentUpdateProperties": { "type": "object", "description": "Gets or sets Runtime update properties.", "properties": { "defaultPackages": { "type": "object", "description": "List of Default packages for Environment", "additionalProperties": { "type": "string" } } } }, "RuntimeProperties": { "type": "object", "description": "Runtime properties.", "properties": { "language": { "type": "string", "description": "Language of Runtime Environment" }, "version": { "type": "string", "description": "Version of Language" } } }, "SUCScheduleProperties": { "type": "object", "description": "Definition of schedule parameters.", "properties": { "startTime": { "type": "string", "format": "date-time", "description": "Gets or sets the start time of the schedule." }, "startTimeOffsetMinutes": { "type": "number", "format": "double", "description": "Gets the start time's offset in minutes.", "readOnly": true }, "expiryTime": { "type": "string", "format": "date-time", "description": "Gets or sets the end time of the schedule.", "x-nullable": true }, "expiryTimeOffsetMinutes": { "type": "number", "format": "double", "description": "Gets or sets the expiry time's offset in minutes." }, "isEnabled": { "type": "boolean", "description": "Gets or sets a value indicating whether this schedule is enabled." }, "nextRun": { "type": "string", "format": "date-time", "description": "Gets or sets the next run time of the schedule.", "x-nullable": true }, "nextRunOffsetMinutes": { "type": "number", "format": "double", "description": "Gets or sets the next run time's offset in minutes." }, "interval": { "type": "integer", "format": "int64", "description": "Gets or sets the interval of the schedule." }, "frequency": { "$ref": "#/definitions/ScheduleFrequency", "description": "Gets or sets the frequency of the schedule." }, "timeZone": { "type": "string", "description": "Gets or sets the time zone of the schedule." }, "advancedSchedule": { "$ref": "#/definitions/AdvancedSchedule", "description": "Gets or sets the advanced schedule." }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the creation time." }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time." }, "description": { "type": "string", "description": "Gets or sets the description." } } }, "Schedule": { "type": "object", "description": "Definition of the schedule.", "properties": { "properties": { "$ref": "#/definitions/ScheduleProperties", "description": "Gets or sets the properties of the schedule.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ScheduleAssociationProperty": { "type": "object", "description": "The schedule property associated with the entity.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the Schedule." } } }, "ScheduleCreateOrUpdateParameters": { "type": "object", "description": "The parameters supplied to the create or update schedule operation.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the Schedule." }, "properties": { "$ref": "#/definitions/ScheduleCreateOrUpdateProperties", "description": "Gets or sets the list of schedule properties.", "x-ms-client-flatten": true } }, "required": [ "name", "properties" ] }, "ScheduleCreateOrUpdateProperties": { "type": "object", "description": "The parameters supplied to the create or update schedule operation.", "properties": { "description": { "type": "string", "description": "Gets or sets the description of the schedule." }, "startTime": { "type": "string", "format": "date-time", "description": "Gets or sets the start time of the schedule." }, "expiryTime": { "type": "string", "format": "date-time", "description": "Gets or sets the end time of the schedule.", "x-nullable": true }, "interval": { "description": "Gets or sets the interval of the schedule." }, "frequency": { "$ref": "#/definitions/ScheduleFrequency", "description": "Gets or sets the frequency of the schedule." }, "timeZone": { "type": "string", "description": "Gets or sets the time zone of the schedule." }, "advancedSchedule": { "$ref": "#/definitions/AdvancedSchedule", "description": "Gets or sets the AdvancedSchedule." } }, "required": [ "startTime", "frequency" ] }, "ScheduleDay": { "type": "string", "description": "Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "x-ms-enum": { "name": "ScheduleDay", "modelAsString": true, "values": [ { "name": "Monday", "value": "Monday", "description": "Monday" }, { "name": "Tuesday", "value": "Tuesday", "description": "Tuesday" }, { "name": "Wednesday", "value": "Wednesday", "description": "Wednesday" }, { "name": "Thursday", "value": "Thursday", "description": "Thursday" }, { "name": "Friday", "value": "Friday", "description": "Friday" }, { "name": "Saturday", "value": "Saturday", "description": "Saturday" }, { "name": "Sunday", "value": "Sunday", "description": "Sunday" } ] } }, "ScheduleFrequency": { "type": "string", "description": "Gets or sets the frequency of the schedule.", "enum": [ "OneTime", "Day", "Hour", "Week", "Month", "Minute" ], "x-ms-enum": { "name": "ScheduleFrequency", "modelAsString": true, "values": [ { "name": "OneTime", "value": "OneTime", "description": "OneTime" }, { "name": "Day", "value": "Day", "description": "Day" }, { "name": "Hour", "value": "Hour", "description": "Hour" }, { "name": "Week", "value": "Week", "description": "Week" }, { "name": "Month", "value": "Month", "description": "Month" }, { "name": "Minute", "value": "Minute", "description": "The minimum allowed interval for Minute schedules is 15 minutes." } ] } }, "ScheduleListResult": { "type": "object", "description": "The response of a Schedule list operation.", "properties": { "value": { "type": "array", "description": "The Schedule items on this page", "items": { "$ref": "#/definitions/Schedule" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ScheduleProperties": { "type": "object", "description": "Definition of schedule parameters.", "properties": { "startTime": { "type": "string", "format": "date-time", "description": "Gets or sets the start time of the schedule." }, "startTimeOffsetMinutes": { "type": "number", "format": "double", "description": "Gets the start time's offset in minutes.", "readOnly": true }, "expiryTime": { "type": "string", "format": "date-time", "description": "Gets or sets the end time of the schedule.", "x-nullable": true }, "expiryTimeOffsetMinutes": { "type": "number", "format": "double", "description": "Gets or sets the expiry time's offset in minutes." }, "isEnabled": { "type": "boolean", "description": "Gets or sets a value indicating whether this schedule is enabled." }, "nextRun": { "type": "string", "format": "date-time", "description": "Gets or sets the next run time of the schedule.", "x-nullable": true }, "nextRunOffsetMinutes": { "type": "number", "format": "double", "description": "Gets or sets the next run time's offset in minutes." }, "interval": { "description": "Gets or sets the interval of the schedule." }, "frequency": { "$ref": "#/definitions/ScheduleFrequency", "description": "Gets or sets the frequency of the schedule." }, "timeZone": { "type": "string", "description": "Gets or sets the time zone of the schedule." }, "advancedSchedule": { "$ref": "#/definitions/AdvancedSchedule", "description": "Gets or sets the advanced schedule." }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the creation time." }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time." }, "description": { "type": "string", "description": "Gets or sets the description." } } }, "ScheduleUpdateParameters": { "type": "object", "description": "The parameters supplied to the update schedule operation.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the Schedule." }, "properties": { "$ref": "#/definitions/ScheduleUpdateProperties", "description": "Gets or sets the list of schedule properties.", "x-ms-client-flatten": true } } }, "ScheduleUpdateProperties": { "type": "object", "description": "The parameters supplied to the update schedule operation.", "properties": { "description": { "type": "string", "description": "Gets or sets the description of the schedule." }, "isEnabled": { "type": "boolean", "description": "Gets or sets a value indicating whether this schedule is enabled." } } }, "Sku": { "type": "object", "description": "The account SKU.", "properties": { "name": { "$ref": "#/definitions/SkuNameEnum", "description": "Gets or sets the SKU name of the account." }, "family": { "type": "string", "description": "Gets or sets the SKU family." }, "capacity": { "type": "integer", "format": "int32", "description": "Gets or sets the SKU capacity." } }, "required": [ "name" ] }, "SkuNameEnum": { "type": "string", "description": "Gets or sets the SKU name of the account.", "enum": [ "Free", "Basic" ], "x-ms-enum": { "name": "SkuNameEnum", "modelAsString": true, "values": [ { "name": "Free", "value": "Free", "description": "Free" }, { "name": "Basic", "value": "Basic", "description": "Basic" } ] } }, "SourceControl": { "type": "object", "description": "Definition of the source control.", "properties": { "properties": { "$ref": "#/definitions/SourceControlProperties", "description": "The properties of the source control.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "SourceControlCreateOrUpdateParameters": { "type": "object", "description": "The parameters supplied to the create or update source control operation.", "properties": { "properties": { "$ref": "#/definitions/SourceControlCreateOrUpdateProperties", "description": "The properties of the source control.", "x-ms-client-flatten": true } }, "required": [ "properties" ] }, "SourceControlCreateOrUpdateProperties": { "type": "object", "description": "The properties of the create source control operation.", "properties": { "repoUrl": { "type": "string", "description": "The repo url of the source control.", "maxLength": 2000 }, "branch": { "type": "string", "description": "The repo branch of the source control. Include branch as empty string for VsoTfvc.", "maxLength": 255 }, "folderPath": { "type": "string", "description": "The folder path of the source control. Path must be relative.", "maxLength": 255 }, "autoSync": { "type": "boolean", "description": "The auto async of the source control. Default is false." }, "publishRunbook": { "type": "boolean", "description": "The auto publish of the source control. Default is true." }, "sourceType": { "$ref": "#/definitions/SourceType", "description": "The source type. Must be one of VsoGit, VsoTfvc, GitHub, case sensitive." }, "securityToken": { "$ref": "#/definitions/SourceControlSecurityTokenProperties", "description": "The authorization token for the repo of the source control." }, "description": { "type": "string", "description": "The user description of the source control.", "maxLength": 512 } } }, "SourceControlListResult": { "type": "object", "description": "The response of a SourceControl list operation.", "properties": { "value": { "type": "array", "description": "The SourceControl items on this page", "items": { "$ref": "#/definitions/SourceControl" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SourceControlProperties": { "type": "object", "description": "Definition of the source control properties", "properties": { "repoUrl": { "type": "string", "description": "The repo url of the source control." }, "branch": { "type": "string", "description": "The repo branch of the source control. Include branch as empty string for VsoTfvc." }, "folderPath": { "type": "string", "description": "The folder path of the source control." }, "autoSync": { "type": "boolean", "description": "The auto sync of the source control. Default is false." }, "publishRunbook": { "type": "boolean", "description": "The auto publish of the source control. Default is true." }, "sourceType": { "$ref": "#/definitions/SourceType", "description": "The source type. Must be one of VsoGit, VsoTfvc, GitHub." }, "description": { "type": "string", "description": "The description." }, "creationTime": { "type": "string", "format": "date-time", "description": "The creation time." }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "The last modified time." } } }, "SourceControlSecurityTokenProperties": { "type": "object", "properties": { "accessToken": { "type": "string", "description": "The access token.", "maxLength": 1024 }, "refreshToken": { "type": "string", "description": "The refresh token.", "maxLength": 1024 }, "tokenType": { "$ref": "#/definitions/TokenType", "description": "The token type. Must be either PersonalAccessToken or Oauth." } } }, "SourceControlSyncJob": { "type": "object", "description": "Definition of the source control sync job.", "properties": { "name": { "type": "string", "description": "Resource name.", "readOnly": true }, "type": { "type": "string", "description": "Resource type.", "readOnly": true }, "id": { "type": "string", "description": "Resource id.", "readOnly": true }, "properties": { "$ref": "#/definitions/SourceControlSyncJobProperties", "description": "The properties of the source control sync job.", "x-ms-client-flatten": true } } }, "SourceControlSyncJobById": { "type": "object", "description": "Definition of the source control sync job.", "properties": { "id": { "type": "string", "description": "The id of the job." }, "properties": { "$ref": "#/definitions/SourceControlSyncJobByIdProperties", "description": "The properties of the source control sync job.", "x-ms-client-flatten": true } } }, "SourceControlSyncJobByIdProperties": { "type": "object", "description": "Definition of source control sync job properties.", "properties": { "sourceControlSyncJobId": { "type": "string", "description": "The source control sync job id." }, "creationTime": { "type": "string", "format": "date-time", "description": "The creation time of the job.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the job." }, "startTime": { "type": "string", "format": "date-time", "description": "The start time of the job.", "x-nullable": true, "readOnly": true }, "endTime": { "type": "string", "format": "date-time", "description": "The end time of the job.", "x-nullable": true, "readOnly": true }, "syncType": { "$ref": "#/definitions/SyncType", "description": "The sync type." }, "exception": { "type": "string", "description": "The exceptions that occurred while running the sync job." } } }, "SourceControlSyncJobCreateParameters": { "type": "object", "description": "The parameters supplied to the create source control sync job operation.", "properties": { "properties": { "$ref": "#/definitions/SourceControlSyncJobCreateProperties", "description": "The properties of the source control sync job.", "x-ms-client-flatten": true } }, "required": [ "properties" ] }, "SourceControlSyncJobCreateProperties": { "type": "object", "description": "Definition of create source control sync job properties.", "properties": { "commitId": { "type": "string", "description": "The commit id of the source control sync job. If not syncing to a commitId, enter an empty string.", "minLength": 0 } }, "required": [ "commitId" ] }, "SourceControlSyncJobListResult": { "type": "object", "description": "The response of a SourceControlSyncJob list operation.", "properties": { "value": { "type": "array", "description": "The SourceControlSyncJob items on this page", "items": { "$ref": "#/definitions/SourceControlSyncJob" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SourceControlSyncJobProperties": { "type": "object", "description": "Definition of source control sync job properties.", "properties": { "sourceControlSyncJobId": { "type": "string", "description": "The source control sync job id." }, "creationTime": { "type": "string", "format": "date-time", "description": "The creation time of the job.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the job." }, "startTime": { "type": "string", "format": "date-time", "description": "The start time of the job.", "x-nullable": true, "readOnly": true }, "endTime": { "type": "string", "format": "date-time", "description": "The end time of the job.", "x-nullable": true, "readOnly": true }, "syncType": { "$ref": "#/definitions/SyncType", "description": "The sync type." } } }, "SourceControlSyncJobStream": { "type": "object", "description": "Definition of the source control sync job stream.", "properties": { "id": { "type": "string", "description": "Resource id.", "readOnly": true }, "properties": { "$ref": "#/definitions/SourceControlSyncJobStreamProperties", "description": "The properties of the source control sync job stream.", "x-ms-client-flatten": true } } }, "SourceControlSyncJobStreamById": { "type": "object", "description": "Definition of the source control sync job stream by id.", "properties": { "id": { "type": "string", "description": "Resource id.", "readOnly": true }, "properties": { "$ref": "#/definitions/SourceControlSyncJobStreamByIdProperties", "description": "The properties of the source control sync job stream.", "x-ms-client-flatten": true } } }, "SourceControlSyncJobStreamByIdProperties": { "type": "object", "description": "Definition of source control sync job stream by id properties.", "properties": { "sourceControlSyncJobStreamId": { "type": "string", "description": "The sync job stream id." }, "summary": { "type": "string", "description": "The summary of the sync job stream." }, "time": { "type": "string", "format": "date-time", "description": "The time of the sync job stream.", "x-nullable": true, "readOnly": true }, "streamType": { "$ref": "#/definitions/StreamType", "description": "The type of the sync job stream." }, "streamText": { "type": "string", "description": "The text of the sync job stream." }, "value": { "type": "object", "description": "The values of the job stream.", "additionalProperties": {} } } }, "SourceControlSyncJobStreamProperties": { "type": "object", "description": "Definition of source control sync job stream properties.", "properties": { "sourceControlSyncJobStreamId": { "type": "string", "description": "The sync job stream id." }, "summary": { "type": "string", "description": "The summary of the sync job stream." }, "time": { "type": "string", "format": "date-time", "description": "The time of the sync job stream.", "x-nullable": true, "readOnly": true }, "streamType": { "$ref": "#/definitions/StreamType", "description": "The type of the sync job stream." } } }, "SourceControlSyncJobStreamsListBySyncJob": { "type": "object", "description": "The response model for the list source control sync job streams operation.", "properties": { "value": { "type": "array", "description": "The SourceControlSyncJobStream items on this page", "items": { "$ref": "#/definitions/SourceControlSyncJobStream" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SourceControlUpdateParameters": { "type": "object", "description": "The parameters supplied to the update source control operation.", "properties": { "properties": { "$ref": "#/definitions/SourceControlUpdateProperties", "description": "The value of the source control.", "x-ms-client-flatten": true } } }, "SourceControlUpdateProperties": { "type": "object", "description": "The properties of the update source control", "properties": { "branch": { "type": "string", "description": "The repo branch of the source control." }, "folderPath": { "type": "string", "description": "The folder path of the source control. Path must be relative." }, "autoSync": { "type": "boolean", "description": "The auto sync of the source control. Default is false." }, "publishRunbook": { "type": "boolean", "description": "The auto publish of the source control. Default is true." }, "securityToken": { "$ref": "#/definitions/SourceControlSecurityTokenProperties", "description": "The authorization token for the repo of the source control." }, "description": { "type": "string", "description": "The user description of the source control." } } }, "SourceType": { "type": "string", "description": "The source type. Must be one of VsoGit, VsoTfvc, GitHub.", "enum": [ "VsoGit", "VsoTfvc", "GitHub" ], "x-ms-enum": { "name": "SourceType", "modelAsString": true, "values": [ { "name": "VsoGit", "value": "VsoGit", "description": "VsoGit" }, { "name": "VsoTfvc", "value": "VsoTfvc", "description": "VsoTfvc" }, { "name": "GitHub", "value": "GitHub", "description": "GitHub" } ] } }, "Statistics": { "type": "object", "description": "Definition of the statistic.", "properties": { "counterProperty": { "type": "string", "description": "Gets the property value of the statistic.", "readOnly": true }, "counterValue": { "type": "integer", "format": "int64", "description": "Gets the value of the statistic.", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "Gets the startTime of the statistic.", "readOnly": true }, "endTime": { "type": "string", "format": "date-time", "description": "Gets the endTime of the statistic.", "x-nullable": true, "readOnly": true }, "id": { "type": "string", "description": "Gets the id.", "readOnly": true } } }, "StatisticsListResult": { "type": "object", "description": "The response model for the list statistics operation.", "properties": { "value": { "type": "array", "description": "Gets or sets a list of statistics.", "items": { "$ref": "#/definitions/Statistics" } }, "nextLink": { "type": "string" } } }, "StreamType": { "type": "string", "description": "The type of the sync job stream.", "enum": [ "Error", "Output" ], "x-ms-enum": { "name": "StreamType", "modelAsString": true, "values": [ { "name": "Error", "value": "Error", "description": "Error" }, { "name": "Output", "value": "Output", "description": "Output" } ] } }, "SyncType": { "type": "string", "description": "The sync type.", "enum": [ "PartialSync", "FullSync" ], "x-ms-enum": { "name": "SyncType", "modelAsString": true, "values": [ { "name": "PartialSync", "value": "PartialSync", "description": "PartialSync" }, { "name": "FullSync", "value": "FullSync", "description": "FullSync" } ] } }, "TagOperators": { "type": "string", "description": "Filter VMs by Any or All specified tags.", "enum": [ "All", "Any" ], "x-ms-enum": { "name": "TagOperators", "modelAsString": false, "values": [ { "name": "All", "value": "All", "description": "All" }, { "name": "Any", "value": "Any", "description": "Any" } ] } }, "TagSettingsProperties": { "type": "object", "description": "Tag filter information for the VM.", "properties": { "tags": { "type": "object", "description": "Dictionary of tags with its list of values.", "additionalProperties": { "items": { "type": "string" }, "type": "array" } }, "filterOperator": { "$ref": "#/definitions/TagOperators", "description": "Filter VMs by Any or All specified tags." } } }, "TargetProperties": { "type": "object", "description": "Group specific to the update configuration.", "properties": { "azureQueries": { "type": "array", "description": "List of Azure queries in the software update configuration.", "items": { "$ref": "#/definitions/AzureQueryProperties" }, "x-ms-identifiers": [] }, "nonAzureQueries": { "type": "array", "description": "List of non Azure queries in the software update configuration.", "items": { "$ref": "#/definitions/NonAzureQueryProperties" }, "x-ms-identifiers": [ "workspaceId" ] } } }, "TestJob": { "type": "object", "description": "Definition of the test job.", "properties": { "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the creation time of the test job." }, "status": { "type": "string", "description": "Gets or sets the status of the test job." }, "statusDetails": { "type": "string", "description": "Gets or sets the status details of the test job." }, "runOn": { "type": "string", "description": "Gets or sets the runOn which specifies the group name where the job is to be executed." }, "startTime": { "type": "string", "format": "date-time", "description": "Gets or sets the start time of the test job.", "x-nullable": true }, "endTime": { "type": "string", "format": "date-time", "description": "Gets or sets the end time of the test job.", "x-nullable": true }, "exception": { "type": "string", "description": "Gets or sets the exception of the test job." }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time of the test job." }, "lastStatusModifiedTime": { "type": "string", "format": "date-time", "description": "Gets or sets the last status modified time of the test job.", "x-nullable": true }, "parameters": { "type": "object", "description": "Gets or sets the parameters of the test job.", "additionalProperties": { "type": "string" } }, "logActivityTrace": { "type": "integer", "format": "int32", "description": "The activity-level tracing options of the runbook." } } }, "TestJobCreateParameters": { "type": "object", "description": "The parameters supplied to the create test job operation.", "properties": { "parameters": { "type": "object", "description": "Gets or sets the parameters of the test job.", "additionalProperties": { "type": "string" } }, "runOn": { "type": "string", "description": "Gets or sets the runOn which specifies the group name where the job is to be executed." }, "runtimeEnvironment": { "type": "string", "description": "The runtime Environment Name on which job needs to be tested" } } }, "TokenType": { "type": "string", "description": "The token type. Must be either PersonalAccessToken or Oauth.", "enum": [ "PersonalAccessToken", "Oauth" ], "x-ms-enum": { "name": "TokenType", "modelAsString": true, "values": [ { "name": "PersonalAccessToken", "value": "PersonalAccessToken", "description": "PersonalAccessToken" }, { "name": "Oauth", "value": "Oauth", "description": "Oauth" } ] } }, "TypeField": { "type": "object", "description": "Information about a field of a type.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the field." }, "type": { "type": "string", "description": "Gets or sets the type of the field." } } }, "TypeFieldListResult": { "type": "object", "description": "The response model for the list fields operation.", "properties": { "value": { "type": "array", "description": "Gets or sets a list of fields.", "items": { "$ref": "#/definitions/TypeField" }, "x-ms-identifiers": [] }, "nextLink": { "type": "string" } } }, "Usage": { "type": "object", "description": "Definition of Usage.", "properties": { "id": { "type": "string", "description": "Gets or sets the id of the resource." }, "name": { "$ref": "#/definitions/UsageCounterName", "description": "Gets or sets the usage counter name." }, "unit": { "type": "string", "description": "Gets or sets the usage unit name." }, "currentValue": { "type": "number", "format": "double", "description": "Gets or sets the current usage value." }, "limit": { "type": "integer", "format": "int64", "description": "Gets or sets max limit. -1 for unlimited" }, "throttleStatus": { "type": "string", "description": "Gets or sets the throttle status." } } }, "UsageCounterName": { "type": "object", "description": "Definition of usage counter name.", "properties": { "value": { "type": "string", "description": "Gets or sets the usage counter name." }, "localizedValue": { "type": "string", "description": "Gets or sets the localized usage counter name." } } }, "UsageListResult": { "type": "object", "description": "The response model for the get usage operation.", "properties": { "value": { "type": "array", "description": "Gets or sets usage.", "items": { "$ref": "#/definitions/Usage" } }, "nextLink": { "type": "string" } } }, "UserAssignedIdentitiesProperties": { "type": "object", "properties": { "principalId": { "type": "string", "description": "The principal id of user assigned identity.", "readOnly": true }, "clientId": { "type": "string", "description": "The client id of user assigned identity.", "readOnly": true } } }, "Variable": { "type": "object", "description": "Definition of the variable.", "properties": { "properties": { "$ref": "#/definitions/VariableProperties", "description": "Gets or sets the properties of the variable.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "VariableCreateOrUpdateParameters": { "type": "object", "description": "The parameters supplied to the create or update variable operation.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the variable." }, "properties": { "$ref": "#/definitions/VariableCreateOrUpdateProperties", "description": "Gets or sets the properties of the variable.", "x-ms-client-flatten": true } }, "required": [ "name", "properties" ] }, "VariableCreateOrUpdateProperties": { "type": "object", "description": "The properties of the create variable operation.", "properties": { "value": { "type": "string", "description": "Gets or sets the value of the variable." }, "description": { "type": "string", "description": "Gets or sets the description of the variable." }, "isEncrypted": { "type": "boolean", "description": "Gets or sets the encrypted flag of the variable." } } }, "VariableListResult": { "type": "object", "description": "The response of a Variable list operation.", "properties": { "value": { "type": "array", "description": "The Variable items on this page", "items": { "$ref": "#/definitions/Variable" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "VariableProperties": { "type": "object", "description": "Definition of the variable properties", "properties": { "value": { "type": "string", "description": "Gets or sets the value of the variable." }, "isEncrypted": { "type": "boolean", "description": "Gets or sets the encrypted flag of the variable.", "x-nullable": true }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the creation time." }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time." }, "description": { "type": "string", "description": "Gets or sets the description." } } }, "VariableUpdateParameters": { "type": "object", "description": "The parameters supplied to the update variable operation.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the variable." }, "properties": { "$ref": "#/definitions/VariableUpdateProperties", "description": "Gets or sets the value of the variable.", "x-ms-client-flatten": true } } }, "VariableUpdateProperties": { "type": "object", "description": "The properties of the update variable", "properties": { "value": { "type": "string", "description": "Gets or sets the value of the variable." }, "description": { "type": "string", "description": "Gets or sets the description of the variable." } } }, "Watcher": { "type": "object", "description": "Definition of the watcher type.", "properties": { "properties": { "$ref": "#/definitions/WatcherProperties", "description": "Gets or sets the watcher properties.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "Gets or sets the etag of the resource." }, "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" }, "x-ms-mutability": [ "read", "update", "create" ] }, "location": { "type": "string", "description": "The geo-location where the resource lives", "x-ms-mutability": [ "read", "create" ] } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "WatcherListResult": { "type": "object", "description": "The response of a Watcher list operation.", "properties": { "value": { "type": "array", "description": "The Watcher items on this page", "items": { "$ref": "#/definitions/Watcher" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "WatcherProperties": { "type": "object", "description": "Definition of the watcher properties", "properties": { "executionFrequencyInSeconds": { "type": "integer", "format": "int64", "description": "Gets or sets the frequency at which the watcher is invoked." }, "scriptName": { "type": "string", "description": "Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook." }, "scriptParameters": { "type": "object", "description": "Gets or sets the parameters of the script.", "additionalProperties": { "type": "string" } }, "scriptRunOn": { "type": "string", "description": "Gets or sets the name of the hybrid worker group the watcher will run on." }, "status": { "type": "string", "description": "Gets the current status of the watcher.", "readOnly": true }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the creation time.", "readOnly": true }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time.", "readOnly": true }, "lastModifiedBy": { "type": "string", "description": "Details of the user who last modified the watcher.", "readOnly": true }, "description": { "type": "string", "description": "Gets or sets the description." } } }, "WatcherUpdateParameters": { "type": "object", "properties": { "properties": { "$ref": "#/definitions/WatcherUpdateProperties", "description": "Gets or sets the watcher update properties.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Gets or sets the name of the resource." } } }, "WatcherUpdateProperties": { "type": "object", "description": "The properties of the update watcher operation.", "properties": { "executionFrequencyInSeconds": { "type": "integer", "format": "int64", "description": "Gets or sets the frequency at which the watcher is invoked." } } }, "Webhook": { "type": "object", "description": "Definition of the webhook type.", "properties": { "properties": { "$ref": "#/definitions/WebhookProperties", "description": "Gets or sets the webhook properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "WebhookCreateOrUpdateParameters": { "type": "object", "description": "The parameters supplied to the create or update webhook operation.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the webhook." }, "properties": { "$ref": "#/definitions/WebhookCreateOrUpdateProperties", "description": "Gets or sets the properties of the webhook.", "x-ms-client-flatten": true } }, "required": [ "name", "properties" ] }, "WebhookCreateOrUpdateProperties": { "type": "object", "description": "The properties of the create webhook operation.", "properties": { "isEnabled": { "type": "boolean", "description": "Gets or sets the value of the enabled flag of webhook." }, "uri": { "type": "string", "description": "Gets or sets the uri." }, "expiryTime": { "type": "string", "format": "date-time", "description": "Gets or sets the expiry time." }, "parameters": { "type": "object", "description": "Gets or sets the parameters of the job.", "additionalProperties": { "type": "string" } }, "runbook": { "$ref": "#/definitions/RunbookAssociationProperty", "description": "Gets or sets the runbook." }, "runOn": { "type": "string", "description": "Gets or sets the name of the hybrid worker group the webhook job will run on." } } }, "WebhookListResult": { "type": "object", "description": "The response of a Webhook list operation.", "properties": { "value": { "type": "array", "description": "The Webhook items on this page", "items": { "$ref": "#/definitions/Webhook" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "WebhookProperties": { "type": "object", "description": "Definition of the webhook properties", "properties": { "isEnabled": { "type": "boolean", "description": "Gets or sets the value of the enabled flag of the webhook." }, "uri": { "type": "string", "description": "Gets or sets the webhook uri." }, "expiryTime": { "type": "string", "format": "date-time", "description": "Gets or sets the expiry time." }, "lastInvokedTime": { "type": "string", "format": "date-time", "description": "Gets or sets the last invoked time.", "x-nullable": true }, "parameters": { "type": "object", "description": "Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with.", "additionalProperties": { "type": "string" } }, "runbook": { "$ref": "#/definitions/RunbookAssociationProperty", "description": "Gets or sets the runbook the webhook is associated with." }, "runOn": { "type": "string", "description": "Gets or sets the name of the hybrid worker group the webhook job will run on." }, "creationTime": { "type": "string", "format": "date-time", "description": "Gets or sets the creation time." }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Gets or sets the last modified time." }, "lastModifiedBy": { "type": "string", "description": "Details of the user who last modified the Webhook" }, "description": { "type": "string", "description": "Gets or sets the description." } } }, "WebhookUpdateParameters": { "type": "object", "description": "The parameters supplied to the update webhook operation.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the webhook." }, "properties": { "$ref": "#/definitions/WebhookUpdateProperties", "description": "Gets or sets the value of the webhook.", "x-ms-client-flatten": true } } }, "WebhookUpdateProperties": { "type": "object", "description": "The properties of the update webhook.", "properties": { "isEnabled": { "type": "boolean", "description": "Gets or sets the value of the enabled flag of webhook." }, "runOn": { "type": "string", "description": "Gets or sets the name of the hybrid worker group the webhook job will run on." }, "parameters": { "type": "object", "description": "Gets or sets the parameters of the job.", "additionalProperties": { "type": "string" } }, "description": { "type": "string", "description": "Gets or sets the description of the webhook." } } }, "WindowsProperties": { "type": "object", "description": "Windows specific update configuration.", "properties": { "includedUpdateClassifications": { "$ref": "#/definitions/WindowsUpdateClasses", "description": "Update classification included in the software update configuration. A comma separated string with required values" }, "excludedKbNumbers": { "type": "array", "description": "KB numbers excluded from the software update configuration.", "items": { "type": "string" } }, "includedKbNumbers": { "type": "array", "description": "KB numbers included from the software update configuration.", "items": { "type": "string" } }, "rebootSetting": { "type": "string", "description": "Reboot setting for the software update configuration." } } }, "WindowsUpdateClasses": { "type": "string", "description": "Update classification included in the software update configuration. A comma separated string with required values", "enum": [ "Unclassified", "Critical", "Security", "UpdateRollup", "FeaturePack", "ServicePack", "Definition", "Tools", "Updates" ], "x-ms-enum": { "name": "WindowsUpdateClasses", "modelAsString": true, "values": [ { "name": "Unclassified", "value": "Unclassified", "description": "Unclassified" }, { "name": "Critical", "value": "Critical", "description": "Critical" }, { "name": "Security", "value": "Security", "description": "Security" }, { "name": "UpdateRollup", "value": "UpdateRollup", "description": "UpdateRollup" }, { "name": "FeaturePack", "value": "FeaturePack", "description": "FeaturePack" }, { "name": "ServicePack", "value": "ServicePack", "description": "ServicePack" }, { "name": "Definition", "value": "Definition", "description": "Definition" }, { "name": "Tools", "value": "Tools", "description": "Tools" }, { "name": "Updates", "value": "Updates", "description": "Updates" } ] } }, "WorkerType": { "type": "string", "description": "Type of the HybridWorker.", "enum": [ "HybridV1", "HybridV2" ], "x-ms-enum": { "name": "WorkerType", "modelAsString": true, "values": [ { "name": "HybridV1", "value": "HybridV1", "description": "HybridV1" }, { "name": "HybridV2", "value": "HybridV2", "description": "HybridV2" } ] } }, "jobNavigation": { "type": "object", "description": "Software update configuration machine run job navigation properties.", "properties": { "id": { "type": "string", "description": "Id of the job associated with the software update configuration run", "readOnly": true } } }, "softwareUpdateConfiguration": { "type": "object", "description": "Software update configuration properties.", "properties": { "properties": { "$ref": "#/definitions/softwareUpdateConfigurationProperties", "description": "Software update configuration properties.", "x-ms-client-flatten": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "softwareUpdateConfigurationCollectionItem": { "type": "object", "description": "Software update configuration collection item properties.", "properties": { "name": { "type": "string", "description": "Name of the software update configuration.", "readOnly": true }, "id": { "type": "string", "description": "Resource Id of the software update configuration", "readOnly": true }, "properties": { "$ref": "#/definitions/softwareUpdateConfigurationCollectionItemProperties", "description": "Software update configuration properties.", "x-ms-client-flatten": true } }, "required": [ "properties" ] }, "softwareUpdateConfigurationCollectionItemProperties": { "type": "object", "description": "Software update configuration collection item properties.", "properties": { "updateConfiguration": { "$ref": "#/definitions/updateConfiguration", "description": "Update specific properties of the software update configuration." }, "tasks": { "$ref": "#/definitions/softwareUpdateConfigurationTasks", "description": "Pre and Post Tasks defined" }, "frequency": { "$ref": "#/definitions/ScheduleFrequency", "description": "execution frequency of the schedule associated with the software update configuration" }, "startTime": { "type": "string", "format": "date-time", "description": "the start time of the update." }, "creationTime": { "type": "string", "format": "date-time", "description": "Creation time of the software update configuration, which only appears in the response.", "readOnly": true }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Last time software update configuration was modified, which only appears in the response.", "readOnly": true }, "provisioningState": { "type": "string", "description": "Provisioning state for the software update configuration, which only appears in the response.", "readOnly": true }, "nextRun": { "type": "string", "format": "date-time", "description": "ext run time of the update.", "x-nullable": true } } }, "softwareUpdateConfigurationListResult": { "type": "object", "description": "result of listing all software update configuration", "properties": { "value": { "type": "array", "description": "outer object returned when listing all software update configurations", "items": { "$ref": "#/definitions/softwareUpdateConfigurationCollectionItem" } } } }, "softwareUpdateConfigurationMachineRun": { "type": "object", "description": "Software update configuration machine run model.", "properties": { "name": { "type": "string", "description": "Name of the software update configuration machine run", "readOnly": true }, "id": { "type": "string", "description": "Resource Id of the software update configuration machine run", "readOnly": true }, "properties": { "$ref": "#/definitions/updateConfigurationMachineRunProperties", "description": "Software update configuration machine run properties.", "x-ms-client-flatten": true } } }, "softwareUpdateConfigurationMachineRunListResult": { "type": "object", "description": "result of listing all software update configuration machine runs", "properties": { "value": { "type": "array", "description": "The softwareUpdateConfigurationMachineRun items on this page", "items": { "$ref": "#/definitions/softwareUpdateConfigurationMachineRun" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "softwareUpdateConfigurationProperties": { "type": "object", "description": "Software update configuration properties.", "properties": { "updateConfiguration": { "$ref": "#/definitions/updateConfiguration", "description": "update specific properties for the Software update configuration" }, "scheduleInfo": { "$ref": "#/definitions/SUCScheduleProperties", "description": "Schedule information for the Software update configuration" }, "provisioningState": { "type": "string", "description": "Provisioning state for the software update configuration, which only appears in the response.", "readOnly": true }, "error": { "$ref": "#/definitions/AutomationErrorResponse", "description": "Details of provisioning error" }, "creationTime": { "type": "string", "format": "date-time", "description": "Creation time of the resource, which only appears in the response.", "readOnly": true }, "createdBy": { "type": "string", "description": "CreatedBy property, which only appears in the response.", "readOnly": true }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Last time resource was modified, which only appears in the response.", "readOnly": true }, "lastModifiedBy": { "type": "string", "description": "LastModifiedBy property, which only appears in the response.", "readOnly": true }, "tasks": { "$ref": "#/definitions/softwareUpdateConfigurationTasks", "description": "Tasks information for the Software update configuration." } }, "required": [ "updateConfiguration", "scheduleInfo" ] }, "softwareUpdateConfigurationRun": { "type": "object", "description": "Software update configuration Run properties.", "properties": { "name": { "type": "string", "description": "Name of the software update configuration run.", "readOnly": true }, "id": { "type": "string", "description": "Resource Id of the software update configuration run", "readOnly": true }, "properties": { "$ref": "#/definitions/softwareUpdateConfigurationRunProperties", "description": "Software update configuration Run properties.", "x-ms-client-flatten": true } } }, "softwareUpdateConfigurationRunListResult": { "type": "object", "description": "result of listing all software update configuration runs", "properties": { "value": { "type": "array", "description": "The softwareUpdateConfigurationRun items on this page", "items": { "$ref": "#/definitions/softwareUpdateConfigurationRun" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "softwareUpdateConfigurationRunProperties": { "type": "object", "description": "Software update configuration properties.", "properties": { "softwareUpdateConfiguration": { "$ref": "#/definitions/updateConfigurationNavigation", "description": "software update configuration triggered this run" }, "status": { "type": "string", "description": "Status of the software update configuration run.", "readOnly": true }, "configuredDuration": { "type": "string", "description": "Configured duration for the software update configuration run.", "readOnly": true }, "osType": { "type": "string", "description": "Operating system target of the software update configuration triggered this run", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "Start time of the software update configuration run.", "readOnly": true }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the software update configuration run.", "x-nullable": true, "readOnly": true }, "computerCount": { "type": "integer", "format": "int32", "description": "Number of computers in the software update configuration run.", "readOnly": true }, "failedCount": { "type": "integer", "format": "int32", "description": "Number of computers with failed status.", "readOnly": true }, "creationTime": { "type": "string", "format": "date-time", "description": "Creation time of the resource, which only appears in the response.", "readOnly": true }, "createdBy": { "type": "string", "description": "CreatedBy property, which only appears in the response.", "readOnly": true }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Last time resource was modified, which only appears in the response.", "readOnly": true }, "lastModifiedBy": { "type": "string", "description": "LastModifiedBy property, which only appears in the response.", "readOnly": true }, "tasks": { "$ref": "#/definitions/softwareUpdateConfigurationRunTasks", "description": "Software update configuration tasks triggered in this run" } } }, "softwareUpdateConfigurationRunTaskProperties": { "type": "object", "description": "Task properties of the software update configuration.", "properties": { "status": { "type": "string", "description": "The status of the task." }, "source": { "type": "string", "description": "The name of the source of the task." }, "jobId": { "type": "string", "description": "The job id of the task." } } }, "softwareUpdateConfigurationRunTasks": { "type": "object", "description": "Software update configuration run tasks model.", "properties": { "preTask": { "$ref": "#/definitions/softwareUpdateConfigurationRunTaskProperties", "description": "Pre task properties." }, "postTask": { "$ref": "#/definitions/softwareUpdateConfigurationRunTaskProperties", "description": "Post task properties." } } }, "softwareUpdateConfigurationTasks": { "type": "object", "description": "Task properties of the software update configuration.", "properties": { "preTask": { "$ref": "#/definitions/taskProperties", "description": "Pre task properties." }, "postTask": { "$ref": "#/definitions/taskProperties", "description": "Post task properties." } } }, "taskProperties": { "type": "object", "description": "Task properties of the software update configuration.", "properties": { "parameters": { "type": "object", "description": "Gets or sets the parameters of the task.", "additionalProperties": { "type": "string" } }, "source": { "type": "string", "description": "Gets or sets the name of the runbook." } } }, "updateConfiguration": { "type": "object", "description": "Update specific properties of the software update configuration.", "properties": { "operatingSystem": { "$ref": "#/definitions/OperatingSystemType", "description": "operating system of target machines" }, "windows": { "$ref": "#/definitions/WindowsProperties", "description": "Windows specific update configuration." }, "linux": { "$ref": "#/definitions/LinuxProperties", "description": "Linux specific update configuration." }, "duration": { "type": "string", "format": "duration", "description": "Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601" }, "azureVirtualMachines": { "type": "array", "description": "List of azure resource Ids for azure virtual machines targeted by the software update configuration.", "items": { "type": "string" } }, "nonAzureComputerNames": { "type": "array", "description": "List of names of non-azure machines targeted by the software update configuration.", "items": { "type": "string" } }, "targets": { "$ref": "#/definitions/TargetProperties", "description": "Group targets for the software update configuration." } }, "required": [ "operatingSystem" ] }, "updateConfigurationMachineRunProperties": { "type": "object", "description": "Software update configuration machine run properties.", "properties": { "targetComputer": { "type": "string", "description": "name of the updated computer", "readOnly": true }, "targetComputerType": { "type": "string", "description": "type of the updated computer.", "readOnly": true }, "softwareUpdateConfiguration": { "$ref": "#/definitions/updateConfigurationNavigation", "description": "software update configuration triggered this run" }, "status": { "type": "string", "description": "Status of the software update configuration machine run.", "readOnly": true }, "osType": { "type": "string", "description": "Operating system target of the software update configuration triggered this run", "readOnly": true }, "correlationId": { "type": "string", "format": "uuid", "description": "correlation id of the software update configuration machine run", "readOnly": true }, "sourceComputerId": { "type": "string", "format": "uuid", "description": "source computer id of the software update configuration machine run", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "Start time of the software update configuration machine run.", "readOnly": true }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the software update configuration machine run.", "x-nullable": true, "readOnly": true }, "configuredDuration": { "type": "string", "description": "configured duration for the software update configuration run.", "readOnly": true }, "job": { "$ref": "#/definitions/jobNavigation", "description": "Job associated with the software update configuration machine run" }, "creationTime": { "type": "string", "format": "date-time", "description": "Creation time of the resource, which only appears in the response.", "readOnly": true }, "createdBy": { "type": "string", "description": "createdBy property, which only appears in the response.", "readOnly": true }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Last time resource was modified, which only appears in the response.", "readOnly": true }, "lastModifiedBy": { "type": "string", "description": "lastModifiedBy property, which only appears in the response.", "readOnly": true }, "error": { "$ref": "#/definitions/AutomationErrorResponse", "description": "Details of provisioning error" } } }, "updateConfigurationNavigation": { "type": "object", "description": "Software update configuration Run Navigation model.", "properties": { "name": { "type": "string", "description": "Name of the software update configuration triggered the software update configuration run", "readOnly": true } } } }, "parameters": {} }