swagger: '2.0' info: version: 2021-02-01-preview title: Microsoft Azure adp description: Microsoft Autonomous Development Platform host: management.azure.com schemes: - https consumes: - application/json produces: - application/json security: - azure_auth: - user_impersonation securityDefinitions: azure_auth: type: oauth2 authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize flow: implicit description: Azure Active Directory OAuth2 Flow scopes: user_impersonation: impersonate your user account paths: /providers/Microsoft.AutonomousDevelopmentPlatform/operations: get: tags: - Operations description: >- Lists all of the available Autonomous Development Platform provider operations operationId: microsoftAzureOperationsList x-ms-examples: List operations: $ref: ./examples/AdpOperationsList.json parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/OperationListResult' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers Microsoft Autonomousdevelopmentplatform Operations /subscriptions/{subscriptionId}/providers/Microsoft.AutonomousDevelopmentPlatform/checkNameAvailability: post: tags: - Accounts operationId: microsoftAzureAccountsChecknameavailability description: Checks that the account name is valid and is not already in use x-ms-examples: AccountCheckNameAvailability: $ref: ./examples/AdpAccountCheckNameAvailability.json parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - name: parameters in: body required: true schema: $ref: '#/definitions/AccountCheckNameAvailabilityParameters' description: The checkNameAvailability parameters. responses: '200': description: >- OK -- Operation to check the account name availability was successful schema: $ref: '#/definitions/CheckNameAvailabilityResult' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Autonomousdevelopmentplatform Checknameavailability /subscriptions/{subscriptionId}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts: get: tags: - Accounts operationId: microsoftAzureAccountsList description: List all ADP accounts available under the subscription x-ms-examples: List accounts: $ref: ./examples/AdpAccountsList.json parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/AccountList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Autonomousdevelopmentplatform Accounts ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts : get: tags: - Accounts operationId: microsoftAzureAccountsListbyresourcegroup description: List all ADP accounts available under the resource group x-ms-examples: List accounts by resource group: $ref: ./examples/AdpAccountsListByResourceGroup.json parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/AccountList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Autonomousdevelopmentplatform Accounts ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/{accountName} : get: tags: - Accounts operationId: microsoftAzureAccountsGet description: Gets the properties of an ADP account parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AccountNameParameter' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: The ADP account properties were retrieved successfully schema: $ref: '#/definitions/Account' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Get account: $ref: ./examples/AdpAccountGet.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Autonomousdevelopmentplatform Accounts Accountname patch: tags: - Accounts operationId: microsoftAzureAccountsUpdate x-ms-long-running-operation: true description: Updates the properties of an existing ADP account parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AccountNameParameter' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: The parameters to provide for the current ADP account schema: $ref: '#/definitions/AccountPatch' responses: '200': description: The resource was updated successfully schema: $ref: '#/definitions/Account' '201': description: The resource will be updated asynchronously schema: $ref: '#/definitions/Account' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Patch account: $ref: ./examples/AdpAccountPatch.json summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Autonomousdevelopmentplatform Accounts Accountname put: tags: - Accounts operationId: microsoftAzureAccountsCreateorupdate description: Creates or updates an ADP account x-ms-long-running-operation: true parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AccountNameParameter' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: The parameters to provide for the ADP account schema: $ref: '#/definitions/Account' responses: '200': description: The ADP account was successfully updated schema: $ref: '#/definitions/Account' '201': description: The resource will be updated asynchronously schema: $ref: '#/definitions/Account' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Put account: $ref: ./examples/AdpAccountPut.json summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Autonomousdevelopmentplatform Accounts Accountname delete: tags: - Accounts operationId: microsoftAzureAccountsDelete description: Deletes an ADP account x-ms-long-running-operation: true parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AccountNameParameter' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: The ADP account was successfully deleted '202': description: The ADP account will be deleted asynchronously '204': description: The ADP account does not exist default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Delete account: $ref: ./examples/AdpAccountDelete.json summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Autonomousdevelopmentplatform Accounts Accountname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/{accountName}/dataPools : get: tags: - DataPools operationId: microsoftAzureDatapoolsList description: Lists the data pools under the ADP account parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AccountNameParameter' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: The list of data pools that was successfully retrieved schema: $ref: '#/definitions/DataPoolList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-examples: List Data Pools: $ref: ./examples/AdpDataPoolsList.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Autonomousdevelopmentplatform Accounts Accountname Datapools ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/{accountName}/dataPools/{dataPoolName} : get: tags: - DataPools operationId: microsoftAzureDatapoolsGet description: Gets the properties of a Data Pool parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AccountNameParameter' - $ref: '#/parameters/DataPoolNameParameter' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: The Data Pool that was successfully retrieved schema: $ref: '#/definitions/DataPool' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Get Data Pool: $ref: ./examples/AdpDataPoolGet.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Autonomousdevelopmentplatform Accounts Accountname Datapools Datapoolname patch: tags: - DataPools operationId: microsoftAzureDatapoolsUpdate description: Updates the properties of an existing Data Pool x-ms-long-running-operation: true parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AccountNameParameter' - $ref: '#/parameters/DataPoolNameParameter' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: The parameters to provide for the Data Pool schema: $ref: '#/definitions/DataPoolPatch' responses: '200': description: The Data Pool was updated successfully schema: $ref: '#/definitions/DataPool' '201': description: The Data Pool will be updated asynchronously schema: $ref: '#/definitions/DataPool' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Patch Data Pool: $ref: ./examples/AdpDataPoolPatch.json summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Autonomousdevelopmentplatform Accounts Accountname Datapools Datapoolname put: tags: - DataPools operationId: microsoftAzureDatapoolsCreateorupdate description: Creates or updates a Data Pool x-ms-long-running-operation: true parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AccountNameParameter' - $ref: '#/parameters/DataPoolNameParameter' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: The parameters to provide for the Data Pool schema: $ref: '#/definitions/DataPool' responses: '200': description: The Data Pool was successfully updated schema: $ref: '#/definitions/DataPool' '201': description: The Data Pool will be updated asynchronously schema: $ref: '#/definitions/DataPool' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Put Data Pool: $ref: ./examples/AdpDataPoolPut.json summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Autonomousdevelopmentplatform Accounts Accountname Datapools Datapoolname delete: tags: - DataPools operationId: microsoftAzureDatapoolsDelete description: Deletes a Data Pool x-ms-long-running-operation: true parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AccountNameParameter' - $ref: '#/parameters/DataPoolNameParameter' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: The Data Pool was successfully deleted '202': description: The Data Pool will be deleted asynchronously '204': description: The Data Pool does not exist default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Delete Data Pool: $ref: ./examples/AdpDataPoolDelete.json summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Autonomousdevelopmentplatform Accounts Accountname Datapools Datapoolname definitions: AccountCheckNameAvailabilityParameters: properties: name: type: string description: The account name pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)* type: type: string enum: - Microsoft.AutonomousDevelopmentPlatform/accounts x-ms-enum: name: Type modelAsString: true description: The type of resource, Microsoft.AutonomousDevelopmentPlatform/accounts required: - name - type description: The parameters used to check the availability of the account name CheckNameAvailabilityResult: description: The checkNameAvailability operation response properties: nameAvailable: readOnly: true type: boolean description: >- Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used reason: readOnly: true type: string description: >- Gets the reason that an account name could not be used. The reason element is only returned if nameAvailable is false enum: - Invalid - AlreadyExists x-ms-enum: name: CheckNameAvailabilityReason modelAsString: true message: readOnly: true type: string description: Gets an error message explaining the reason value in more detail Tags: type: object description: Resource tags properties: tags: type: object additionalProperties: type: string x-ms-mutability: - read - create - update description: Resource tags Account: type: object description: ADP account properties: properties: description: List of account properties type: object x-ms-client-flatten: true $ref: '#/definitions/AccountProperties' systemData: readOnly: true description: The system meta data relating to this resource $ref: >- ../../../../../common-types/resource-management/v1/types.json#/definitions/systemData allOf: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource AccountPatch: type: object description: ADP account properties: properties: description: List of account properties type: object x-ms-client-flatten: true $ref: '#/definitions/AccountProperties' allOf: - $ref: '#/definitions/Tags' AccountProperties: type: object description: ADP account properties properties: accountId: description: The account's data-plane ID type: string readOnly: true provisioningState: readOnly: true type: string description: Gets the status of the account at the time the operation was called enum: - Succeeded - Failed - Canceled - Accepted - Provisioning - Deleting x-ms-enum: name: ProvisioningState modelAsString: true AccountList: type: object description: >- The list operation response, that contains the data pools and their properties properties: value: readOnly: true type: array items: $ref: '#/definitions/Account' description: List of accounts and their properties nextLink: type: string description: URL to get the next set of operation list results if there are any DataPool: type: object description: ADP Data Pool properties: properties: description: List of data pool properties type: object x-ms-client-flatten: true $ref: '#/definitions/DataPoolProperties' allOf: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/definitions/Resource DataPoolPatch: type: object description: ADP Data Pool properties: properties: description: List of data pool properties type: object x-ms-client-flatten: true $ref: '#/definitions/DataPoolBaseProperties' allOf: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/definitions/Resource DataPoolBaseProperties: type: object description: Data Pool properties properties: dataPoolId: description: The Data Pool's data-plane ID type: string readOnly: true provisioningState: readOnly: true type: string description: Gets the status of the data pool at the time the operation was called enum: - Succeeded - Failed - Canceled - Accepted - Provisioning - Deleting x-ms-enum: name: ProvisioningState modelAsString: true locations: type: array items: $ref: '#/definitions/DataPoolLocation' description: >- Gets or sets the collection of locations where Data Pool resources should be created systemData: readOnly: true description: The system meta data relating to this resource $ref: >- ../../../../../common-types/resource-management/v1/types.json#/definitions/systemData DataPoolProperties: type: object description: Data Pool properties allOf: - $ref: '#/definitions/DataPoolBaseProperties' required: - locations DataPoolLocation: type: object description: Location of a Data Pool properties: name: description: The location name type: string encryption: description: Encryption properties of a Data Pool location $ref: '#/definitions/DataPoolEncryption' required: - name DataPoolEncryption: type: object description: Encryption properties of a Data Pool properties: keyVaultUri: type: string description: >- The URI of a soft delete-enabled Key Vault that is in the same location as the Data Pool location keyName: type: string description: The name of Key Vault key keyVersion: type: string description: The version of Key Vault key userAssignedIdentity: type: string description: >- The resource ID of a user-assigned Managed Identity used to access the encryption key in the Key Vault. Requires access to the key operations get, wrap, unwrap, and recover required: - keyVaultUri - keyName - userAssignedIdentity DataPoolList: type: object properties: value: readOnly: true type: array items: $ref: '#/definitions/DataPool' description: List of data pools and their properties nextLink: type: string description: URL to get the next set of operation list results if there are any description: >- The list operation response, that contains the data pools and their properties Operation: type: object description: Operation detail payload properties: name: description: Name of the operation type: string isDataAction: description: Indicates whether the operation is a data action type: boolean actionType: description: Indicates the action type type: string display: $ref: '#/definitions/OperationDisplay' description: Display of the operation origin: description: Origin of the operation type: string properties: $ref: '#/definitions/OperationProperties' description: Properties of the operation x-ms-client-flatten: true OperationDisplay: type: object description: Operation display payload properties: provider: description: Resource provider of the operation type: string resource: description: Resource of the operation type: string operation: description: Localized friendly name for the operation type: string description: description: Localized friendly description for the operation type: string OperationProperties: type: object description: Additional details about an operation x-ms-client-flatten: true properties: serviceSpecification: description: Details about a service operation $ref: '#/definitions/OperationServiceSpecification' OperationServiceSpecification: type: object description: Details about a service operation properties: logSpecifications: description: Details about operations related to logs type: array items: $ref: '#/definitions/OperationLogSpecification' metricSpecifications: description: Details about operations related to metrics type: array items: $ref: '#/definitions/OperationMetricSpecification' OperationLogSpecification: type: object description: Details about an operation related to logs properties: name: description: The name of the log category type: string displayName: description: Localized display name type: string blobDuration: description: Blobs created in the customer storage account, per hour type: string OperationMetricSpecification: type: object description: Details about an operation related to metrics properties: name: description: The name of the metric type: string displayName: description: Localized display name of the metric type: string displayDescription: description: The description of the metric type: string unit: description: The unit that the metric is measured in type: string aggregationType: description: The type of metric aggregation type: string enableRegionalMdmAccount: description: Whether or not the service is using regional MDM accounts type: string sourceMdmAccount: description: The name of the MDM account type: string sourceMdmNamespace: description: The name of the MDM namespace type: string availabilities: description: Defines how often data for metrics becomes available type: array items: $ref: '#/definitions/OperationMetricAvailability' OperationMetricAvailability: type: object description: Defines how often data for a metric becomes available properties: timeGrain: description: The granularity for the metric type: string blobDuration: description: Blob created in the customer storage account, per hour type: string OperationListResult: type: object description: Available operations of the service properties: value: type: array items: $ref: '#/definitions/Operation' description: List of operations supported by the Resource Provider nextLink: type: string description: URL to get the next set of operation list results if there are any ErrorResponse: type: object description: Error response properties: error: $ref: '#/definitions/ErrorDefinition' description: The error details ErrorDefinition: type: object description: Error definition properties: code: description: >- Service specific error code which serves as the substatus for the HTTP error code type: string readOnly: true message: description: Description of the error type: string readOnly: true details: description: Internal error details type: array items: $ref: '#/definitions/ErrorDefinition' readOnly: true parameters: AccountNameParameter: name: accountName in: path required: true type: string description: The name of the ADP account pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)* maxLength: 50 x-ms-parameter-location: method DataPoolNameParameter: name: dataPoolName in: path required: true type: string description: The name of the Data Pool pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)* maxLength: 50 x-ms-parameter-location: method tags: - name: Accounts - name: DataPools - name: Operations