swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Accounts API schemes: - https tags: - name: Accounts paths: /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}/providers/Microsoft.CognitiveServices/accounts: get: operationId: Accounts_List summary: Microsoft Azure List Cognitive Services Accounts description: Returns all the Cognitive Services accounts in a subscription. tags: - Accounts parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: Successfully returned the list of accounts. content: application/json: schema: $ref: '#/components/schemas/AccountListResult' examples: AccountsList200Example: summary: Default Accounts_List 200 response x-microcks-default: true value: value: - id: abc123 name: Example Title type: example_value etag: example_value kind: example_value location: example_value tags: example_value nextLink: example_value default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: AccountsListdefaultExample: summary: Default Accounts_List default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value additionalInfo: - type: example_value info: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts: get: operationId: Accounts_ListByResourceGroup summary: Microsoft Azure List Accounts by Resource Group description: Returns all Cognitive Services accounts in a resource group. tags: - Accounts parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: Successfully returned the list of accounts. content: application/json: schema: $ref: '#/components/schemas/AccountListResult' examples: AccountsListbyresourcegroup200Example: summary: Default Accounts_ListByResourceGroup 200 response x-microcks-default: true value: value: - id: abc123 name: Example Title type: example_value etag: example_value kind: example_value location: example_value tags: example_value nextLink: example_value default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: AccountsListbyresourcegroupdefaultExample: summary: Default Accounts_ListByResourceGroup default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value additionalInfo: - type: example_value info: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName} : get: operationId: Accounts_Get summary: Microsoft Azure Get a Cognitive Services Account description: Returns a Cognitive Services account specified by the parameters. tags: - Accounts parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/AccountNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: Successfully returned the account. content: application/json: schema: $ref: '#/components/schemas/Account' examples: AccountsGet200Example: summary: Default Accounts_Get 200 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value etag: example_value kind: example_value sku: name: Example Title tier: Free identity: principalId: '500123' tenantId: '500123' type: None userAssignedIdentities: example_value location: example_value tags: example_value properties: provisioningState: Accepted endpoint: example_value endpoints: example_value capabilities: - {} isMigrated: true dateCreated: example_value customSubDomainName: example_value publicNetworkAccess: Enabled disableLocalAuth: true restrictOutboundNetworkAccess: true default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: AccountsGetdefaultExample: summary: Default Accounts_Get default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value additionalInfo: - type: example_value info: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: Accounts_Create summary: Microsoft Azure Create or Update a Cognitive Services Account description: Creates a Cognitive Services account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. tags: - Accounts parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/AccountNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Account' examples: AccountsCreateRequestExample: summary: Default Accounts_Create request x-microcks-default: true value: id: abc123 name: Example Title type: example_value etag: example_value kind: example_value sku: name: Example Title tier: Free identity: principalId: '500123' tenantId: '500123' type: None userAssignedIdentities: example_value location: example_value tags: example_value properties: provisioningState: Accepted endpoint: example_value endpoints: example_value capabilities: - {} isMigrated: true dateCreated: example_value customSubDomainName: example_value publicNetworkAccess: Enabled disableLocalAuth: true restrictOutboundNetworkAccess: true responses: '200': description: Successfully updated the account. content: application/json: schema: $ref: '#/components/schemas/Account' examples: AccountsCreate200Example: summary: Default Accounts_Create 200 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value etag: example_value kind: example_value sku: name: Example Title tier: Free identity: principalId: '500123' tenantId: '500123' type: None userAssignedIdentities: example_value location: example_value tags: example_value properties: provisioningState: Accepted endpoint: example_value endpoints: example_value capabilities: - {} isMigrated: true dateCreated: example_value customSubDomainName: example_value publicNetworkAccess: Enabled disableLocalAuth: true restrictOutboundNetworkAccess: true '201': description: Successfully created the account. content: application/json: schema: $ref: '#/components/schemas/Account' examples: AccountsCreate201Example: summary: Default Accounts_Create 201 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value etag: example_value kind: example_value sku: name: Example Title tier: Free identity: principalId: '500123' tenantId: '500123' type: None userAssignedIdentities: example_value location: example_value tags: example_value properties: provisioningState: Accepted endpoint: example_value endpoints: example_value capabilities: - {} isMigrated: true dateCreated: example_value customSubDomainName: example_value publicNetworkAccess: Enabled disableLocalAuth: true restrictOutboundNetworkAccess: true '202': description: Accepted. The account creation is in progress. content: application/json: schema: $ref: '#/components/schemas/Account' examples: AccountsCreate202Example: summary: Default Accounts_Create 202 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value etag: example_value kind: example_value sku: name: Example Title tier: Free identity: principalId: '500123' tenantId: '500123' type: None userAssignedIdentities: example_value location: example_value tags: example_value properties: provisioningState: Accepted endpoint: example_value endpoints: example_value capabilities: - {} isMigrated: true dateCreated: example_value customSubDomainName: example_value publicNetworkAccess: Enabled disableLocalAuth: true restrictOutboundNetworkAccess: true default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: AccountsCreatedefaultExample: summary: Default Accounts_Create default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value additionalInfo: - type: example_value info: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: Accounts_Delete summary: Microsoft Azure Delete a Cognitive Services Account description: Deletes a Cognitive Services account from the resource group. tags: - Accounts parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/AccountNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: Successfully deleted the account. '202': description: Accepted. The account deletion is in progress. '204': description: The account does not exist. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: AccountsDeletedefaultExample: summary: Default Accounts_Delete default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value additionalInfo: - type: example_value info: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: Accounts_Update summary: Microsoft Azure Update a Cognitive Services Account description: Updates a Cognitive Services account. tags: - Accounts parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/AccountNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Account' examples: AccountsUpdateRequestExample: summary: Default Accounts_Update request x-microcks-default: true value: id: abc123 name: Example Title type: example_value etag: example_value kind: example_value sku: name: Example Title tier: Free identity: principalId: '500123' tenantId: '500123' type: None userAssignedIdentities: example_value location: example_value tags: example_value properties: provisioningState: Accepted endpoint: example_value endpoints: example_value capabilities: - {} isMigrated: true dateCreated: example_value customSubDomainName: example_value publicNetworkAccess: Enabled disableLocalAuth: true restrictOutboundNetworkAccess: true responses: '200': description: Successfully updated the account. content: application/json: schema: $ref: '#/components/schemas/Account' examples: AccountsUpdate200Example: summary: Default Accounts_Update 200 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value etag: example_value kind: example_value sku: name: Example Title tier: Free identity: principalId: '500123' tenantId: '500123' type: None userAssignedIdentities: example_value location: example_value tags: example_value properties: provisioningState: Accepted endpoint: example_value endpoints: example_value capabilities: - {} isMigrated: true dateCreated: example_value customSubDomainName: example_value publicNetworkAccess: Enabled disableLocalAuth: true restrictOutboundNetworkAccess: true '202': description: Accepted. The account update is in progress. content: application/json: schema: $ref: '#/components/schemas/Account' examples: AccountsUpdate202Example: summary: Default Accounts_Update 202 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value etag: example_value kind: example_value sku: name: Example Title tier: Free identity: principalId: '500123' tenantId: '500123' type: None userAssignedIdentities: example_value location: example_value tags: example_value properties: provisioningState: Accepted endpoint: example_value endpoints: example_value capabilities: - {} isMigrated: true dateCreated: example_value customSubDomainName: example_value publicNetworkAccess: Enabled disableLocalAuth: true restrictOutboundNetworkAccess: true default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: AccountsUpdatedefaultExample: summary: Default Accounts_Update default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value additionalInfo: - type: example_value info: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/listKeys : post: operationId: Accounts_ListKeys summary: Microsoft Azure List Account Keys description: Lists the account keys for the specified Cognitive Services account. tags: - Accounts parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/AccountNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: Successfully returned the account keys. content: application/json: schema: $ref: '#/components/schemas/ApiKeys' examples: AccountsListkeys200Example: summary: Default Accounts_ListKeys 200 response x-microcks-default: true value: key1: example_value key2: example_value default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: AccountsListkeysdefaultExample: summary: Default Accounts_ListKeys default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value additionalInfo: - type: example_value info: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/regenerateKey : post: operationId: Accounts_RegenerateKey summary: Microsoft Azure Regenerate an Account Key description: Regenerates the specified account key for the Cognitive Services account. tags: - Accounts parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/AccountNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' requestBody: required: true content: application/json: schema: type: object properties: keyName: type: string enum: - Key1 - Key2 description: Key name to regenerate. required: - keyName examples: AccountsRegeneratekeyRequestExample: summary: Default Accounts_RegenerateKey request x-microcks-default: true value: keyName: Key1 responses: '200': description: Successfully regenerated the key. content: application/json: schema: $ref: '#/components/schemas/ApiKeys' examples: AccountsRegeneratekey200Example: summary: Default Accounts_RegenerateKey 200 response x-microcks-default: true value: key1: example_value key2: example_value default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: AccountsRegeneratekeydefaultExample: summary: Default Accounts_RegenerateKey default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value additionalInfo: - type: example_value info: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}: put: tags: - Accounts description: Create or update a Maps Account. A Maps Account holds the keys which allow access to the Maps REST APIs. operationId: microsoftAzureAccountsCreateorupdate x-ms-examples: Create Gen2 Account: $ref: ./examples/CreateAccountGen2.json Create Account with Managed Identities: $ref: ./examples/CreateAccountManagedIdentity.json Create Account with Encryption: $ref: ./examples/CreateAccountEncryption.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/AccountNameParameter_2' - name: MapsAccount in: body description: The new or updated parameters for the Maps Account. required: true schema: $ref: '#/definitions/MapsAccount' responses: '200': description: The Account was successfully updated. schema: $ref: '#/definitions/MapsAccount' '201': description: The Account was successfully created. schema: $ref: '#/definitions/MapsAccount' default: description: An error occurred during creating or updating the Account. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Maps Accounts Accountname patch: tags: - Accounts description: Updates a Maps Account. Only a subset of the parameters may be updated after creation, such as Sku, Tags, Properties. operationId: microsoftAzureAccountsUpdate x-ms-examples: Update Account Tags: $ref: ./examples/UpdateAccount.json Update to Gen2 Account: $ref: ./examples/UpdateAccountGen2.json Update Account Managed Identities: $ref: ./examples/UpdateAccountManagedIdentity.json Update Account Encryption: $ref: ./examples/UpdateAccountEncryption.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/AccountNameParameter_2' - name: MapsAccountUpdateParameters in: body description: The updated parameters for the Maps Account. required: true schema: $ref: '#/definitions/MapsAccountUpdateParameters' responses: '200': description: The Account was successfully updated. schema: $ref: '#/definitions/MapsAccount' default: description: An error occurred during creating or updating the Account. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Maps Accounts Accountname delete: tags: - Accounts description: Delete a Maps Account. operationId: microsoftAzureAccountsDelete x-ms-examples: DeleteAccount: $ref: ./examples/DeleteAccount.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/AccountNameParameter_2' responses: '200': description: The Account was deleted successfully. '204': description: The specified Account was not found. Nothing was deleted. default: description: An unexpected error occurred. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Maps Accounts Accountname get: tags: - Accounts description: Get a Maps Account. operationId: microsoftAzureAccountsGet x-ms-examples: GetAccount: $ref: ./examples/GetAccount.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/AccountNameParameter_2' responses: '200': description: The request was successful. schema: $ref: '#/definitions/MapsAccount' default: description: An unexpected error occurred. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Maps Accounts Accountname /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts: get: tags: - Accounts description: Get all Maps Accounts in a Resource Group operationId: microsoftAzureAccountsListbyresourcegroup x-ms-examples: List Accounts By Resource Group: $ref: ./examples/ListAccountsByResourceGroup.json x-ms-pageable: nextLinkName: nextLink parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: The request was successful. schema: $ref: '#/definitions/MapsAccounts' default: description: An unexpected error occurred. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Maps Accounts /subscriptions/{subscriptionId}/providers/Microsoft.Maps/accounts: get: tags: - Accounts description: Get all Maps Accounts in a Subscription operationId: microsoftAzureAccountsListbysubscription x-ms-examples: List Accounts By Subscription: $ref: ./examples/ListAccountsBySubscription.json x-ms-pageable: nextLinkName: nextLink 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 was successful. schema: $ref: '#/definitions/MapsAccounts' default: description: An unexpected error occurred. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Maps Accounts /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/listSas: post: tags: - Accounts description: Create and list an account shared access signature token. Use this SAS token for authentication to Azure Maps REST APIs through various Azure Maps SDKs. As prerequisite to create a SAS Token.

Prerequisites:
1. Create or have an existing User Assigned Managed Identity in the same Azure region as the account.
2. Create or update an Azure Maps account with the same Azure region as the User Assigned Managed Identity is placed. operationId: microsoftAzureAccountsListsas x-ms-examples: List Account Sas: $ref: ./examples/AccountListSAS.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/AccountNameParameter_2' - name: MapsAccountSasParameters in: body description: The updated parameters for the Maps Account. required: true schema: $ref: '#/definitions/AccountSasParameters' responses: '200': description: The request was successful. schema: $ref: '#/definitions/MapsAccountSasToken' default: description: An unexpected error occurred. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Maps Accounts Accountname Listsas ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/listKeys : post: tags: - Accounts description: Get the keys to use with the Maps APIs. A key is used to authenticate and authorize access to the Maps REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration. operationId: microsoftAzureAccountsListkeys x-ms-examples: List Keys: $ref: ./examples/ListKeys.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/AccountNameParameter_2' responses: '200': description: The request was successful. schema: $ref: '#/definitions/MapsAccountKeys' default: description: An unexpected error occurred. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Maps Accounts Accountname Listkeys ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/regenerateKey : post: tags: - Accounts description: Regenerate either the primary or secondary key for use with the Maps APIs. The old key will stop working immediately. operationId: microsoftAzureAccountsRegeneratekeys x-ms-examples: Regenerate Key: $ref: ./examples/RegenerateKey.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/AccountNameParameter_2' - name: keySpecification in: body required: true description: 'Which key to regenerate: primary or secondary.' schema: $ref: '#/definitions/MapsKeySpecification' responses: '200': description: The request was successful. schema: $ref: '#/definitions/MapsAccountKeys' default: description: An unexpected error occurred. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Maps Accounts Accountname Regeneratekey /supportedimages: get: tags: - Accounts x-ms-pageable: nextLinkName: odata.nextLink operationId: microsoftAzureAccountListsupportedimages x-ms-examples: Account list node agent skus: $ref: ./examples/AccountListSupportedImages.json summary: Microsoft Azure Lists All Virtual Machine Images Supported By The Azure Batch Service x-ms-request-id: request-id parameters: - name: $filter in: query required: false type: string description: An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images. x-ms-parameter-grouping: postfix: Options - name: maxresults x-ms-client-name: maxResults default: 1000 minimum: 1 maximum: 1000 in: query required: false type: integer format: int32 description: The maximum number of items to return in the response. A maximum of 1000 results will be returned. x-ms-parameter-grouping: postfix: Options - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid ETag: description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 description: A response containing the list of supported Virtual Machine Images. schema: $ref: '#/definitions/AccountListSupportedImagesResult' default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' description: Needs a more full description created. /nodecounts: get: x-ms-pageable: nextLinkName: odata.nextLink tags: - Accounts operationId: microsoftAzureAccountListpoolnodecounts description: Gets the number of Compute Nodes in each state, grouped by Pool. Note that the numbers returned may not always be up to date. If you need exact node counts, use a list query. x-ms-examples: NodeCountsPayload: $ref: ./examples/AccountListPoolNodeCounts.json parameters: - name: $filter in: query required: false type: string description: An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch. x-ms-parameter-grouping: postfix: Options - name: maxresults x-ms-client-name: maxResults default: 10 minimum: 1 maximum: 10 in: query required: false type: integer format: int32 description: The maximum number of items to return in the response. x-ms-parameter-grouping: postfix: Options - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid description: The response contains the number of Compute Nodes in each Compute Node state, grouped by Pool. schema: $ref: '#/definitions/PoolNodeCountsListResult' default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' summary: Microsoft Azure Get Nodecounts /subscriptions/{subscriptionId}/providers/Microsoft.DataLakeAnalytics/accounts: get: tags: - Accounts operationId: microsoftAzureAccountsList description: Gets the first page of Data Lake Analytics accounts, if any, within the current subscription. This includes a link to the next page, if any. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - name: $filter in: query required: false type: string description: OData filter. Optional. - name: $top in: query required: false type: integer format: int32 minimum: 1 description: The number of items to return. Optional. - name: $skip in: query required: false type: integer format: int32 minimum: 1 description: The number of items to skip over before returning elements. Optional. - name: $select in: query required: false type: string description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. - name: $orderby in: query required: false type: string description: OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional. - name: $count in: query required: false type: boolean description: The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional. - $ref: '#/parameters/ApiVersionParameter_2' responses: '200': description: Successfully retrieved the list of Azure Data Lake Analytics accounts. schema: $ref: '#/definitions/DataLakeAnalyticsAccountListResult' default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: '' x-ms-examples: ? Gets the first page of Data Lake Analytics accounts, if any, within the current subscription. This includes a link to the next page, if any. : $ref: ./examples/Accounts_List.json x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/DataLakeAnalyticsAccountBasic' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Datalakeanalytics Accounts /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts: get: tags: - Accounts operationId: microsoftAzureAccountsListbyresourcegroup description: Gets the first page of Data Lake Analytics accounts, if any, within a specific resource group. This includes a link to the next page, if any. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - name: $filter in: query required: false type: string description: OData filter. Optional. - name: $top in: query required: false type: integer format: int32 minimum: 1 description: The number of items to return. Optional. - name: $skip in: query required: false type: integer format: int32 minimum: 1 description: The number of items to skip over before returning elements. Optional. - name: $select in: query required: false type: string description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. - name: $orderby in: query required: false type: string description: OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional. - name: $count in: query required: false type: boolean description: The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional. - $ref: '#/parameters/ApiVersionParameter_2' responses: '200': description: Successfully retrieved the list of accounts in the specified resource group. schema: $ref: '#/definitions/DataLakeAnalyticsAccountListResult' default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: '' x-ms-examples: ? Gets the first page of Data Lake Analytics accounts, if any, within a specific resource group. This includes a link to the next page, if any. : $ref: ./examples/Accounts_ListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/DataLakeAnalyticsAccountBasic' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datalakeanalytics Accounts ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName} : put: tags: - Accounts operationId: microsoftAzureAccountsCreate description: Creates the specified Data Lake Analytics account. This supplies the user with computation services for Data Lake Analytics workloads. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/AccountNameParameter_3' - name: parameters in: body required: true schema: $ref: '#/definitions/CreateDataLakeAnalyticsAccountParameters' description: Parameters supplied to create a new Data Lake Analytics account. - $ref: '#/parameters/ApiVersionParameter_2' responses: '200': description: Successfully created the specified account. schema: $ref: '#/definitions/DataLakeAnalyticsAccount' '201': description: Successfully initiated creation of the specified account. schema: $ref: '#/definitions/DataLakeAnalyticsAccount' default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: '' x-ms-examples: ? Creates the specified Data Lake Analytics account. This supplies the user with computation services for Data Lake Analytics workloads. : $ref: ./examples/Accounts_Create.json x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datalakeanalytics Accounts Accountname get: tags: - Accounts operationId: microsoftAzureAccountsGet description: Gets details of the specified Data Lake Analytics account. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/AccountNameParameter_3' - $ref: '#/parameters/ApiVersionParameter_2' responses: '200': description: Successfully retrieved the details of the specified account. schema: $ref: '#/definitions/DataLakeAnalyticsAccount' default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: '' x-ms-examples: Gets details of the specified Data Lake Analytics account.: $ref: ./examples/Accounts_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datalakeanalytics Accounts Accountname patch: tags: - Accounts operationId: microsoftAzureAccountsUpdate description: Updates the Data Lake Analytics account object specified by the accountName with the contents of the account object. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/AccountNameParameter_3' - name: parameters in: body required: false schema: $ref: '#/definitions/UpdateDataLakeAnalyticsAccountParameters' description: Parameters supplied to the update Data Lake Analytics account operation. - $ref: '#/parameters/ApiVersionParameter_2' responses: '200': description: Successfully updated the specified account. schema: $ref: '#/definitions/DataLakeAnalyticsAccount' '201': description: Successfully initiated an update of the specified account. schema: $ref: '#/definitions/DataLakeAnalyticsAccount' '202': description: Successfully initiated an update of the specified account. schema: $ref: '#/definitions/DataLakeAnalyticsAccount' default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: '' x-ms-examples: Updates the Data Lake Analytics account object specified by the accountName with the contents of the account object.: $ref: ./examples/Accounts_Update.json x-ms-long-running-operation: true summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datalakeanalytics Accounts Accountname delete: tags: - Accounts operationId: microsoftAzureAccountsDelete description: Begins the delete process for the Data Lake Analytics account object specified by the account name. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/AccountNameParameter_3' - $ref: '#/parameters/ApiVersionParameter_2' responses: '200': description: Successfully deleted the specified account. '202': description: Successfully initiated the deletion of the specified account. '204': description: The specified account was not found. default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: '' x-ms-examples: Begins the delete process for the Data Lake Analytics account object specified by the account name.: $ref: ./examples/Accounts_Delete.json x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datalakeanalytics Accounts Accountname /subscriptions/{subscriptionId}/providers/Microsoft.DataLakeAnalytics/locations/{location}/checkNameAvailability: post: tags: - Accounts operationId: microsoftAzureAccountsChecknameavailability description: Checks whether the specified account name is available or taken. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - name: location in: path required: true type: string description: The resource location without whitespace. - name: parameters in: body required: true schema: $ref: '#/definitions/CheckNameAvailabilityParameters' description: Parameters supplied to check the Data Lake Analytics account name availability. - $ref: '#/parameters/ApiVersionParameter_2' responses: '200': description: Successfully retrieved the Data Lake Analytics account name availability information. schema: $ref: '#/definitions/NameAvailabilityInformation' default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: '' x-ms-examples: Checks whether the specified account name is available or taken: $ref: ./examples/Accounts_CheckNameAvailability.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Datalakeanalytics Locations Location Checknameavailability /subscriptions/{subscriptionId}/providers/Microsoft.DataLakeStore/accounts: get: tags: - Accounts operationId: microsoftAzureAccountsList description: Lists the Data Lake Store accounts within the subscription. The response includes a link to the next page of results, if any. parameters: - $ref: '#/parameters/SubscriptionIdParameter_2' - name: $filter in: query required: false type: string description: OData filter. Optional. - name: $top in: query required: false type: integer format: int32 minimum: 1 description: The number of items to return. Optional. - name: $skip in: query required: false type: integer format: int32 minimum: 1 description: The number of items to skip over before returning elements. Optional. - name: $select in: query required: false type: string description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. - name: $orderby in: query required: false type: string description: OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional. - name: $count in: query required: false type: boolean description: The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional. - $ref: '#/parameters/ApiVersionParameter_3' responses: '200': description: Successfully retrieved the list of accounts. schema: $ref: '#/definitions/DataLakeStoreAccountListResult' x-ms-examples: Lists the Data Lake Store accounts within the subscription: $ref: ./examples/Accounts_List.json x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/DataLakeStoreAccountBasic' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Datalakestore Accounts /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts: get: tags: - Accounts operationId: microsoftAzureAccountsListbyresourcegroup description: Lists the Data Lake Store accounts within a specific resource group. The response includes a link to the next page of results, if any. parameters: - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupNameParameter' - name: $filter in: query required: false type: string description: OData filter. Optional. - name: $top in: query required: false type: integer format: int32 minimum: 1 description: The number of items to return. Optional. - name: $skip in: query required: false type: integer format: int32 minimum: 1 description: The number of items to skip over before returning elements. Optional. - name: $select in: query required: false type: string description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. - name: $orderby in: query required: false type: string description: OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional. - name: $count in: query required: false type: boolean description: A Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional. - $ref: '#/parameters/ApiVersionParameter_3' responses: '200': description: Successfully retrieved the list of accounts in the specified resource group. schema: $ref: '#/definitions/DataLakeStoreAccountListResult' x-ms-examples: Lists the Data Lake Store accounts within a specific resource group: $ref: ./examples/Accounts_ListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/DataLakeStoreAccountBasic' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datalakestore Accounts ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName} : put: tags: - Accounts operationId: microsoftAzureAccountsCreate description: Creates the specified Data Lake Store account. parameters: - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/AccountNameParameter_4' - name: parameters in: body required: true schema: $ref: '#/definitions/CreateDataLakeStoreAccountParameters' description: Parameters supplied to create the Data Lake Store account. - $ref: '#/parameters/ApiVersionParameter_3' responses: '200': description: Successfully created the account. schema: $ref: '#/definitions/DataLakeStoreAccount' '201': description: Successfully initiated creation of the account. schema: $ref: '#/definitions/DataLakeStoreAccount' x-ms-examples: Creates the specified Data Lake Store account: $ref: ./examples/Accounts_Create.json x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datalakestore Accounts Accountname get: tags: - Accounts operationId: microsoftAzureAccountsGet description: Gets the specified Data Lake Store account. parameters: - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/AccountNameParameter_4' - $ref: '#/parameters/ApiVersionParameter_3' responses: '200': description: Successfully retrieved details of the specified account. schema: $ref: '#/definitions/DataLakeStoreAccount' x-ms-examples: Gets the specified Data Lake Store account: $ref: ./examples/Accounts_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datalakestore Accounts Accountname patch: tags: - Accounts operationId: microsoftAzureAccountsUpdate description: Updates the specified Data Lake Store account information. parameters: - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/AccountNameParameter_4' - name: parameters in: body required: true schema: $ref: '#/definitions/UpdateDataLakeStoreAccountParameters' description: Parameters supplied to update the Data Lake Store account. - $ref: '#/parameters/ApiVersionParameter_3' responses: '200': description: Successfully updated the account details. schema: $ref: '#/definitions/DataLakeStoreAccount' '201': description: Successfully initiated the update of the account details. schema: $ref: '#/definitions/DataLakeStoreAccount' '202': description: Successfully initiated the update of the account details. schema: $ref: '#/definitions/DataLakeStoreAccount' x-ms-examples: Updates the specified Data Lake Store account information: $ref: ./examples/Accounts_Update.json x-ms-long-running-operation: true summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datalakestore Accounts Accountname delete: tags: - Accounts operationId: microsoftAzureAccountsDelete description: Deletes the specified Data Lake Store account. parameters: - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/AccountNameParameter_4' - $ref: '#/parameters/ApiVersionParameter_3' responses: '200': description: Successfully deleted the specified account. '202': description: Successfully initiated the deletion of the specified account. '204': description: The specified account was not found. x-ms-examples: Deletes the specified Data Lake Store account: $ref: ./examples/Accounts_Delete.json x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datalakestore Accounts Accountname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/enableKeyVault : post: tags: - Accounts operationId: microsoftAzureAccountsEnablekeyvault description: Attempts to enable a user managed Key Vault for encryption of the specified Data Lake Store account. parameters: - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/AccountNameParameter_4' - $ref: '#/parameters/ApiVersionParameter_3' responses: '200': description: Successfully enabled the user-managed Key Vault settings used for encrypting this Data Lake Store account. x-ms-examples: Attempts to enable a user managed Key Vault for encryption of the specified Data Lake Store account: $ref: ./examples/Accounts_EnableKeyVault.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Datalakestore Accounts Accountname Enablekeyvault /subscriptions/{subscriptionId}/providers/Microsoft.DataLakeStore/locations/{location}/checkNameAvailability: post: tags: - Accounts operationId: microsoftAzureAccountsChecknameavailability description: Checks whether the specified account name is available or taken. parameters: - $ref: '#/parameters/SubscriptionIdParameter_2' - name: location in: path required: true type: string description: The resource location without whitespace. - name: parameters in: body required: true schema: $ref: '#/definitions/CheckNameAvailabilityParameters_2' description: Parameters supplied to check the Data Lake Store account name availability. - $ref: '#/parameters/ApiVersionParameter_3' responses: '200': description: Successfully retrieved the Data Lake Store account name availability information. schema: $ref: '#/definitions/NameAvailabilityInformation_2' x-ms-examples: Checks whether the specified account name is available or taken: $ref: ./examples/Accounts_CheckNameAvailability.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Datalakestore Locations Location Checknameavailability ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName} : get: tags: - Accounts summary: Microsoft Azure Get The Engagementfabric Account operationId: microsoftAzureAccountsGet parameters: - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupNameParameter_2' - $ref: '#/parameters/AccountNameParameter_5' - $ref: '#/parameters/ApiVersionParameter_4' responses: '200': description: OK schema: $ref: '#/definitions/Account_2' default: description: Error response schema: $ref: '#/definitions/CloudError' x-ms-examples: AccountsGetExample: $ref: ./examples/AccountsGetExample.json description: Needs a more full description created. put: tags: - Accounts summary: Microsoft Azure Create Or Update The Engagementfabric Account operationId: microsoftAzureAccountsCreateorupdate parameters: - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupNameParameter_2' - $ref: '#/parameters/AccountNameParameter_5' - name: account in: body description: The EngagementFabric account description required: true schema: $ref: '#/definitions/Account_2' - $ref: '#/parameters/ApiVersionParameter_4' responses: '200': description: OK schema: $ref: '#/definitions/Account_2' default: description: Error response schema: $ref: '#/definitions/CloudError' x-ms-examples: AccountsCreateOrUpdateExample: $ref: ./examples/AccountsCreateOrUpdateExample.json description: Needs a more full description created. delete: tags: - Accounts summary: Microsoft Azure Delete The Engagementfabric Account operationId: microsoftAzureAccountsDelete parameters: - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupNameParameter_2' - $ref: '#/parameters/AccountNameParameter_5' - $ref: '#/parameters/ApiVersionParameter_4' responses: '200': description: OK '204': description: NoContent default: description: Error response schema: $ref: '#/definitions/CloudError' x-ms-examples: AccountsDeleteExample: $ref: ./examples/AccountsDeleteExample.json description: Needs a more full description created. patch: tags: - Accounts summary: Microsoft Azure Update Engagementfabric Account operationId: microsoftAzureAccountsUpdate parameters: - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupNameParameter_2' - $ref: '#/parameters/AccountNameParameter_5' - name: accountPatch in: body description: The account patch required: true schema: $ref: '#/definitions/AccountPatch_2' - $ref: '#/parameters/ApiVersionParameter_4' responses: '200': description: OK schema: $ref: '#/definitions/Account_2' default: description: Error response schema: $ref: '#/definitions/CloudError' x-ms-examples: AccountsUpdateExample: $ref: ./examples/AccountsUpdateExample.json description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.EngagementFabric/Accounts: get: tags: - Accounts summary: Microsoft Azure List The Engagementfabric Accounts In Given Subscription operationId: microsoftAzureAccountsList parameters: - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ApiVersionParameter_4' responses: '200': description: OK schema: $ref: '#/definitions/AccountList_2' default: description: Error response schema: $ref: '#/definitions/CloudError' x-ms-examples: AccountsListExample: $ref: ./examples/AccountsListExample.json x-ms-pageable: nextLinkName: null description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts: get: tags: - Accounts summary: Microsoft Azure List Engagementfabric Accounts In Given Resource Group operationId: microsoftAzureAccountsListbyresourcegroup parameters: - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupNameParameter_2' - $ref: '#/parameters/ApiVersionParameter_4' responses: '200': description: OK schema: $ref: '#/definitions/AccountList_2' default: description: Error response schema: $ref: '#/definitions/CloudError' x-ms-examples: AccountsListByResourceGroupExample: $ref: ./examples/AccountsListByResourceGroupExample.json x-ms-pageable: nextLinkName: null description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/listKeys : post: tags: - Accounts summary: Microsoft Azure List Keys Of The Engagementfabric Account operationId: microsoftAzureAccountsListkeys parameters: - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupNameParameter_2' - $ref: '#/parameters/AccountNameParameter_5' - $ref: '#/parameters/ApiVersionParameter_4' responses: '200': description: OK schema: $ref: '#/definitions/KeyDescriptionList' default: description: Error response schema: $ref: '#/definitions/CloudError' x-ms-examples: AccountsListKeysExample: $ref: ./examples/AccountsListKeysExample.json x-ms-pageable: nextLinkName: null description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/regenerateKey : post: tags: - Accounts summary: Microsoft Azure Regenerate Key Of The Engagementfabric Account operationId: microsoftAzureAccountsRegeneratekey parameters: - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupNameParameter_2' - $ref: '#/parameters/AccountNameParameter_5' - name: parameter in: body description: Parameters specifying the key to be regenerated required: true schema: $ref: '#/definitions/RegenerateKeyParameter' - $ref: '#/parameters/ApiVersionParameter_4' responses: '200': description: OK schema: $ref: '#/definitions/KeyDescription' default: description: Error response schema: $ref: '#/definitions/CloudError' x-ms-examples: AccountsRegenerateKeyExample: $ref: ./examples/AccountsRegenerateKeyExample.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/listChannelTypes : post: tags: - Accounts summary: Microsoft Azure List Available Engagementfabric Channel Types And Functions operationId: microsoftAzureAccountsListchanneltypes parameters: - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupNameParameter_2' - $ref: '#/parameters/AccountNameParameter_5' - $ref: '#/parameters/ApiVersionParameter_4' responses: '200': description: OK schema: $ref: '#/definitions/ChannelTypeDescriptionList' default: description: Error response schema: $ref: '#/definitions/CloudError' x-ms-examples: AccountsListChannelTypesExample: $ref: ./examples/AccountsListChannelTypesExample.json description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.AzurePlaywrightService/accounts: get: operationId: microsoftAzureAccountsListbysubscription tags: - Accounts description: List Account resources by subscription ID 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/AccountListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Accounts_ListBySubscription: $ref: ./examples/Accounts_ListBySubscription.json x-ms-pageable: nextLinkName: nextLink summary: Get Subscriptions Subscriptionid Providers Microsoft Azureplaywrightservice Accounts /subscriptions/{subscriptionId}/providers/Microsoft.AzurePlaywrightService/checkNameAvailability: post: operationId: microsoftAzureAccountsChecknameavailability tags: - Accounts description: Adds check global name availability operation, normally used if a resource name must be globally unique. parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - name: body in: body description: The CheckAvailability request required: true schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityRequest responses: '200': description: The request has succeeded. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityResponse default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Accounts_CheckNameAvailability: $ref: ./examples/Accounts_CheckNameAvailability.json summary: Post Subscriptions Subscriptionid Providers Microsoft Azureplaywrightservice Checknameavailability /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzurePlaywrightService/accounts: get: operationId: microsoftAzureAccountsListbyresourcegroup tags: - Accounts description: List Account resources by resource group 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/AccountListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Accounts_ListByResourceGroup: $ref: ./examples/Accounts_ListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azureplaywrightservice Accounts ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzurePlaywrightService/accounts/{accountName} : get: operationId: microsoftAzureAccountsGet tags: - Accounts description: Get a 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: accountName in: path description: Name of account. required: true type: string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$ responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/Account_3' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Accounts_Get: $ref: ./examples/Accounts_Get.json summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azureplaywrightservice Accounts Accountname put: operationId: microsoftAzureAccountsCreateorupdate tags: - Accounts description: Create a 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: accountName in: path description: Name of account. required: true type: string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$ - name: resource in: body description: Resource create parameters. required: true schema: $ref: '#/definitions/Account_3' responses: '200': description: Resource 'Account' update operation succeeded schema: $ref: '#/definitions/Account_3' '201': description: Resource 'Account' create operation succeeded schema: $ref: '#/definitions/Account_3' headers: 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: Accounts_CreateOrUpdate: $ref: ./examples/Accounts_CreateOrUpdate.json x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-long-running-operation: true summary: Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azureplaywrightservice Accounts Accountname patch: operationId: microsoftAzureAccountsUpdate tags: - Accounts description: Update a 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: accountName in: path description: Name of account. required: true type: string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$ - name: properties in: body description: The resource properties to be updated. required: true schema: $ref: '#/definitions/AccountUpdate' responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/Account_3' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Accounts_Update: $ref: ./examples/Accounts_Update.json summary: Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azureplaywrightservice Accounts Accountname delete: operationId: microsoftAzureAccountsDelete tags: - Accounts description: Delete a 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: accountName in: path description: Name of account. required: true type: string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$ responses: '200': description: Resource deleted successfully. '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: Accounts_Delete: $ref: ./examples/Accounts_Delete.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true summary: Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azureplaywrightservice Accounts Accountname /accounts/{accountId}: get: operationId: microsoftAzureAccountsGetaccount description: Get details of the ARM resource mapped to an account for the given accountId. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: accountId in: path description: The account id. required: true type: string - $ref: '#/parameters/Azure.Core.ClientRequestIdHeader' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/Account_4' headers: x-ms-client-request-id: type: string format: uuid description: An opaque, globally-unique, client-generated string identifier for the request. default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Accounts_GetAccount: $ref: ./examples/Accounts_GetAccount.json summary: Microsoft Azure Get Accounts Accountid tags: - Accounts /accounts/{accountId}/access-tokens: get: operationId: microsoftAzureAccesstokensListaccesstokens description: List access-tokens for a given accountId. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: accountId in: path description: The account id. required: true type: string - $ref: '#/parameters/Azure.Core.ClientRequestIdHeader' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/PagedAccessToken' headers: x-ms-client-request-id: type: string format: uuid description: An opaque, globally-unique, client-generated string identifier for the request. default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: AccessTokens_ListAccessTokens: $ref: ./examples/AccessTokens_ListAccessTokens.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Accounts Accountid Access Tokens tags: - Accounts /accounts/{accountId}/access-tokens/{accessTokenId}: get: operationId: microsoftAzureAccesstokensGetaccesstoken description: Get an access-token for given access-token id in guid format. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: accountId in: path description: The account id. required: true type: string - name: accessTokenId in: path description: The access-token id. required: true type: string format: uuid - $ref: '#/parameters/Azure.Core.ClientRequestIdHeader' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/AccessToken' headers: x-ms-client-request-id: type: string format: uuid description: An opaque, globally-unique, client-generated string identifier for the request. default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: AccessTokens_GetAccessToken: $ref: ./examples/AccessTokens_GetAccessToken.json summary: Microsoft Azure Get Accounts Accountid Access Tokens Accesstokenid tags: - Accounts put: operationId: microsoftAzureAccesstokensCreateaccesstoken description: Creates an access-token with given access-token id in guid format. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: accountId in: path description: The account id. required: true type: string - name: accessTokenId in: path description: The access-token id. required: true type: string format: uuid - $ref: '#/parameters/Azure.Core.ClientRequestIdHeader' - name: resource in: body description: The resource instance. required: true schema: $ref: '#/definitions/AccessToken' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/AccessToken' headers: x-ms-client-request-id: type: string format: uuid description: An opaque, globally-unique, client-generated string identifier for the request. '201': description: The request has succeeded and a new resource has been created as a result. schema: $ref: '#/definitions/AccessToken' headers: x-ms-client-request-id: type: string format: uuid description: An opaque, globally-unique, client-generated string identifier for the request. default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: AccessTokens_CreateAccessToken: $ref: ./examples/AccessTokens_CreateAccessToken.json summary: Microsoft Azure Put Accounts Accountid Access Tokens Accesstokenid tags: - Accounts delete: operationId: microsoftAzureAccesstokensDeleteaccesstoken description: Revoke an access-token with given access-token id in guid format. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: accountId in: path description: The account id. required: true type: string - name: accessTokenId in: path description: The access-token id. required: true type: string format: uuid - $ref: '#/parameters/Azure.Core.ClientRequestIdHeader' responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' headers: x-ms-client-request-id: type: string format: uuid description: An opaque, globally-unique, client-generated string identifier for the request. default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: AccessTokens_DeleteAccessToken: $ref: ./examples/AccessTokens_DeleteAccessToken.json summary: Microsoft Azure Delete Accounts Accountid Access Tokens Accesstokenid tags: - Accounts /Accounts/{accountId}/token: get: tags: - Accounts summary: Microsoft Azure Gets An Access Token To Be Used With Mixed Reality Services operationId: microsoftAzureGettoken produces: - application/json x-ms-examples: TokenGet: $ref: ./examples/GetToken.json parameters: - in: path name: accountId description: The Mixed Reality account identifier. required: true type: string format: uuid - name: X-MRC-CV x-ms-client-name: clientRequestId in: header description: The client request correlation vector, which should be set to a new value for each request. Useful when debugging with Microsoft. type: string x-ms-parameter-grouping: name: token-request-options - in: query name: api-version description: The API version. type: string responses: '200': description: Success schema: $ref: '#/definitions/StsTokenResponseMessage' headers: MS-CV: x-ms-client-name: requestId description: The service response correlation vector, which will be a new value for every response. Useful when debugging with Microsoft. type: string '400': description: Bad request headers: MS-CV: x-ms-client-name: requestId description: The service response correlation vector, which will be a new value for every response. Useful when debugging with Microsoft. type: string WWW-Authenticate: description: Describes the error encountered while trying to authenticate the resource. type: string x-ms-error-response: true '401': description: Unauthorized headers: MS-CV: x-ms-client-name: requestId description: The service response correlation vector, which will be a new value for every response. Useful when debugging with Microsoft. type: string WWW-Authenticate: description: Describes the error encountered while trying to authenticate the resource. type: string x-ms-error-response: true '429': description: Too many requests headers: MS-CV: x-ms-client-name: requestId description: The service response correlation vector, which will be a new value for every response. Useful when debugging with Microsoft. type: string WWW-Authenticate: description: Describes the error encountered while trying to authenticate the resource. type: string x-ms-error-response: true default: description: Error headers: MS-CV: x-ms-client-name: requestId description: The service response correlation vector, which will be a new value for every response. Useful when debugging with Microsoft. type: string x-ms-error-response: true description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName} : get: tags: - Accounts description: Gets the properties of the specified machine learning team account. operationId: microsoftAzureAccountsGet parameters: - $ref: '#/parameters/ApiVersionParameter_5' - $ref: '#/parameters/SubscriptionIdParameter_4' - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/AccountNameParameter_6' x-ms-examples: AccountGet: $ref: examples/GetAccount.json responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/Account_5' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearningexperimentation Accounts Accountname put: tags: - Accounts description: Creates or updates a team account with the specified parameters. operationId: microsoftAzureAccountsCreateorupdate parameters: - $ref: '#/parameters/ApiVersionParameter_5' - $ref: '#/parameters/SubscriptionIdParameter_4' - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/AccountNameParameter_6' - name: parameters in: body description: The parameters for creating or updating a machine learning team account. required: true schema: $ref: '#/definitions/Account_5' x-ms-examples: AccountCreate: $ref: examples/CreateAccount.json responses: '200': description: The request was successful; the resource already exists and was updated. schema: $ref: '#/definitions/Account_5' '201': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/Account_5' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearningexperimentation Accounts Accountname delete: tags: - Accounts description: Deletes a machine learning team account. operationId: microsoftAzureAccountsDelete parameters: - $ref: '#/parameters/ApiVersionParameter_5' - $ref: '#/parameters/SubscriptionIdParameter_4' - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/AccountNameParameter_6' x-ms-examples: AccountDelete: $ref: examples/DeleteAccount.json responses: '200': description: The request was successful; the request was well-formed and received properly. '204': description: The machine learning team account does not exist in the subscription. default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearningexperimentation Accounts Accountname patch: tags: - Accounts description: Updates a machine learning team account with the specified parameters. operationId: microsoftAzureAccountsUpdate parameters: - $ref: '#/parameters/ApiVersionParameter_5' - $ref: '#/parameters/SubscriptionIdParameter_4' - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/AccountNameParameter_6' - name: parameters in: body description: The parameters for updating a machine learning team account. required: true schema: $ref: '#/definitions/AccountUpdateParameters' x-ms-examples: AccountUpdate: $ref: examples/UpdateAccount.json responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/Account_5' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearningexperimentation Accounts Accountname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts : get: tags: - Accounts description: Lists all the available machine learning team accounts under the specified resource group. operationId: microsoftAzureAccountsListbyresourcegroup parameters: - $ref: '#/parameters/ApiVersionParameter_5' - $ref: '#/parameters/SubscriptionIdParameter_4' - $ref: '#/parameters/ResourceGroupParameter' x-ms-examples: AccountListByResourceGroup: $ref: examples/ListAccountResourceGroup.json responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/AccountListResult_2' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_2' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearningexperimentation Accounts /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningExperimentation/accounts: get: tags: - Accounts description: Lists all the available machine learning team accounts under the specified subscription. operationId: microsoftAzureAccountsList parameters: - $ref: '#/parameters/ApiVersionParameter_5' - $ref: '#/parameters/SubscriptionIdParameter_4' x-ms-examples: AccountList: $ref: examples/ListAccount.json responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/AccountListResult_2' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_2' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Machinelearningexperimentation Accounts /subscriptions/{subscriptionId}/providers/NewRelic.Observability/accounts: get: tags: - Accounts operationId: microsoftAzureAccountsList description: List all the existing accounts parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/UserEmailParameter' - $ref: '#/parameters/LocationParameter' responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/AccountsListResponse' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: Accounts_List_MaximumSet_Gen: $ref: ./examples/Accounts_List_MaximumSet_Gen.json Accounts_List_MinimumSet_Gen: $ref: ./examples/Accounts_List_MinimumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Newrelic Observability Accounts /subscriptions/{subscriptionId}/providers/Microsoft.VideoIndexer/accounts: get: tags: - Accounts operationId: microsoftAzureAccountsList description: List all Azure Video Indexer accounts available under the subscription x-ms-examples: List accounts: $ref: ./examples/ViAccountsList.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/AccountList_3' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Videoindexer Accounts /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts: get: tags: - Accounts operationId: microsoftAzureAccountsListbyresourcegroup description: List all Azure Video Indexer accounts available under the resource group x-ms-examples: List accounts by resource group: $ref: ./examples/ViAccountsListByResourceGroup.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/AccountList_3' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Videoindexer Accounts /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}: get: tags: - Accounts operationId: microsoftAzureAccountsGet description: Gets the properties of an Azure Video Indexer account. parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AccountNameParameter_7' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The Azure Video Indexer account properties were retrieved successfully. schema: $ref: '#/definitions/Account_6' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' x-ms-examples: Get account: $ref: ./examples/ViAccountGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Videoindexer Accounts Accountname patch: tags: - Accounts operationId: microsoftAzureAccountsUpdate x-ms-long-running-operation: false description: Updates the properties of an existing Azure Video Indexer account. parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AccountNameParameter_7' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: The parameters to provide for the current Azure Video Indexer account. schema: $ref: '#/definitions/AccountPatch_3' responses: '200': description: The resource was updated successfully. schema: $ref: '#/definitions/Account_6' '400': description: Bad Request. x-ms-error-response: true schema: $ref: '#/definitions/ErrorResponse_3' '404': description: Not Found x-ms-error-response: true schema: $ref: '#/definitions/ErrorResponse_3' '500': description: Internal Server Error x-ms-error-response: true schema: $ref: '#/definitions/ErrorResponse_3' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' x-ms-examples: 'Patch example #1': $ref: ./examples/ViAccountPatch/ViAccountPatch1.json 'Patch example #2': $ref: ./examples/ViAccountPatch/ViAccountPatch2.json 'Patch example #3': $ref: ./examples/ViAccountPatch/ViAccountPatch3.json 'Patch example #4': $ref: ./examples/ViAccountPatch/ViAccountPatch4.json 'Patch example #5': $ref: ./examples/ViAccountPatch/ViAccountPatch5.json 'Patch example #6': $ref: ./examples/ViAccountPatch/ViAccountPatch6.json 'Patch example #7': $ref: ./examples/ViAccountPatch/ViAccountPatch7.json 'Patch example #8': $ref: ./examples/ViAccountPatch/ViAccountPatch8.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Videoindexer Accounts Accountname put: tags: - Accounts operationId: microsoftAzureAccountsCreateorupdate description: Creates or updates an Azure Video Indexer account. x-ms-long-running-operation: false parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AccountNameParameter_7' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: The parameters to provide for the Azure Video Indexer account. schema: $ref: '#/definitions/Account_6' responses: '200': description: The resource was successfully updated. schema: $ref: '#/definitions/Account_6' '400': description: Bad Request. x-ms-error-response: true schema: $ref: '#/definitions/ErrorResponse_3' '404': description: Not Found x-ms-error-response: true schema: $ref: '#/definitions/ErrorResponse_3' '409': description: Conflict x-ms-error-response: true schema: $ref: '#/definitions/ErrorResponse_3' '500': description: Internal Server Error x-ms-error-response: true schema: $ref: '#/definitions/ErrorResponse_3' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' x-ms-examples: 'Put example #1': $ref: ./examples/ViAccountPut/ViAccountPut1.json 'Put example #2': $ref: ./examples/ViAccountPut/ViAccountPut2.json 'Put example #3': $ref: ./examples/ViAccountPut/ViAccountPut3.json 'Put example #4': $ref: ./examples/ViAccountPut/ViAccountPut4.json 'Put example #5': $ref: ./examples/ViAccountPut/ViAccountPut5.json 'Put example #6': $ref: ./examples/ViAccountPut/ViAccountPut6.json 'Put example #7': $ref: ./examples/ViAccountPut/ViAccountPut7.json 'Put example #8': $ref: ./examples/ViAccountPut/ViAccountPut8.json 'Put example #9': $ref: ./examples/ViAccountPut/ViAccountPut9.json 'Put example #10': $ref: ./examples/ViAccountPut/ViAccountPut10.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Videoindexer Accounts Accountname delete: tags: - Accounts operationId: microsoftAzureAccountsDelete description: Delete an Azure Video Indexer account. x-ms-long-running-operation: false parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AccountNameParameter_7' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The Azure Video Indexer account was successfully deleted. '202': description: The Azure Video Indexer account will be deleted asynchronously. '204': description: The Azure Video Indexer account does not exist. '500': description: Internal Server Error x-ms-error-response: true schema: $ref: '#/definitions/ErrorResponse_3' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' x-ms-examples: Delete account: $ref: ./examples/ViAccountDelete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Videoindexer Accounts Accountname /providers/Microsoft.VideoIndexer/locations/{location}/userClassicAccounts: get: tags: - Accounts operationId: microsoftAzureUserclassicaccountsList description: Lists all Azure Video Indexer classic accounts x-ms-examples: List accounts: $ref: ./examples/ViListUserClassicAccounts.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/UserClassicAccountList' '500': description: Internal Server Error x-ms-error-response: true schema: $ref: '#/definitions/ErrorResponse_3' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers Microsoft Videoindexer Locations Location Userclassicaccounts /providers/Microsoft.VideoIndexer/locations/{location}/classicAccounts/{accountName}: get: tags: - Accounts operationId: microsoftAzureClassicaccountsGetdetails description: Gets the properties of an Azure Video Indexer Classic account. parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/AccountNameParameter_7' responses: '200': description: The Azure Video Indexer account properties were retrieved successfully. schema: $ref: '#/definitions/ClassicAccount' '400': description: Bad Request. x-ms-error-response: true schema: $ref: '#/definitions/ErrorResponse_3' '401': description: User Not Allowed x-ms-error-response: true schema: $ref: '#/definitions/ErrorResponse_3' '404': description: Not Found x-ms-error-response: true schema: $ref: '#/definitions/ErrorResponse_3' '500': description: Internal Server Error x-ms-error-response: true schema: $ref: '#/definitions/ErrorResponse_3' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' x-ms-examples: Get account: $ref: ./examples/ViClassicAccounts.json summary: Microsoft Azure Get Providers Microsoft Videoindexer Locations Location Classicaccounts Accountname /subscriptions/{subscriptionId}/providers/microsoft.visualstudio/checkNameAvailability: post: tags: - Accounts summary: Microsoft Azure Accounts Checknameavailability description: Checks if the specified Visual Studio Team Services account name is available. Resource name can be either an account name or an account name and PUID. operationId: microsoftAzureAccountsChecknameavailability parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' - in: body name: body description: Parameters describing the name to check availability for. required: true schema: $ref: '#/definitions/CheckNameAvailabilityParameter' responses: '200': description: The operation succeeded. The response contains the result of the name availability check. schema: $ref: '#/definitions/CheckNameAvailabilityResult_2' x-ms-examples: Check availability of an account name: $ref: ./examples/CheckNameAvailability.json /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.visualstudio/account: get: tags: - Accounts summary: Microsoft Azure Accounts Listbyresourcegroup description: Gets all Visual Studio Team Services account resources under the resource group linked to the specified Azure subscription. operationId: microsoftAzureAccountsListbyresourcegroup produces: - application/json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: The operation succeeded. The response contains the details of the Visual Studio Team Services account resources linked to the Azure subscription. schema: $ref: '#/definitions/AccountResourceListResult' x-ms-examples: Get a list of account resources in the resource group: $ref: ./examples/GetResources_List.json /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.visualstudio/account/{resourceName}: put: tags: - Accounts summary: Microsoft Azure Accounts Createorupdate description: Creates or updates a Visual Studio Team Services account resource. operationId: microsoftAzureAccountsCreateorupdate parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' - in: body name: body description: The request data. required: true schema: $ref: '#/definitions/AccountResourceRequest' - in: path name: resourceName description: Name of the resource. required: true type: string responses: '200': description: The operation succeeded. The Visual Studio Team Services account resource was created or updated. schema: $ref: '#/definitions/AccountResource_2' '404': description: The Visual Studio Team Services account does not exist. x-ms-examples: Create an account resource: $ref: ./examples/CreateResource.json delete: tags: - Accounts summary: Microsoft Azure Accounts Delete description: Deletes a Visual Studio Team Services account resource. operationId: microsoftAzureAccountsDelete parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' - in: path name: resourceName description: Name of the resource. required: true type: string responses: '200': description: The operation succeeded. The Visual Studio Team Services account resource was deleted. x-ms-examples: Delete an account resource: $ref: ./examples/DeleteResource.json get: tags: - Accounts summary: Microsoft Azure Accounts Get description: Gets the Visual Studio Team Services account resource details. operationId: microsoftAzureAccountsGet parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' - in: path name: resourceName description: Name of the resource. required: true type: string responses: '200': description: The operation succeeded. The response contains the details of the Visual Studio Team Services account resource. schema: $ref: '#/definitions/AccountResource_2' '404': description: The Visual Studio Team Services account does not exist. x-ms-examples: Get an account resource: $ref: ./examples/GetResource.json patch: tags: - Accounts summary: Microsoft Azure Accounts Update description: Updates tags for Visual Studio Team Services account resource. operationId: microsoftAzureAccountsUpdate parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' - in: body name: body description: The request data. required: true schema: $ref: '#/definitions/AccountTagRequest' - in: path name: resourceName description: Name of the resource. required: true type: string responses: '200': description: The operation succeeded. The Visual Studio Team Services account resource was updated. schema: $ref: '#/definitions/AccountResource_2' '404': description: The Visual Studio Team Services account does not exist. x-ms-examples: Create an account resource: $ref: ./examples/UpdateTags.json components: schemas: Sku: type: object description: The resource model definition representing SKU. properties: name: type: string description: The name of the SKU. Examples include F0 (free), S0, S1, S2, etc. example: Example Title tier: type: string readOnly: true enum: - Free - Basic - Standard - Premium - Enterprise description: The pricing tier of the SKU. example: Free required: - name AccountProperties: type: object description: Properties of Cognitive Services account. properties: provisioningState: type: string readOnly: true enum: - Accepted - Creating - Deleting - Moving - Failed - Succeeded - ResolvingDNS description: The status of the cognitive services account at the time of the operation. example: Accepted endpoint: type: string readOnly: true description: Endpoint of the created account. example: example_value endpoints: type: object readOnly: true additionalProperties: type: string description: Dictionary of endpoints for the cognitive services account. example: example_value capabilities: type: array readOnly: true items: type: object properties: name: type: string value: type: string description: The capabilities of the cognitive services account. example: [] isMigrated: type: boolean readOnly: true description: Whether this account has been migrated. example: true dateCreated: type: string readOnly: true description: The date of creation. example: example_value customSubDomainName: type: string description: Optional subdomain name used for token-based authentication. example: example_value networkAcls: $ref: '#/components/schemas/NetworkRuleSet' publicNetworkAccess: type: string enum: - Enabled - Disabled description: Whether or not public endpoint access is allowed. example: Enabled disableLocalAuth: type: boolean description: Whether to disable local authentication methods. example: true restrictOutboundNetworkAccess: type: boolean description: Whether to restrict outbound network access. example: true ApiKeys: type: object description: The access keys for the cognitive services account. properties: key1: type: string description: Gets the value of key 1. example: example_value key2: type: string description: Gets the value of key 2. example: example_value Account: type: object description: Cognitive Services account. properties: id: type: string readOnly: true description: Fully qualified resource ID. example: abc123 name: type: string readOnly: true description: The name of the resource. example: Example Title type: type: string readOnly: true description: The type of the resource. example: example_value etag: type: string readOnly: true description: Resource ETag. example: example_value kind: type: string description: The kind (type) of cognitive service account. Examples include OpenAI, TextAnalytics, ComputerVision, SpeechServices, etc. example: example_value sku: $ref: '#/components/schemas/Sku' identity: $ref: '#/components/schemas/Identity' location: type: string description: The geo-location where the resource lives. example: example_value tags: type: object additionalProperties: type: string description: Resource tags. example: example_value properties: $ref: '#/components/schemas/AccountProperties' required: - location NetworkRuleSet: type: object description: A set of rules governing the network accessibility. properties: defaultAction: type: string enum: - Allow - Deny description: The default action when no rule matches. example: Allow ipRules: type: array items: type: object properties: value: type: string description: An IPv4 address range in CIDR notation. description: The list of IP address rules. example: [] virtualNetworkRules: type: array items: type: object properties: id: type: string description: Full resource ID of a vnet subnet. state: type: string ignoreMissingVnetServiceEndpoint: type: boolean description: The list of virtual network rules. example: [] AccountListResult: type: object description: The list of cognitive services accounts. properties: value: type: array items: $ref: '#/components/schemas/Account' description: An array of cognitive services accounts. example: [] nextLink: type: string description: The link used to get the next page of accounts. example: example_value ErrorResponse: type: object description: Error response. properties: error: type: object description: The error object. properties: code: type: string message: type: string target: type: string details: type: array items: type: object properties: code: type: string message: type: string target: type: string additionalInfo: type: array items: type: object properties: type: type: string info: type: object example: example_value Identity: type: object description: Identity for the resource. properties: principalId: type: string readOnly: true example: '500123' tenantId: type: string readOnly: true example: '500123' type: type: string enum: - None - SystemAssigned - UserAssigned - SystemAssigned, UserAssigned example: None userAssignedIdentities: type: object additionalProperties: type: object properties: principalId: type: string readOnly: true clientId: type: string readOnly: true example: example_value parameters: AccountNameParameter: name: accountName in: path required: true description: The name of the Cognitive Services account. schema: type: string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ SubscriptionIdParameter: name: subscriptionId in: path required: true description: The ID of the target subscription. schema: type: string format: uuid ResourceGroupNameParameter: name: resourceGroupName in: path required: true description: The name of the resource group. schema: type: string minLength: 1 maxLength: 90 ApiVersionParameter: name: api-version in: query required: true description: The API version to use for this operation. schema: type: string default: 2024-04-01-preview definitions: CreateComputePolicyWithAccountParameters: required: - name - properties properties: name: type: string description: The unique name of the compute policy to create. properties: x-ms-client-flatten: true $ref: '#/definitions/CreateOrUpdateComputePolicyProperties' description: The compute policy properties to use when creating a new compute policy. description: The parameters used to create a new compute policy while creating a new Data Lake Analytics account. HiveMetastore: allOf: - $ref: '#/definitions/SubResource' properties: properties: readOnly: true x-ms-client-flatten: true $ref: '#/definitions/HiveMetastoreProperties' description: The HiveMetastoreProperties rule properties. VirtualNetworkRule: allOf: - $ref: '#/definitions/SubResource' properties: properties: readOnly: true x-ms-client-flatten: true $ref: '#/definitions/VirtualNetworkRuleProperties' description: The VirtualNetwork rule properties. description: Data Lake Analytics VirtualNetwork Rule information. AccountsListResponse: type: object properties: value: type: array items: $ref: '#/definitions/AccountResource' x-cadl-name: AccountResource[] description: The AccountResource items on this page nextLink: type: string format: uri description: The link to the next page of items x-cadl-name: Rest.ResourceLocation description: Response of get all accounts Operation. required: - value MapsAccountSasToken: description: A new Sas token which can be used to access the Maps REST APIs and is controlled by the specified Managed identity permissions on Azure (IAM) Role Based Access Control. type: object properties: accountSasToken: type: string readOnly: true description: The shared access signature access token. AccessTokenState: type: string description: The access-token state. enum: - Active - Expired x-ms-enum: name: AccessTokenState modelAsString: true values: - name: Active value: Active description: The access-token is Active. - name: Expired value: Expired description: The access-token is Expired. AccountProperties_2: type: object description: Account resource properties. properties: dashboardUri: type: string format: uri description: The Playwright testing dashboard URI for the account resource. readOnly: true regionalAffinity: type: string description: This property sets the connection region for Playwright client workers to cloud-hosted browsers. If enabled, workers connect to browsers in the closest Azure region, ensuring lower latency. If disabled, workers connect to browsers in the Azure region in which the workspace was initially created. default: Enabled enum: - Enabled - Disabled x-ms-enum: name: EnablementStatus modelAsString: true values: - name: Enabled value: Enabled description: The feature is Enabled. - name: Disabled value: Disabled description: The feature is Disabled. scalableExecution: type: string description: When enabled, Playwright client workers can connect to cloud-hosted browsers. This can increase the number of parallel workers for a test run, significantly minimizing test completion durations. default: Enabled enum: - Enabled - Disabled x-ms-enum: name: EnablementStatus modelAsString: true values: - name: Enabled value: Enabled description: The feature is Enabled. - name: Disabled value: Disabled description: The feature is Disabled. reporting: type: string description: When enabled, this feature allows the workspace to upload and display test results, including artifacts like traces and screenshots, in the Playwright portal. This enables faster and more efficient troubleshooting. default: Disabled enum: - Enabled - Disabled x-ms-enum: name: EnablementStatus modelAsString: true values: - name: Enabled value: Enabled description: The feature is Enabled. - name: Disabled value: Disabled description: The feature is Disabled. provisioningState: $ref: '#/definitions/ProvisioningState' description: The status of the last operation. readOnly: true CreateFirewallRuleWithAccountParameters_2: required: - name - properties properties: name: type: string description: The unique name of the firewall rule to create. properties: x-ms-client-flatten: true $ref: '#/definitions/CreateOrUpdateFirewallRuleProperties' description: The firewall rule properties to use when creating a new firewall rule. description: The parameters used to create a new firewall rule while creating a new Data Lake Store account. Azure.Core.Foundations.Error: type: object description: The error object. properties: code: type: string description: One of a server-defined set of error codes. message: type: string description: A human-readable representation of the error. target: type: string description: The target of the error. details: type: array description: An array of details about specific errors that led to this reported error. items: $ref: '#/definitions/Azure.Core.Foundations.Error' x-ms-identifiers: [] innererror: $ref: '#/definitions/Azure.Core.Foundations.InnerError' description: An object containing more specific information than the current object about the error. required: - code - message FirewallRule_2: allOf: - $ref: '#/definitions/SubResource' properties: properties: readOnly: true x-ms-client-flatten: true $ref: '#/definitions/FirewallRuleProperties' description: The firewall rule properties. description: Data Lake Store firewall rule information. HiveMetastoreProperties: properties: serverUri: readOnly: true type: string description: The serverUri for the Hive MetaStore databaseName: readOnly: true type: string description: The databaseName for the Hive MetaStore runtimeVersion: readOnly: true type: string description: The runtimeVersion for the Hive MetaStore userName: readOnly: true type: string description: The userName for the Hive MetaStore password: readOnly: true type: string description: The password for the Hive MetaStore nestedResourceProvisioningState: readOnly: true $ref: '#/definitions/NestedResourceProvisioningState' description: The current state of the NestedResource description: The HiveMetastore properties. Tags: type: object description: Resource tags properties: tags: type: object additionalProperties: type: string x-ms-mutability: - read - create - update description: Resource tags Azure.Core.Foundations.ErrorResponse: type: object description: A response containing error details. properties: error: $ref: '#/definitions/Azure.Core.Foundations.Error' description: The error object. required: - error DataLakeStoreAccountPropertiesBasic: properties: accountId: readOnly: true type: string format: uuid description: The unique identifier associated with this Data Lake Store account. provisioningState: readOnly: true type: string enum: - Failed - Creating - Running - Succeeded - Patching - Suspending - Resuming - Deleting - Deleted - Undeleting - Canceled x-ms-enum: name: DataLakeStoreAccountStatus modelAsString: false description: The provisioning status of the Data Lake Store account. state: readOnly: true type: string enum: - Active - Suspended x-ms-enum: name: DataLakeStoreAccountState modelAsString: false description: The state of the Data Lake Store account. creationTime: readOnly: true type: string format: date-time description: The account creation time. lastModifiedTime: readOnly: true type: string format: date-time description: The account last modified time. endpoint: readOnly: true type: string description: The full CName endpoint for this account. description: The basic account specific properties that are associated with an underlying Data Lake Store account. SubscriptionState: type: string description: The ARM-based subscription state. enum: - Registered - Warned - Suspended - Deleted - Unregistered x-ms-enum: name: SubscriptionState modelAsString: true values: - name: Registered value: Registered description: The subscription state is Registered. - name: Warned value: Warned description: The subscription state is Warned. - name: Suspended value: Suspended description: The subscription state is Suspended. - name: Deleted value: Deleted description: The subscription state is Deleted. - name: Unregistered value: Unregistered description: The subscription state is Unregistered. MapsAccounts: description: A list of Maps Accounts. type: object properties: value: description: a Maps Account. type: array readOnly: true items: $ref: '#/definitions/MapsAccount' nextLink: description: "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use." type: string AccountUpdateParameters: description: The parameters for updating a machine learning team account. properties: tags: description: The resource tags for the machine learning team account. type: object additionalProperties: type: string properties: $ref: '#/definitions/AccountPropertiesUpdateParameters' description: The properties that the machine learning team account will be updated with. x-ms-client-flatten: true DataLakeAnalyticsAccountBasic: allOf: - $ref: '#/definitions/Resource' properties: properties: readOnly: true x-ms-client-flatten: true $ref: '#/definitions/DataLakeAnalyticsAccountPropertiesBasic' description: The properties defined by Data Lake Analytics all properties are specific to each resource provider. description: A Data Lake Analytics account object, containing all information associated with the named Data Lake Analytics account. UpdateTrustedIdProviderWithAccountParameters: required: - name properties: name: type: string description: The unique name of the trusted identity provider to update. properties: x-ms-client-flatten: true $ref: '#/definitions/UpdateTrustedIdProviderProperties' description: The trusted identity provider properties to use when updating a trusted identity provider. description: The parameters used to update a trusted identity provider while updating a Data Lake Store account. ClassicAccount: description: An Azure Video Indexer classic account. type: object properties: name: description: The account's name type: string readOnly: true example: contoso-videoanalyzer location: description: The account's location type: string example: westus id: description: The account's id type: string readOnly: true example: 462af7c5-d1f6-4b91-86e3-8bc5e8a61574 properties: description: List of classic account properties type: object x-ms-client-flatten: true $ref: '#/definitions/ClassicAccountProperties' ComputePolicyProperties: properties: objectId: readOnly: true type: string format: uuid description: The AAD object identifier for the entity to create a policy for. objectType: readOnly: true type: string enum: - User - Group - ServicePrincipal x-ms-enum: name: AADObjectType modelAsString: true description: The type of AAD object the object identifier refers to. maxDegreeOfParallelismPerJob: readOnly: true type: integer format: int32 minimum: 1 description: The maximum degree of parallelism per job this user can use to submit jobs. minPriorityPerJob: readOnly: true type: integer format: int32 minimum: 1 description: The minimum priority per job this user can use to submit jobs. description: The compute policy properties. UserClassicAccountList: properties: value: readOnly: true type: array items: $ref: '#/definitions/ClassicAccountSlim' description: List of classic account names and their location. nextLink: type: string description: URL to get the next set of operation list results if there are any. example: https://management.azure.com/{accountsOperation}?api-version={version}&%24skiptoken={token} description: The list of user classic accounts. type: object SubResource: properties: id: readOnly: true type: string description: The resource identifier. name: readOnly: true type: string description: The resource name. type: readOnly: true type: string description: The resource type. x-ms-azure-resource: true description: The resource model definition for a nested resource. Account_2: description: The EngagementFabric account required: - location - sku type: object allOf: - $ref: '#/definitions/TrackedResource' CreateOrUpdateComputePolicyProperties: required: - objectId - objectType properties: objectId: type: string format: uuid description: The AAD object identifier for the entity to create a policy for. objectType: type: string enum: - User - Group - ServicePrincipal x-ms-enum: name: AADObjectType modelAsString: true description: The type of AAD object the object identifier refers to. maxDegreeOfParallelismPerJob: type: integer format: int32 minimum: 1 description: The maximum degree of parallelism per job this user can use to submit jobs. This property, the min priority per job property, or both must be passed. minPriorityPerJob: type: integer format: int32 minimum: 1 description: The minimum priority per job this user can use to submit jobs. This property, the max degree of parallelism per job property, or both must be passed. description: The compute policy properties to use when creating a new compute policy. UpdateVirtualNetworkRuleProperties: properties: subnetId: type: string description: The resource identifier for the subnet. description: The virtual network rule properties to use when updating a virtual network rule. VirtualNetworkRuleState: readOnly: true type: string enum: - Active - NetworkSourceDeleted - Failed x-ms-enum: name: VirtualNetworkRuleState modelAsString: false description: The current state of the VirtualNetworkRule for this account. AccountTagRequest: description: The body of a Patch request to add tags to a Visual Studio account resource. type: object properties: tags: description: The custom tags of the resource. type: object additionalProperties: type: string NestedResourceProvisioningState: readOnly: true type: string enum: - Succeeded - Canceled - Failed x-ms-enum: name: NestedResourceProvisioningState modelAsString: false description: The current state of the NestedResourceProvisioning for this account. AccountUpdate: type: object description: The type used for update operations of the Account. properties: tags: type: object description: Resource tags. additionalProperties: type: string properties: $ref: '#/definitions/AccountUpdateProperties' x-ms-client-flatten: true StorageAccountProperties: description: The properties of a storage account for a machine learning team account. required: - storageAccountId - accessKey properties: storageAccountId: description: The fully qualified arm Id of the storage account. type: string accessKey: description: The access key to the storage account. type: string PagedAccessToken: type: object description: Paged collection of AccessToken items properties: value: type: array description: The AccessToken items on this page items: $ref: '#/definitions/AccessToken' nextLink: type: string format: uri description: The link to the next page of items required: - value DataLakeAnalyticsAccountListResult: properties: value: readOnly: true type: array items: $ref: '#/definitions/DataLakeAnalyticsAccountBasic' description: The results of the list operation. count: readOnly: true type: integer format: int32 description: The current number of data lake analytics accounts under this subscription. nextLink: readOnly: true type: string description: The link (url) to the next page of results. description: Data Lake Analytics account list information. AccountProperties_3: type: object description: The properties of a machine learning team account. required: - storageAccount - vsoAccountId - keyVaultId properties: vsoAccountId: description: The fully qualified arm id of the vso account to be used for this team account. type: string accountId: description: The immutable id associated with this team account. type: string readOnly: true description: description: The description of this workspace. type: string friendlyName: description: The friendly name for this workspace. This will be the workspace name in the arm id when the workspace object gets created type: string keyVaultId: description: The fully qualified arm id of the user key vault. type: string seats: description: The no of users/seats who can access this team account. This property defines the charge on the team account. type: string discoveryUri: description: The uri for this machine learning team account. type: string readOnly: true creationDate: format: date-time description: The creation date of the machine learning team account in ISO8601 format. type: string readOnly: true storageAccount: $ref: '#/definitions/StorageAccountProperties' description: The properties of the storage account for the machine learning team account. provisioningState: type: string enum: - Creating - Succeeded - Updating - Deleting - Failed x-ms-enum: name: ProvisioningState modelAsString: false readOnly: true description: The current deployment state of team account resource. The provisioningState is to indicate states for resource provisioning. CreateOrUpdateTrustedIdProviderProperties: required: - idProvider properties: idProvider: type: string description: The URL of this trusted identity provider. description: The trusted identity provider properties to use when creating a new trusted identity provider. PoolNodeCountsListResult: properties: value: type: array items: $ref: '#/definitions/PoolNodeCounts' description: A list of Compute Node counts by Pool. odata.nextLink: type: string title: The URL to get the next set of results. title: The result of listing the Compute Node counts in the Account. Kind: description: The Kind of the Maps Account. type: string enum: - Gen2 x-ms-enum: name: kind modelAsString: true SKU: description: The EngagementFabric SKU required: - name type: object properties: name: description: The name of the SKU type: string tier: description: The price tier of the SKU type: string ClassicAccountMediaServices: description: Azure Video Indexer classic account properties type: object properties: aadApplicationId: type: string description: The aad application id example: 912f96dc-1ed3-4d7d-aa67-0adef4bb68ad aadTenantId: type: string description: The aad tenant id example: 72f988bf-86f1-41ag-91ab-2d7cd061db47 connected: type: boolean description: Represents wether the media services is connected or not eventGridProviderRegistered: type: boolean description: Represents if the media services event grid is connected or not name: type: string description: The media services name example: contosoVideoanalyzerMediaServices resourceGroup: type: string description: The resource group that the media services belong to example: contoso-videoanalyzer-rg streamingEndpointStarted: type: boolean description: Represents wether the media services streaming endpoint has started subscriptionId: type: string description: The media services subscriptionId example: 586d4f48-8f08-4a4e-96b7-e1892d6dba9e KeyRank: description: The rank of the EngagementFabric account key enum: - PrimaryKey - SecondaryKey type: string x-ms-enum: name: KeyRank modelAsString: true CreateOrUpdateVirtualNetworkRuleProperties: required: - subnetId properties: subnetId: type: string description: The resource identifier for the subnet. description: The virtual network rule properties to use when creating a new virtual network rule. ErrorMessage: properties: lang: type: string title: The language code of the error message value: type: string title: The text of the message. title: An error message received in an Azure Batch error response. TrustedIdProviderProperties: properties: idProvider: readOnly: true type: string description: The URL of this trusted identity provider. description: The trusted identity provider properties. CheckNameAvailabilityParameters_2: required: - name - type properties: name: type: string description: The Data Lake Store name to check availability for. type: type: string enum: - Microsoft.DataLakeStore/accounts description: 'The resource type. Note: This should not be set by the user, as the constant value is Microsoft.DataLakeStore/accounts' description: Data Lake Store account name availability check parameters. CreateDataLakeAnalyticsAccountParameters: required: - location - properties properties: location: type: string description: The resource location. tags: type: object additionalProperties: type: string description: The resource tags. properties: x-ms-client-flatten: true $ref: '#/definitions/CreateDataLakeAnalyticsAccountProperties' description: The Data Lake Analytics account properties to use for creating. description: The parameters to use for creating a Data Lake Analytics account. UpdateFirewallRuleWithAccountParameters_2: required: - name properties: name: type: string description: The unique name of the firewall rule to update. properties: x-ms-client-flatten: true $ref: '#/definitions/UpdateFirewallRuleProperties' description: The firewall rule properties to use when updating a firewall rule. description: The parameters used to update a firewall rule while updating a Data Lake Store account. CloudErrorBody: description: Content of the default error response type: object properties: code: description: The error code type: string message: description: The error message type: string target: description: The target of the particular error type: string details: description: The list of additional details type: array items: $ref: '#/definitions/CloudErrorBody' x-ms-external: true UpdateDataLakeStoreAccountParameters: properties: tags: type: object additionalProperties: type: string description: Resource tags properties: x-ms-client-flatten: true $ref: '#/definitions/UpdateDataLakeStoreAccountProperties' description: The Data Lake Store account properties to update. description: Data Lake Store account information to update. 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 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 FirewallRule: allOf: - $ref: '#/definitions/SubResource' properties: properties: readOnly: true x-ms-client-flatten: true $ref: '#/definitions/FirewallRuleProperties' description: The firewall rule properties. description: Data Lake Analytics firewall rule information. KeyDescription: description: The description of the EngagementFabric account key type: object properties: name: description: The name of the key type: string readOnly: true rank: $ref: '#/definitions/KeyRank' description: The rank of the key readOnly: true value: description: The value of the key type: string readOnly: true TrustedIdProvider: allOf: - $ref: '#/definitions/SubResource' properties: properties: readOnly: true x-ms-client-flatten: true $ref: '#/definitions/TrustedIdProviderProperties' description: The trusted identity provider properties. description: Data Lake Store trusted identity provider information. CreateTrustedIdProviderWithAccountParameters: required: - name - properties properties: name: type: string description: The unique name of the trusted identity provider to create. properties: x-ms-client-flatten: true $ref: '#/definitions/CreateOrUpdateTrustedIdProviderProperties' description: The trusted identity provider properties to use when creating a new trusted identity provider. description: The parameters used to create a new trusted identity provider while creating a new Data Lake Store account. AccountList_3: properties: value: readOnly: true type: array items: $ref: '#/definitions/Account_6' 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. example: https://management.azure.com/{accountsOperation}?api-version={version}&%24skiptoken={token} description: The list operation response, that contains the data pools and their properties. type: object DataLakeAnalyticsAccount: allOf: - $ref: '#/definitions/Resource' properties: properties: readOnly: true x-ms-client-flatten: true $ref: '#/definitions/DataLakeAnalyticsAccountProperties' description: The properties defined by Data Lake Analytics all properties are specific to each resource provider. description: A Data Lake Analytics account object, containing all information associated with the named Data Lake Analytics account. CorsRule: type: object properties: allowedOrigins: type: array items: type: string description: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains required: - allowedOrigins description: Specifies a CORS rule for the Maps Account. BatchError: properties: code: type: string title: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: $ref: '#/definitions/ErrorMessage' title: A message describing the error, intended to be suitable for display in a user interface. values: type: array items: $ref: '#/definitions/BatchErrorDetail' title: A collection of key-value pairs containing additional details about the error. title: An error response received from the Azure Batch service. 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 UpdateVirtualNetworkRuleWithAccountParameters: required: - name properties: name: type: string description: The unique name of the virtual network rule to update. properties: x-ms-client-flatten: true $ref: '#/definitions/UpdateVirtualNetworkRuleProperties' description: The virtual network rule properties to use when updating a virtual network rule. description: The parameters used to update a virtual network rule while updating a Data Lake Store account. Resource_3: description: An Azure resource. required: - location properties: id: description: The resource ID. type: string readOnly: true name: description: The name of the resource. type: string readOnly: true type: description: The type of the resource. type: string readOnly: true location: description: The location of the resource. This cannot be changed after the resource is created. type: string tags: description: The tags of the resource. type: object additionalProperties: type: string x-ms-azure-resource: true ImageInformation: properties: nodeAgentSKUId: type: string title: The ID of the Compute Node agent SKU which the Image supports. imageReference: $ref: '#/definitions/ImageReference' title: The reference to the Azure Virtual Machine's Marketplace Image. osType: type: string title: The type of operating system (e.g. Windows or Linux) of the Image. enum: - linux - windows x-ms-enum: name: OSType modelAsString: false values: - value: linux description: The Linux operating system. - value: windows description: The Windows operating system. capabilities: type: array items: type: string title: The capabilities or features which the Image supports. description: Not every capability of the Image is listed. Capabilities in this list are considered of special interest and are generally related to integration with other features in the Azure Batch service. batchSupportEndOfLife: type: string format: date-time title: The time when the Azure Batch service will stop accepting create Pool requests for the Image. verificationType: type: string title: Whether the Azure Batch service actively verifies that the Image is compatible with the associated Compute Node agent SKU. enum: - verified - unverified x-ms-enum: name: VerificationType modelAsString: false values: - value: verified description: The Image is guaranteed to be compatible with the associated Compute Node agent SKU and all Batch features have been confirmed to work as expected. - value: unverified description: The associated Compute Node agent SKU should have binary compatibility with the Image, but specific functionality has not been verified. required: - imageReference - verificationType - osType - nodeAgentSKUId title: A reference to the Azure Virtual Machines Marketplace Image and additional information about the Image. AccountResource: type: object properties: properties: $ref: '#/definitions/AccountProperties_4' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create description: The details of a account resource. allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource CreateDataLakeAnalyticsAccountProperties: required: - defaultDataLakeStoreAccount - dataLakeStoreAccounts properties: defaultDataLakeStoreAccount: type: string description: The default Data Lake Store account associated with this account. dataLakeStoreAccounts: type: array items: $ref: '#/definitions/AddDataLakeStoreWithAccountParameters' description: The list of Data Lake Store accounts associated with this account. x-ms-identifiers: - name storageAccounts: type: array items: $ref: '#/definitions/AddStorageAccountWithAccountParameters' description: The list of Azure Blob Storage accounts associated with this account. x-ms-identifiers: - name computePolicies: type: array items: $ref: '#/definitions/CreateComputePolicyWithAccountParameters' description: The list of compute policies associated with this account. x-ms-identifiers: - name firewallRules: type: array items: $ref: '#/definitions/CreateFirewallRuleWithAccountParameters' description: The list of firewall rules associated with this account. x-ms-identifiers: - name firewallState: type: string enum: - Enabled - Disabled default: Disabled x-ms-enum: name: FirewallState modelAsString: false description: The current state of the IP address firewall for this account. firewallAllowAzureIps: type: string enum: - Enabled - Disabled default: Disabled x-ms-enum: name: FirewallAllowAzureIpsState modelAsString: false description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. newTier: type: string enum: - Consumption - Commitment_100AUHours - Commitment_500AUHours - Commitment_1000AUHours - Commitment_5000AUHours - Commitment_10000AUHours - Commitment_50000AUHours - Commitment_100000AUHours - Commitment_500000AUHours default: Consumption x-ms-enum: name: TierType modelAsString: false description: The commitment tier for the next month. maxJobCount: type: integer format: int32 minimum: 1 default: 3 description: The maximum supported jobs running under the account at the same time. maxDegreeOfParallelism: type: integer format: int32 minimum: 1 default: 30 description: The maximum supported degree of parallelism for this account. maxDegreeOfParallelismPerJob: type: integer format: int32 minimum: 1 default: 32 description: The maximum supported degree of parallelism per job for this account. minPriorityPerJob: type: integer format: int32 minimum: 1 description: The minimum supported priority per job for this account. queryStoreRetention: type: integer format: int32 minimum: 1 maximum: 180 default: 30 description: The number of days that job metadata is retained. MediaServicesForPatchRequest: description: The media services details type: object properties: userAssignedIdentity: type: string description: The user assigned identity to be used to grant permissions example: /subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoAnalyzer-mi AccountProperties_4: type: object properties: organizationId: type: string description: organization id accountId: type: string description: account id accountName: type: string description: account name region: type: string description: Region where New Relic account is present description: List of all the New relic accounts for the given user ErrorResponse: type: object description: Error response properties: error: $ref: '#/definitions/ErrorDefinition' description: The error details AddStorageAccountWithAccountParameters: required: - name - properties properties: name: type: string description: The unique name of the Azure Storage account to add. properties: x-ms-client-flatten: true $ref: '#/definitions/AddStorageAccountProperties' description: The Azure Storage account properties to use when adding a new Azure Storage account. description: The parameters used to add a new Azure Storage account while creating a new Data Lake Analytics account. AddDataLakeStoreWithAccountParameters: required: - name properties: name: type: string description: The unique name of the Data Lake Store account to add. properties: x-ms-client-flatten: true $ref: '#/definitions/AddDataLakeStoreProperties' description: The Data Lake Store account properties to use when adding a new Data Lake Store account. description: The parameters used to add a new Data Lake Store account while creating a new Data Lake Analytics account. DataLakeStoreAccountInformationProperties: properties: suffix: readOnly: true type: string description: The optional suffix for the Data Lake Store account. description: The Data Lake Store account properties. UpdateDataLakeAnalyticsAccountProperties: properties: dataLakeStoreAccounts: type: array items: $ref: '#/definitions/UpdateDataLakeStoreWithAccountParameters' description: The list of Data Lake Store accounts associated with this account. x-ms-identifiers: - name storageAccounts: type: array items: $ref: '#/definitions/UpdateStorageAccountWithAccountParameters' description: The list of Azure Blob storage accounts associated with this account. x-ms-identifiers: - name computePolicies: type: array items: $ref: '#/definitions/UpdateComputePolicyWithAccountParameters' description: The list of compute policies associated with this account. x-ms-identifiers: - name firewallRules: type: array items: $ref: '#/definitions/UpdateFirewallRuleWithAccountParameters' description: The list of firewall rules associated with this account. x-ms-identifiers: - name firewallState: type: string enum: - Enabled - Disabled x-ms-enum: name: FirewallState modelAsString: false description: The current state of the IP address firewall for this account. Disabling the firewall does not remove existing rules, they will just be ignored until the firewall is re-enabled. firewallAllowAzureIps: type: string enum: - Enabled - Disabled x-ms-enum: name: FirewallAllowAzureIpsState modelAsString: false description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. newTier: type: string enum: - Consumption - Commitment_100AUHours - Commitment_500AUHours - Commitment_1000AUHours - Commitment_5000AUHours - Commitment_10000AUHours - Commitment_50000AUHours - Commitment_100000AUHours - Commitment_500000AUHours x-ms-enum: name: TierType modelAsString: false description: The commitment tier to use for next month. maxJobCount: type: integer format: int32 minimum: 1 description: The maximum supported jobs running under the account at the same time. maxDegreeOfParallelism: type: integer format: int32 minimum: 1 description: The maximum supported degree of parallelism for this account. maxDegreeOfParallelismPerJob: type: integer format: int32 minimum: 1 description: The maximum supported degree of parallelism per job for this account. minPriorityPerJob: type: integer format: int32 minimum: 1 description: The minimum supported priority per job for this account. queryStoreRetention: type: integer format: int32 minimum: 1 maximum: 180 description: The number of days that job metadata is retained. description: The properties to update that are associated with an underlying Data Lake Analytics account. CreateDataLakeStoreAccountParameters: required: - location properties: location: type: string description: The resource location. tags: type: object additionalProperties: type: string description: The resource tags. identity: $ref: '#/definitions/EncryptionIdentity' description: The Key Vault encryption identity, if any. properties: x-ms-client-flatten: true $ref: '#/definitions/CreateDataLakeStoreAccountProperties' description: The Data Lake Store account properties to use for creating. LinkedResource: type: object properties: uniqueName: type: string description: A provided name which uniquely identifies the linked resource. id: type: string description: 'ARM resource id in the form: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/accounts/{storageName}''.' required: - uniqueName - id description: Linked resource is reference to a resource deployed in an Azure subscription, add the linked resource `uniqueName` value as an optional parameter for operations on Azure Maps Geospatial REST APIs. DataLakeStoreAccountInformation: allOf: - $ref: '#/definitions/SubResource' properties: properties: x-ms-client-flatten: true $ref: '#/definitions/DataLakeStoreAccountInformationProperties' description: The Data Lake Store account properties. description: Data Lake Store account information. AccountState: type: string description: The account state. enum: - Active - Inactive x-ms-enum: name: AccountState modelAsString: true values: - name: Active value: Active description: The account is Active. - name: Inactive value: Inactive description: The account is Inactive. ChannelTypeDescription: description: EngagementFabric channel description type: object properties: channelType: description: Channel type type: string channelDescription: description: Text description for the channel type: string channelFunctions: description: All the available functions for the channel type: array items: type: string AccountListResult_2: description: The result of a request to list machine learning team accounts. properties: value: description: The list of machine learning team accounts. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning team accounts. type: array items: $ref: '#/definitions/Account_5' nextLink: description: The URI that can be used to request the next list of machine learning team accounts. type: string Azure.Core.uuid: type: string format: uuid description: Universally Unique Identifier ComputePolicy: allOf: - $ref: '#/definitions/SubResource' properties: properties: readOnly: true x-ms-client-flatten: true $ref: '#/definitions/ComputePolicyProperties' description: The compute policy properties. description: Data Lake Analytics compute policy information. KeyDescriptionList: description: The list of the EngagementFabric account keys type: object properties: value: description: Account keys type: array items: $ref: '#/definitions/KeyDescription' readOnly: true Locations: description: The list of data processing locations for the Maps Account. type: array items: description: Data processing location. type: object properties: locationName: type: string description: The location name. required: - locationName x-ms-identifiers: - locationName CorsRules: type: object properties: corsRules: type: array maxItems: 5 items: description: Specifies a CORS rule for the Maps Account. $ref: '#/definitions/CorsRule' x-ms-identifiers: [] description: 'The list of CORS rules. You can include up to five CorsRule elements in the request. ' description: 'Sets the CORS rules. You can include up to five CorsRule elements in the request. ' ChannelTypeDescriptionList: description: List of the EngagementFabric channel descriptions type: object properties: value: description: Channel descriptions type: array items: $ref: '#/definitions/ChannelTypeDescription' StorageAccountInformation: allOf: - $ref: '#/definitions/SubResource' properties: properties: readOnly: true x-ms-client-flatten: true $ref: '#/definitions/StorageAccountInformationProperties' description: The Azure Storage account properties. description: Azure Storage account information. MapsAccountKeys: description: The set of keys which can be used to access the Maps REST APIs. Two keys are provided for key rotation without interruption. type: object properties: primaryKeyLastUpdated: type: string readOnly: true description: The last updated date and time of the primary key. primaryKey: type: string readOnly: true description: The primary key for accessing the Maps REST APIs. secondaryKey: type: string readOnly: true description: The secondary key for accessing the Maps REST APIs. secondaryKeyLastUpdated: type: string readOnly: true description: The last updated date and time of the secondary key. UpdateDataLakeStoreAccountProperties: properties: defaultGroup: type: string description: The default owner group for all new folders and files created in the Data Lake Store account. encryptionConfig: $ref: '#/definitions/UpdateEncryptionConfig' description: Used for rotation of user managed Key Vault keys. Can only be used to rotate a user managed encryption Key Vault key. firewallRules: type: array items: $ref: '#/definitions/UpdateFirewallRuleWithAccountParameters_2' description: The list of firewall rules associated with this Data Lake Store account. x-ms-identifiers: - name virtualNetworkRules: type: array items: $ref: '#/definitions/UpdateVirtualNetworkRuleWithAccountParameters' description: The list of virtual network rules associated with this Data Lake Store account. x-ms-identifiers: - name firewallState: type: string enum: - Enabled - Disabled x-ms-enum: name: FirewallState modelAsString: false description: The current state of the IP address firewall for this Data Lake Store account. Disabling the firewall does not remove existing rules, they will just be ignored until the firewall is re-enabled. firewallAllowAzureIps: type: string enum: - Enabled - Disabled x-ms-enum: name: FirewallAllowAzureIpsState modelAsString: false description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. trustedIdProviders: type: array items: $ref: '#/definitions/UpdateTrustedIdProviderWithAccountParameters' description: The list of trusted identity providers associated with this Data Lake Store account. x-ms-identifiers: - name trustedIdProviderState: type: string enum: - Enabled - Disabled x-ms-enum: name: TrustedIdProviderState modelAsString: false description: The current state of the trusted identity provider feature for this Data Lake Store account. Disabling trusted identity provider functionality does not remove the providers, they will just be ignored until this feature is re-enabled. newTier: type: string enum: - Consumption - Commitment_1TB - Commitment_10TB - Commitment_100TB - Commitment_500TB - Commitment_1PB - Commitment_5PB x-ms-enum: name: TierType modelAsString: false description: The commitment tier to use for next month. description: Data Lake Store account properties information to be updated. 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' AccountPatch_2: description: The patch of EngagementFabric account type: object properties: tags: description: The tags of the resource type: object additionalProperties: type: string DataLakeAnalyticsAccountProperties: allOf: - $ref: '#/definitions/DataLakeAnalyticsAccountPropertiesBasic' properties: defaultDataLakeStoreAccountType: readOnly: true type: string description: The type of the default Data Lake Store account associated with this account. defaultDataLakeStoreAccount: readOnly: true type: string description: The default Data Lake Store account associated with this account. dataLakeStoreAccounts: readOnly: true type: array items: $ref: '#/definitions/DataLakeStoreAccountInformation' description: The list of Data Lake Store accounts associated with this account. publicDataLakeStoreAccounts: type: array items: $ref: '#/definitions/DataLakeStoreAccountInformation' description: The list of Data Lake Store accounts associated with this account. storageAccounts: readOnly: true type: array items: $ref: '#/definitions/StorageAccountInformation' description: The list of Azure Blob Storage accounts associated with this account. computePolicies: readOnly: true type: array items: $ref: '#/definitions/ComputePolicy' description: The list of compute policies associated with this account. hiveMetastores: readOnly: true type: array items: $ref: '#/definitions/HiveMetastore' description: The list of hiveMetastores associated with this account. virtualNetworkRules: readOnly: true type: array items: $ref: '#/definitions/VirtualNetworkRule' description: The list of virtualNetwork rules associated with this account. firewallRules: readOnly: true type: array items: $ref: '#/definitions/FirewallRule' description: The list of firewall rules associated with this account. firewallState: type: string enum: - Enabled - Disabled x-ms-enum: name: FirewallState modelAsString: false description: The current state of the IP address firewall for this account. firewallAllowAzureIps: type: string enum: - Enabled - Disabled x-ms-enum: name: FirewallAllowAzureIpsState modelAsString: false description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. newTier: type: string enum: - Consumption - Commitment_100AUHours - Commitment_500AUHours - Commitment_1000AUHours - Commitment_5000AUHours - Commitment_10000AUHours - Commitment_50000AUHours - Commitment_100000AUHours - Commitment_500000AUHours x-ms-enum: name: TierType modelAsString: false description: The commitment tier for the next month. currentTier: readOnly: true type: string enum: - Consumption - Commitment_100AUHours - Commitment_500AUHours - Commitment_1000AUHours - Commitment_5000AUHours - Commitment_10000AUHours - Commitment_50000AUHours - Commitment_100000AUHours - Commitment_500000AUHours x-ms-enum: name: TierType modelAsString: false description: The commitment tier in use for the current month. maxJobCount: type: integer format: int32 minimum: 1 default: 3 description: The maximum supported jobs running under the account at the same time. maxActiveJobCountPerUser: readOnly: true type: integer format: int32 description: The maximum supported active jobs under the account at the same time. maxQueuedJobCountPerUser: readOnly: true type: integer format: int32 description: The maximum supported jobs queued under the account at the same time. maxJobRunningTimeInMin: readOnly: true type: integer format: int32 description: The maximum supported active jobs under the account at the same time. systemMaxJobCount: readOnly: true type: integer format: int32 description: The system defined maximum supported jobs running under the account at the same time, which restricts the maximum number of running jobs the user can set for the account. maxDegreeOfParallelism: type: integer format: int32 minimum: 1 default: 30 description: The maximum supported degree of parallelism for this account. systemMaxDegreeOfParallelism: readOnly: true type: integer format: int32 description: The system defined maximum supported degree of parallelism for this account, which restricts the maximum value of parallelism the user can set for the account. maxDegreeOfParallelismPerJob: type: integer format: int32 minimum: 1 description: The maximum supported degree of parallelism per job for this account. minPriorityPerJob: readOnly: true type: integer format: int32 minimum: 1 description: The minimum supported priority per job for this account. queryStoreRetention: type: integer format: int32 minimum: 1 maximum: 180 default: 30 description: The number of days that job metadata is retained. debugDataAccessLevel: readOnly: true type: string enum: - All - Customer - None x-ms-enum: name: DebugDataAccessLevel modelAsString: false description: The current state of the DebugDataAccessLevel for this account. description: The account specific properties that are associated with an underlying Data Lake Analytics account. Returned only when retrieving a specific account. AddStorageAccountProperties: required: - accessKey properties: accessKey: type: string description: The access key associated with this Azure Storage account that will be used to connect to it. suffix: type: string default: azuredatalakestore.net description: The optional suffix for the storage account. description: The Azure Storage account properties to use when adding a new Azure Storage account. DataLakeStoreAccountProperties: allOf: - $ref: '#/definitions/DataLakeStoreAccountPropertiesBasic' properties: defaultGroup: readOnly: true type: string description: The default owner group for all new folders and files created in the Data Lake Store account. encryptionConfig: readOnly: true $ref: '#/definitions/EncryptionConfig' description: The Key Vault encryption configuration. encryptionState: readOnly: true type: string enum: - Enabled - Disabled x-ms-enum: name: EncryptionState modelAsString: false description: The current state of encryption for this Data Lake Store account. encryptionProvisioningState: readOnly: true type: string enum: - Creating - Succeeded x-ms-enum: name: EncryptionProvisioningState modelAsString: false description: The current state of encryption provisioning for this Data Lake Store account. firewallRules: readOnly: true type: array items: $ref: '#/definitions/FirewallRule_2' description: The list of firewall rules associated with this Data Lake Store account. virtualNetworkRules: readOnly: true type: array items: $ref: '#/definitions/VirtualNetworkRule_2' description: The list of virtual network rules associated with this Data Lake Store account. firewallState: readOnly: true type: string enum: - Enabled - Disabled x-ms-enum: name: FirewallState modelAsString: false description: The current state of the IP address firewall for this Data Lake Store account. firewallAllowAzureIps: readOnly: true type: string enum: - Enabled - Disabled x-ms-enum: name: FirewallAllowAzureIpsState modelAsString: false description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. trustedIdProviders: readOnly: true type: array items: $ref: '#/definitions/TrustedIdProvider' description: The list of trusted identity providers associated with this Data Lake Store account. trustedIdProviderState: readOnly: true type: string enum: - Enabled - Disabled x-ms-enum: name: TrustedIdProviderState modelAsString: false description: The current state of the trusted identity provider feature for this Data Lake Store account. newTier: readOnly: true type: string enum: - Consumption - Commitment_1TB - Commitment_10TB - Commitment_100TB - Commitment_500TB - Commitment_1PB - Commitment_5PB x-ms-enum: name: TierType modelAsString: false description: The commitment tier to use for next month. currentTier: readOnly: true type: string enum: - Consumption - Commitment_1TB - Commitment_10TB - Commitment_100TB - Commitment_500TB - Commitment_1PB - Commitment_5PB x-ms-enum: name: TierType modelAsString: false description: The commitment tier in use for the current month. description: Data Lake Store account properties information. KeyVaultMetaInfo: required: - keyVaultResourceId - encryptionKeyName - encryptionKeyVersion properties: keyVaultResourceId: type: string description: The resource identifier for the user managed Key Vault being used to encrypt. encryptionKeyName: type: string description: The name of the user managed encryption key. encryptionKeyVersion: type: string description: The version of the user managed encryption key. description: Metadata information used by account encryption. 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 Resource: properties: id: readOnly: true type: string description: The resource identifier. name: readOnly: true type: string description: The resource name. type: readOnly: true type: string description: The resource type. location: readOnly: true type: string description: The resource location. tags: readOnly: true type: object additionalProperties: type: string description: The resource tags. x-ms-azure-resource: true description: The resource model definition. StorageAccountInformationProperties: properties: suffix: readOnly: true type: string description: The optional suffix for the storage account. description: The Azure Storage account properties. ImageReference: properties: publisher: type: string title: The publisher of the Azure Virtual Machines Marketplace Image. description: For example, Canonical or MicrosoftWindowsServer. offer: type: string title: The offer type of the Azure Virtual Machines Marketplace Image. description: For example, UbuntuServer or WindowsServer. sku: type: string title: The SKU of the Azure Virtual Machines Marketplace Image. description: For example, 18.04-LTS or 2019-Datacenter. version: type: string title: The version of the Azure Virtual Machines Marketplace Image. description: A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'. virtualMachineImageId: type: string title: The ARM resource identifier of the Shared Image Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. description: This property is mutually exclusive with other ImageReference properties. The Shared Image Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. title: A reference to an Azure Virtual Machines Marketplace Image or a Shared Image Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the 'List Supported Images' operation. AccountSasParameters: description: Parameters used to create an account Shared Access Signature (SAS) token. The REST API access control is provided by Azure Maps Role Based Access (RBAC) identity and access. type: object properties: signingKey: type: string description: The Maps account key to use for signing. Picking `primaryKey` or `secondaryKey` will use the Maps account Shared Keys, and using `managedIdentity` will use the auto-renewed private key to sign the SAS. enum: - primaryKey - secondaryKey - managedIdentity x-ms-enum: name: SigningKey modelAsString: true principalId: description: The principal Id also known as the object Id of a User Assigned Managed Identity currently assigned to the Maps Account. To assign a Managed Identity of the account, use operation Create or Update an assign a User Assigned Identity resource Id. type: string regions: type: array items: type: string description: 'Optional, allows control of which region locations are permitted access to Azure Maps REST APIs with the SAS token. Example: "eastus", "westus2". Omitting this parameter will allow all region locations to be accessible.' maxRatePerSecond: type: integer minimum: 0 maximum: 500 default: 500 format: int32 exclusiveMinimum: true description: Required parameter which represents the desired maximum request per second to allowed for the given SAS token. This does not guarantee perfect accuracy in measurements but provides application safe guards of abuse with eventual enforcement. start: description: The date time offset of when the token validity begins. For example "2017-05-24T10:42:03.1567373Z". Maximum duration allowed is 24 hours between `start` and `expiry`. type: string expiry: description: The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z". Maximum duration allowed is 24 hours between `start` and `expiry`. type: string required: - signingKey - principalId - maxRatePerSecond - start - expiry UpdateFirewallRuleProperties: properties: startIpAddress: type: string description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. endIpAddress: type: string description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. description: The firewall rule properties to use when updating a firewall rule. EncryptionConfig: required: - type properties: type: type: string enum: - UserManaged - ServiceManaged x-ms-enum: name: EncryptionConfigType modelAsString: false description: The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. keyVaultMetaInfo: $ref: '#/definitions/KeyVaultMetaInfo' description: The Key Vault information for connecting to user managed encryption keys. description: The encryption configuration for the account. CheckNameAvailabilityParameter: description: The body of a POST request to check name availability. type: object properties: resourceName: description: The name of the resource to check availability for. type: string resourceType: description: The type of resource to check availability for. type: string UpdateTrustedIdProviderProperties: properties: idProvider: type: string description: The URL of this trusted identity provider. description: The trusted identity provider properties to use when updating a trusted identity provider. PoolNodeCounts: properties: poolId: type: string title: The ID of the Pool. dedicated: $ref: '#/definitions/NodeCounts' title: The number of dedicated Compute Nodes in each state. lowPriority: $ref: '#/definitions/NodeCounts' title: The number of low priority Compute Nodes in each state. required: - poolId title: The number of Compute Nodes in each state for a Pool. CreateDataLakeStoreAccountProperties: properties: defaultGroup: type: string description: The default owner group for all new folders and files created in the Data Lake Store account. encryptionConfig: $ref: '#/definitions/EncryptionConfig' description: The Key Vault encryption configuration. encryptionState: type: string enum: - Enabled - Disabled x-ms-enum: name: EncryptionState modelAsString: false description: The current state of encryption for this Data Lake Store account. firewallRules: type: array items: $ref: '#/definitions/CreateFirewallRuleWithAccountParameters_2' description: The list of firewall rules associated with this Data Lake Store account. x-ms-identifiers: - name virtualNetworkRules: type: array items: $ref: '#/definitions/CreateVirtualNetworkRuleWithAccountParameters' description: The list of virtual network rules associated with this Data Lake Store account. x-ms-identifiers: - name firewallState: type: string enum: - Enabled - Disabled x-ms-enum: name: FirewallState modelAsString: false description: The current state of the IP address firewall for this Data Lake Store account. firewallAllowAzureIps: type: string enum: - Enabled - Disabled x-ms-enum: name: FirewallAllowAzureIpsState modelAsString: false description: The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. trustedIdProviders: type: array items: $ref: '#/definitions/CreateTrustedIdProviderWithAccountParameters' description: The list of trusted identity providers associated with this Data Lake Store account. x-ms-identifiers: - name trustedIdProviderState: type: string enum: - Enabled - Disabled x-ms-enum: name: TrustedIdProviderState modelAsString: false description: The current state of the trusted identity provider feature for this Data Lake Store account. newTier: type: string enum: - Consumption - Commitment_1TB - Commitment_10TB - Commitment_100TB - Commitment_500TB - Commitment_1PB - Commitment_5PB x-ms-enum: name: TierType modelAsString: false description: The commitment tier to use for next month. UpdateDataLakeStoreProperties: properties: suffix: type: string description: The optional suffix for the Data Lake Store account. description: The Data Lake Store account properties to use when updating a Data Lake Store account. ClassicAccountProperties: description: Azure Video Indexer classic account properties type: object properties: mediaServices: description: The media services details type: object $ref: '#/definitions/ClassicAccountMediaServices' AccountList_2: description: The list of the EngagementFabric accounts type: object properties: value: description: EngagementFabric accounts type: array items: $ref: '#/definitions/Account_2' NodeCounts: properties: creating: type: integer format: int32 title: The number of Compute Nodes in the creating state. idle: type: integer format: int32 title: The number of Compute Nodes in the idle state. offline: type: integer format: int32 title: The number of Compute Nodes in the offline state. preempted: type: integer format: int32 title: The number of Compute Nodes in the preempted state. rebooting: type: integer format: int32 title: The count of Compute Nodes in the rebooting state. reimaging: type: integer format: int32 title: The number of Compute Nodes in the reimaging state. running: type: integer format: int32 title: The number of Compute Nodes in the running state. starting: type: integer format: int32 title: The number of Compute Nodes in the starting state. startTaskFailed: type: integer format: int32 title: The number of Compute Nodes in the startTaskFailed state. leavingPool: type: integer format: int32 title: The number of Compute Nodes in the leavingPool state. unknown: type: integer format: int32 title: The number of Compute Nodes in the unknown state. unusable: type: integer format: int32 title: The number of Compute Nodes in the unusable state. waitingForStartTask: type: integer format: int32 title: The number of Compute Nodes in the waitingForStartTask state. total: type: integer format: int32 title: The total number of Compute Nodes. required: - creating - idle - offline - preempted - rebooting - reimaging - running - starting - startTaskFailed - leavingPool - unknown - unusable - waitingForStartTask - total title: The number of Compute Nodes in each Compute Node state. MapsKeySpecification: description: Whether the operation refers to the primary or secondary key. type: object required: - keyType properties: keyType: type: string enum: - primary - secondary x-ms-enum: name: KeyType modelAsString: true description: Whether the operation refers to the primary or secondary key. Azure.Core.Foundations.InnerError: type: object description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. properties: code: type: string description: One of a server-defined set of error codes. innererror: $ref: '#/definitions/Azure.Core.Foundations.InnerError' description: Inner error. AccountListSupportedImagesResult: properties: value: type: array items: $ref: '#/definitions/ImageInformation' title: The list of supported Virtual Machine Images. odata.nextLink: type: string title: The URL to get the next set of results. title: The result of listing the supported Virtual Machine Images. UpdateComputePolicyWithAccountParameters: required: - name properties: name: type: string description: The unique name of the compute policy to update. properties: x-ms-client-flatten: true $ref: '#/definitions/UpdateComputePolicyProperties' description: The compute policy properties to use when updating a compute policy. description: The parameters used to update a compute policy while updating a Data Lake Analytics account. MapsAccountUpdateParameters: description: Parameters used to update an existing Maps Account. type: object properties: tags: type: object additionalProperties: type: string description: Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. kind: description: Get or Set Kind property. $ref: '#/definitions/Kind' sku: description: The SKU of this account. $ref: '#/definitions/Sku' identity: $ref: ../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity properties: description: The map account properties. x-ms-client-flatten: true $ref: '#/definitions/MapsAccountProperties' UpdateEncryptionConfig: properties: keyVaultMetaInfo: $ref: '#/definitions/UpdateKeyVaultMetaInfo' description: The updated Key Vault key to use in user managed key rotation. description: The encryption configuration used to update a user managed Key Vault key. NameAvailabilityInformation: properties: nameAvailable: readOnly: true type: boolean description: The Boolean value of true or false to indicate whether the Data Lake Analytics account name is available or not. reason: readOnly: true type: string description: The reason why the Data Lake Analytics account name is not available, if nameAvailable is false. message: readOnly: true type: string description: The message describing why the Data Lake Analytics account name is not available, if nameAvailable is false. description: Data Lake Analytics account name availability result information. 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 CreateVirtualNetworkRuleWithAccountParameters: required: - name - properties properties: name: type: string description: The unique name of the virtual network rule to create. properties: x-ms-client-flatten: true $ref: '#/definitions/CreateOrUpdateVirtualNetworkRuleProperties' description: The virtual network rule properties to use when creating a new virtual network rule. description: The parameters used to create a new virtual network rule while creating a new Data Lake Store account. AccountPropertiesForPutRequest: description: Azure Video Indexer account properties type: object properties: tenantId: description: The account's tenant id type: string readOnly: true example: 2b9bcf6d-39d5-460a-a6bb-7b40b7ccf139 accountId: description: The account's data-plane ID. This can be set only when connecting an existing classic account type: string default: 00000000-0000-0000-0000-000000000000 example: 3575690b-a569-449c-ab7b-11020f948f76 accountName: description: The account's name type: string readOnly: true example: contoso-videoAnalyzer mediaServices: description: The media services details type: object $ref: '#/definitions/MediaServicesForPutRequest' totalSecondsIndexed: description: An integer representing the total seconds that have been indexed on the account type: integer format: int32 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 Resource_2: description: The base model for Azure resource type: object properties: id: description: The ID of the resource type: string readOnly: true name: description: The name of the resource type: string readOnly: true type: description: The fully qualified type of the resource type: string readOnly: true x-ms-azure-resource: true CreateOrUpdateFirewallRuleProperties: required: - startIpAddress - endIpAddress properties: startIpAddress: type: string description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. endIpAddress: type: string description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. description: The firewall rule properties to use when creating a new firewall rule. Account_4: type: object description: An account is a parent resource for most of the other service resources. It's directly mapped to an ARM resource and helps to create a link between control-plane and data-plane resources. properties: id: type: string description: The account id. readOnly: true resourceId: type: string description: The ARM fully-qualified resource id for the account. readOnly: true name: type: string description: The account name. readOnly: true state: $ref: '#/definitions/AccountState' description: The state of account - Active | Inactive readOnly: true subscriptionId: $ref: '#/definitions/Azure.Core.uuid' description: The ARM-based subscription id for the account. readOnly: true subscriptionState: $ref: '#/definitions/SubscriptionState' description: The ARM-based subscription state - Registered | Unregistered | Warned | Suspended | Deleted readOnly: true tenantId: $ref: '#/definitions/Azure.Core.uuid' description: The Azure tenant id of the account. readOnly: true location: type: string description: The account resource ARM location, for eg. eastus, southeastasia. readOnly: true regionalAffinity: type: string description: This property sets the connection region for Playwright client workers to cloud-hosted browsers. If enabled, workers connect to browsers in the closest Azure region, ensuring lower latency. If disabled, workers connect to browsers in the Azure region in which the workspace was initially created. default: Enabled enum: - Enabled - Disabled x-ms-enum: name: EnablementStatus modelAsString: true values: - name: Enabled value: Enabled description: The feature is Enabled. - name: Disabled value: Disabled description: The feature is Disabled. readOnly: true scalableExecution: type: string description: When enabled, Playwright client workers can connect to cloud-hosted browsers. This can increase the number of parallel workers for a test run, significantly minimizing test completion durations. default: Enabled enum: - Enabled - Disabled x-ms-enum: name: EnablementStatus modelAsString: true values: - name: Enabled value: Enabled description: The feature is Enabled. - name: Disabled value: Disabled description: The feature is Disabled. readOnly: true reporting: type: string description: When enabled, this feature allows the workspace to upload and display test results, including artifacts like traces and screenshots, in the Playwright portal. This enables faster and more efficient troubleshooting. default: Disabled enum: - Enabled - Disabled x-ms-enum: name: EnablementStatus modelAsString: true values: - name: Enabled value: Enabled description: The feature is Enabled. - name: Disabled value: Disabled description: The feature is Disabled. readOnly: true required: - id - resourceId - name - state - subscriptionId - subscriptionState - tenantId - location VirtualNetworkRuleProperties: properties: subnetId: readOnly: true type: string description: The resource identifier for the subnet virtualNetworkRuleState: readOnly: true $ref: '#/definitions/VirtualNetworkRuleState' description: The current state of the VirtualNetwork Rule description: The VirtualNetwork Rule properties. Account_5: type: object description: An object that represents a machine learning team account. allOf: - $ref: '#/definitions/Resource_3' properties: properties: $ref: '#/definitions/AccountProperties_3' description: The properties of the machine learning team account. x-ms-client-flatten: true AddDataLakeStoreProperties: properties: suffix: type: string description: The optional suffix for the Data Lake Store account. description: The Data Lake Store account properties to use when adding a new Data Lake Store account. AccessToken: type: object description: Model of an access-token linked to an account. properties: id: $ref: '#/definitions/Azure.Core.uuid' description: The access-token id. readOnly: true name: type: string description: The access-token name. minLength: 3 maxLength: 64 pattern: ^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$ x-ms-mutability: - read - create jwtToken: type: string description: The access-token value in JWT format. readOnly: true createdAt: type: string format: date-time description: The access-token createdAt utcDateTime. readOnly: true expiryAt: type: string format: date-time description: The access-token expiryAt utcDateTime. x-ms-mutability: - read - create state: $ref: '#/definitions/AccessTokenState' description: The access-token state - Active | Expired. readOnly: true required: - id - name - expiryAt Account_6: description: An Azure Video Indexer account. type: object properties: properties: description: List of account properties type: object x-ms-client-flatten: true $ref: '#/definitions/AccountPropertiesForPutRequest' identity: $ref: ../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity systemData: readOnly: true description: The system meta data relating to this resource. $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource UpdateDataLakeStoreWithAccountParameters: required: - name properties: name: type: string description: The unique name of the Data Lake Store account to update. properties: x-ms-client-flatten: true $ref: '#/definitions/UpdateDataLakeStoreProperties' description: The Data Lake Store account properties to use when updating a Data Lake Store account. description: The parameters used to update a Data Lake Store account while updating a Data Lake Analytics account. VirtualNetworkRuleProperties_2: properties: subnetId: readOnly: true type: string description: The resource identifier for the subnet. description: The virtual network rule properties. AccountResource_2: description: The response to an account resource GET request. type: object allOf: - $ref: '#/definitions/Resource_4' properties: properties: description: Resource properties. type: object additionalProperties: type: string x-ms-client-flatten: true DataLakeAnalyticsAccountPropertiesBasic: properties: accountId: readOnly: true type: string format: uuid description: The unique identifier associated with this Data Lake Analytics account. provisioningState: readOnly: true type: string enum: - Failed - Creating - Running - Succeeded - Patching - Suspending - Resuming - Deleting - Deleted - Undeleting - Canceled x-ms-enum: name: DataLakeAnalyticsAccountStatus modelAsString: false description: The provisioning status of the Data Lake Analytics account. state: readOnly: true type: string enum: - Active - Suspended x-ms-enum: name: DataLakeAnalyticsAccountState modelAsString: false description: The state of the Data Lake Analytics account. creationTime: readOnly: true type: string format: date-time description: The account creation time. lastModifiedTime: readOnly: true type: string format: date-time description: The account last modified time. endpoint: readOnly: true type: string description: The full CName endpoint for this account. description: The basic account specific properties that are associated with an underlying Data Lake Analytics account. AccountPatch_3: type: object description: Azure Video Indexer account properties: properties: description: List of account properties type: object x-ms-client-flatten: true $ref: '#/definitions/AccountPropertiesForPatchRequest' identity: $ref: ../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity allOf: - $ref: '#/definitions/Tags' Sku: description: The SKU of the Maps Account. type: object properties: name: description: The name of the SKU, in standard format (such as G2). type: string enum: - G2 x-ms-enum: name: name modelAsString: true tier: readOnly: true type: string description: Gets the sku tier. This is based on the SKU name. required: - name FirewallRuleProperties: properties: startIpAddress: readOnly: true type: string description: The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. endIpAddress: readOnly: true type: string description: The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. description: The firewall rule properties. Account_3: type: object description: A Playwright service account resource. properties: properties: $ref: '#/definitions/AccountProperties_2' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource RegenerateKeyParameter: description: The parameter to regenerate single EngagementFabric account key required: - name - rank type: object properties: name: description: The name of key to be regenerated type: string rank: $ref: '#/definitions/KeyRank' description: The rank of the key to be regenerated CheckNameAvailabilityParameters: required: - name - type properties: name: type: string description: The Data Lake Analytics name to check availability for. type: type: string enum: - Microsoft.DataLakeAnalytics/accounts description: 'The resource type. Note: This should not be set by the user, as the constant value is Microsoft.DataLakeAnalytics/accounts' description: Data Lake Analytics account name availability check parameters. UpdateComputePolicyProperties: properties: objectId: type: string format: uuid description: The AAD object identifier for the entity to create a policy for. objectType: type: string enum: - User - Group - ServicePrincipal x-ms-enum: name: AADObjectType modelAsString: true description: The type of AAD object the object identifier refers to. maxDegreeOfParallelismPerJob: type: integer format: int32 minimum: 1 description: The maximum degree of parallelism per job this user can use to submit jobs. This property, the min priority per job property, or both must be passed. minPriorityPerJob: type: integer format: int32 minimum: 1 description: The minimum priority per job this user can use to submit jobs. This property, the max degree of parallelism per job property, or both must be passed. description: The compute policy properties to use when updating a compute policy. CreateFirewallRuleWithAccountParameters: required: - name - properties properties: name: type: string description: The unique name of the firewall rule to create. properties: x-ms-client-flatten: true $ref: '#/definitions/CreateOrUpdateFirewallRuleProperties' description: The firewall rule properties to use when creating a new firewall rule. description: The parameters used to create a new firewall rule while creating a new Data Lake Analytics account. EncryptionIdentity: required: - type properties: type: type: string enum: - SystemAssigned x-ms-enum: name: EncryptionIdentityType modelAsString: false description: The type of encryption being used. Currently the only supported type is 'SystemAssigned'. principalId: readOnly: true type: string format: uuid description: The principal identifier associated with the encryption. tenantId: readOnly: true type: string format: uuid description: The tenant identifier associated with the encryption. description: The encryption identity properties. DataLakeStoreAccountListResult: properties: value: readOnly: true type: array items: $ref: '#/definitions/DataLakeStoreAccountBasic' description: The results of the list operation. nextLink: readOnly: true type: string description: The link (url) to the next page of results. description: Data Lake Store account list information response. MediaServicesForPutRequest: description: The media services details type: object properties: resourceId: type: string description: The media services resource id example: /subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoAnalyzer-ms userAssignedIdentity: type: string description: The user assigned identity to be used to grant permissions example: /subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoAnalyzer-mi AccountResourceListResult: description: The response to an account resource list GET request. type: object properties: value: description: Array of resource details. type: array items: $ref: '#/definitions/AccountResource_2' UpdateDataLakeAnalyticsAccountParameters: properties: tags: type: object additionalProperties: type: string description: The resource tags. properties: x-ms-client-flatten: true $ref: '#/definitions/UpdateDataLakeAnalyticsAccountProperties' description: The properties that can be updated in an existing Data Lake Analytics account. description: The parameters that can be used to update an existing Data Lake Analytics account. ErrorResponse_2: description: The error response send when an operation fails. properties: code: type: string description: error code message: type: string description: error message required: - code - message ErrorDefinition_2: description: Error definition. type: object 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_2' readOnly: true TrackedResource: description: The base model for the tracked Azure resource required: - location - sku type: object allOf: - $ref: '#/definitions/Resource_2' properties: location: description: The location of the resource type: string x-ms-mutability: - create - read tags: description: The tags of the resource type: object additionalProperties: type: string sku: $ref: '#/definitions/SKU' description: The SKU of the resource DataLakeStoreAccount: allOf: - $ref: '#/definitions/Resource' properties: identity: readOnly: true $ref: '#/definitions/EncryptionIdentity' description: The Key Vault encryption identity, if any. properties: readOnly: true x-ms-client-flatten: true $ref: '#/definitions/DataLakeStoreAccountProperties' description: The Data Lake Store account properties. description: Data Lake Store account information. StsTokenResponseMessage: description: Represents a token response message from the STS service. required: - AccessToken type: object properties: AccessToken: description: An access token for the account. type: string AccountResourceRequest: description: The body of a PUT request to modify a Visual Studio account resource. type: object properties: accountName: description: The account name. type: string location: description: The Azure instance location. type: string operationType: description: The type of the operation. enum: - unknown - create - update - link x-ms-enum: name: AccountResourceRequestOperationType properties: description: The custom properties of the resource. type: object additionalProperties: type: string x-ms-client-flatten: true tags: description: The custom tags of the resource. type: object additionalProperties: type: string UpdateKeyVaultMetaInfo: properties: encryptionKeyVersion: type: string description: The version of the user managed encryption key to update through a key rotation. description: The Key Vault update information used for user managed key rotation. AccountPropertiesForPatchRequest: description: Azure Video Indexer account properties type: object properties: tenantId: description: The account's tenant id type: string readOnly: true example: 2b9bcf6d-39d5-460a-a6bb-7b40b7ccf139 accountId: description: The account's data-plane ID readOnly: true type: string example: 3575690b-a569-449c-ab7b-11020f948f76 mediaServices: description: The media services details type: object $ref: '#/definitions/MediaServicesForPatchRequest' 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 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 LinkedResources: type: array maxItems: 10 items: $ref: '#/definitions/LinkedResource' description: The array of associated resources to the Maps account. Linked resource in the array cannot individually update, you must update all linked resources in the array together. These resources may be used on operations on the Azure Maps REST API. Access is controlled by the Maps Account Managed Identity(s) permissions to those resource(s). UpdateStorageAccountWithAccountParameters: required: - name properties: name: type: string description: The unique name of the Azure Storage account to update. properties: x-ms-client-flatten: true $ref: '#/definitions/UpdateStorageAccountProperties' description: The Azure Storage account properties to use when updating an Azure Storage account. description: The parameters used to update an Azure Storage account while updating a Data Lake Analytics account. MapsAccount: description: An Azure resource which represents access to a suite of Maps REST APIs. type: object properties: sku: description: The SKU of this account. $ref: '#/definitions/Sku' kind: description: Get or Set Kind property. $ref: '#/definitions/Kind' systemData: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/systemData identity: $ref: ../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity properties: description: The map account properties. $ref: '#/definitions/MapsAccountProperties' required: - sku allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource x-ms-azure-resource: true MapsAccountProperties: description: Additional Maps account properties type: object properties: uniqueId: description: A unique identifier for the Maps Account type: string readOnly: true disableLocalAuth: description: Allows toggle functionality on Azure Policy to disable Azure Maps local authentication support. This will disable Shared Keys and Shared Access Signature Token authentication from any usage. type: boolean default: false provisioningState: type: string description: 'The provisioning state of the Maps account resource, Account updates can only be performed on terminal states. Terminal states: `Succeeded` and `Failed`' readOnly: true linkedResources: $ref: '#/definitions/LinkedResources' cors: $ref: '#/definitions/CorsRules' description: Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service. encryption: $ref: ../../../../../common-types/resource-management/v5/customermanagedkeys.json#/definitions/encryption privateEndpointConnections: readOnly: true type: array items: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection x-ms-identifiers: - properties/privateEndpoint/id description: List of private endpoint connections associated with the Maps Account. publicNetworkAccess: type: string default: enabled enum: - enabled - disabled x-ms-enum: name: PublicNetworkAccess modelAsString: true description: Property to specify whether the Maps Account will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. locations: $ref: '#/definitions/Locations' description: List of additional data processing regions for the Maps Account, which may result in requests being processed in another geography. Some features or results may be restricted to specific regions. By default, Maps REST APIs process requests according to the account location or the [geographic scope](https://learn.microsoft.com/en-us/azure/azure-maps/geographic-scope). DataLakeStoreAccountBasic: allOf: - $ref: '#/definitions/Resource' properties: properties: readOnly: true x-ms-client-flatten: true $ref: '#/definitions/DataLakeStoreAccountPropertiesBasic' description: The basic Data Lake Store account properties. description: Basic Data Lake Store account information, returned on list calls. AccountPropertiesUpdateParameters: description: The parameters for updating the properties of a machine learning team account. properties: description: description: The description of this workspace. type: string friendlyName: description: The friendly name for this workspace. This will be the workspace name in the arm id when the workspace object gets created type: string seats: description: The no of users/seats who can access this team account. This property defines the charge on the team account. type: string storageAccountKey: description: The key for storage account associated with this team account type: string AccountListResult: type: object description: The response of a Account list operation. properties: value: type: array description: The Account items on this page items: $ref: '#/definitions/Account_3' nextLink: type: string format: uri description: The link to the next page of items required: - value CheckNameAvailabilityResult_2: description: The response to a name availability request. type: object properties: message: description: The message describing the detailed reason. type: string nameAvailable: description: The value which indicates whether the provided name is available. type: boolean VirtualNetworkRule_2: allOf: - $ref: '#/definitions/SubResource' properties: properties: readOnly: true x-ms-client-flatten: true $ref: '#/definitions/VirtualNetworkRuleProperties_2' description: The virtual network rule properties. description: Data Lake Store virtual network rule information. NameAvailabilityInformation_2: properties: nameAvailable: readOnly: true type: boolean description: The Boolean value of true or false to indicate whether the Data Lake Store account name is available or not. reason: readOnly: true type: string description: The reason why the Data Lake Store account name is not available, if nameAvailable is false. message: readOnly: true type: string description: The message describing why the Data Lake Store account name is not available, if nameAvailable is false. description: Data Lake Store account name availability result information. CloudError: description: The default error response type: object properties: error: $ref: '#/definitions/CloudErrorBody' description: Content of the error x-ms-external: true ProvisioningState: type: string description: The status of the current operation. enum: - Succeeded - Failed - Canceled - Creating - Deleting - Accepted x-ms-enum: name: ProvisioningState modelAsString: true values: - name: Succeeded value: Succeeded description: Resource has been created. - name: Failed value: Failed description: Resource creation failed. - name: Canceled value: Canceled description: Resource creation was canceled. - name: Creating value: Creating description: Creation in progress.. - name: Deleting value: Deleting description: Deletion in progress.. - name: Accepted value: Accepted description: Change accepted for processing.. AccountUpdateProperties: type: object description: The updatable properties of the Account. properties: regionalAffinity: type: string description: This property sets the connection region for Playwright client workers to cloud-hosted browsers. If enabled, workers connect to browsers in the closest Azure region, ensuring lower latency. If disabled, workers connect to browsers in the Azure region in which the workspace was initially created. default: Enabled enum: - Enabled - Disabled x-ms-enum: name: EnablementStatus modelAsString: true values: - name: Enabled value: Enabled description: The feature is Enabled. - name: Disabled value: Disabled description: The feature is Disabled. scalableExecution: type: string description: When enabled, Playwright client workers can connect to cloud-hosted browsers. This can increase the number of parallel workers for a test run, significantly minimizing test completion durations. default: Enabled enum: - Enabled - Disabled x-ms-enum: name: EnablementStatus modelAsString: true values: - name: Enabled value: Enabled description: The feature is Enabled. - name: Disabled value: Disabled description: The feature is Disabled. reporting: type: string description: When enabled, this feature allows the workspace to upload and display test results, including artifacts like traces and screenshots, in the Playwright portal. This enables faster and more efficient troubleshooting. default: Disabled enum: - Enabled - Disabled x-ms-enum: name: EnablementStatus modelAsString: true values: - name: Enabled value: Enabled description: The feature is Enabled. - name: Disabled value: Disabled description: The feature is Disabled. UpdateStorageAccountProperties: properties: accessKey: type: string description: The updated access key associated with this Azure Storage account that will be used to connect to it. suffix: type: string description: The optional suffix for the storage account. description: The Azure Storage account properties to use when updating an Azure Storage account. UpdateFirewallRuleWithAccountParameters: required: - name properties: name: type: string description: The unique name of the firewall rule to update. properties: x-ms-client-flatten: true $ref: '#/definitions/UpdateFirewallRuleProperties' description: The firewall rule properties to use when updating a firewall rule. description: The parameters used to update a firewall rule while updating a Data Lake Analytics account. Resource_4: description: A generic Azure Resource Manager resource. x-ms-azure-resource: true type: object properties: id: description: Unique identifier of the resource. readOnly: true type: string location: description: Resource location. type: string name: description: Resource name. readOnly: true type: string tags: description: Resource tags. type: object additionalProperties: type: string type: description: Resource type. readOnly: true type: string BatchErrorDetail: properties: key: type: string title: An identifier specifying the meaning of the Value property. value: type: string title: The additional information included with the error response. title: An item of additional information included in an Azure Batch error response. ErrorResponse_3: description: Error response. type: object properties: error: $ref: '#/definitions/ErrorDefinition_2' description: The error details. ClassicAccountSlim: description: An Azure Video Indexer classic account. type: object properties: name: description: The account's name type: string readOnly: true example: contoso-videoanalyzer location: description: The account's location type: string readOnly: true example: westus id: description: The account's id type: string readOnly: true example: 462af7c5-d1f6-4b91-86e3-8bc5e8a61574 parameters: ApiVersionParameter_5: name: api-version in: query description: The client API version. required: true type: string ResourceGroupNameParameter: name: resourceGroupName in: path required: true type: string x-ms-parameter-location: method description: The name of the Azure resource group. ApiVersionParameter_4: name: api-version in: query description: API version required: true type: string ApiVersionParameter_3: name: api-version in: query required: true type: string description: Client Api Version. resourceGroupNameParameter: name: resourceGroupName in: path required: true type: string x-ms-parameter-location: method description: Name of the resource group within the Azure subscription. AccountNameParameter_5: name: accountName in: path description: Account Name required: true type: string x-ms-parameter-location: method 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 AccountNameParameter_6: name: accountName in: path description: The name of the machine learning team account. required: true type: string maxLength: 50 minLength: 5 pattern: ^[a-zA-Z0-9]*$ x-ms-parameter-location: method SubscriptionIdParameter_3: name: subscriptionId in: path description: Subscription ID required: true type: string AccountNameParameter_3: name: accountName in: path required: true type: string x-ms-parameter-location: method description: The name of the Data Lake Analytics account. Azure.Core.Foundations.ApiVersionParameter: name: api-version in: query description: The API version to use for this operation. required: true type: string minLength: 1 x-ms-parameter-location: method x-ms-client-name: apiVersion LocationParameter: name: location in: query required: true description: Location for NewRelic. type: string x-ms-parameter-location: method Azure.Core.ClientRequestIdHeader: name: x-ms-client-request-id in: header description: An opaque, globally-unique, client-generated string identifier for the request. required: false type: string format: uuid x-ms-parameter-location: method x-ms-client-name: clientRequestId ApiVersionParameter_2: name: api-version in: query required: true type: string description: Client Api Version. SubscriptionIdParameter_4: name: subscriptionId in: path description: The Microsoft Azure subscription ID. required: true type: string ResourceGroupNameParameter_2: name: resourceGroupName in: path description: Resource Group Name required: true type: string x-ms-parameter-location: method AccountNameParameter_7: name: accountName in: path required: true type: string description: The name of the Azure Video Indexer account. pattern: ^[A-Za-z0-9-]+$ maxLength: 50 minLength: 3 x-ms-parameter-location: method subscriptionIdParameter: name: subscriptionId in: path description: The Azure subscription identifier. required: true type: string SubscriptionIdParameter_2: name: subscriptionId in: path required: true type: string description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ApiVersionParameter: name: api-version in: query required: true type: string description: Client API Version. AccountNameParameter_4: name: accountName in: path required: true type: string x-ms-parameter-location: method description: The name of the Data Lake Store account. AccountNameParameter_2: name: accountName in: path description: The name of the Maps Account. required: true type: string x-ms-parameter-location: method minLength: 3 maxLength: 98 pattern: ^[a-zA-Z][a-zA-Z0-9-]{3,98}[a-zA-Z0-9]$ SubscriptionIdParameter: name: subscriptionId in: path required: true type: string description: Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. apiVersionParameter: name: api-version in: query description: API Version required: true type: string ResourceGroupParameter: name: resourceGroupName in: path description: The name of the resource group to which the machine learning team account belongs. required: true type: string x-ms-parameter-location: method UserEmailParameter: name: userEmail in: query required: true description: User Email. type: string x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'