{ "swagger": "2.0", "info": { "version": "2020-12-01-preview", "title": "PurviewManagementClient", "description": "Creates a Microsoft.Purview management client." }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts": { "get": { "tags": [ "Account" ], "summary": "Gets the accounts resources by resource group.", "description": "List accounts in ResourceGroup", "operationId": "Accounts_ListByResourceGroup", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/api-version" }, { "name": "$skipToken", "in": "query", "description": "The skip token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/AccountList" } }, "default": { "description": "An error response received from the provider.", "schema": { "$ref": "#/definitions/ErrorResponseModel" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "Accounts_ListByResourceGroup": { "$ref": "./examples/Accounts_ListByResourceGroup.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Purview/accounts": { "get": { "tags": [ "Account" ], "summary": "Gets the accounts resources by subscription.", "description": "List accounts in Subscription", "operationId": "Accounts_ListBySubscription", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/api-version" }, { "name": "$skipToken", "in": "query", "description": "The skip token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/AccountList" } }, "default": { "description": "An error response received from the provider.", "schema": { "$ref": "#/definitions/ErrorResponseModel" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "Accounts_ListBySubscription": { "$ref": "./examples/Accounts_ListBySubscription.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}": { "get": { "tags": [ "Account" ], "summary": "Gets the account resource.", "description": "Get an account", "operationId": "Accounts_Get", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/accountName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Account" } }, "default": { "description": "An error response received from the provider.", "schema": { "$ref": "#/definitions/ErrorResponseModel" } } }, "x-ms-examples": { "Accounts_Get": { "$ref": "./examples/Accounts_Get.json" } } }, "put": { "tags": [ "Account" ], "summary": "Create or update an account resource", "description": "Creates or updates an account", "operationId": "Accounts_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/accountName" }, { "name": "account", "in": "body", "description": "The account.", "required": true, "schema": { "$ref": "#/definitions/Account" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Account" } }, "201": { "description": "Success", "schema": { "$ref": "#/definitions/Account" } }, "default": { "description": "An error response received from the provider.", "schema": { "$ref": "#/definitions/ErrorResponseModel" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Accounts_CreateOrUpdate": { "$ref": "./examples/Accounts_CreateOrUpdate.json" } } }, "delete": { "tags": [ "Account" ], "summary": "Deletes the account resource.", "description": "Deletes an account resource", "operationId": "Accounts_Delete", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/accountName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success" }, "202": { "description": "Accepted" }, "204": { "description": "Success" }, "default": { "description": "An error response received from the provider.", "schema": { "$ref": "#/definitions/ErrorResponseModel" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Accounts_Delete": { "$ref": "./examples/Accounts_Delete.json" } } }, "patch": { "tags": [ "Account" ], "summary": "Patches the account resource.", "description": "Updates an account", "operationId": "Accounts_Update", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/accountName" }, { "name": "accountUpdateParameters", "in": "body", "description": "The account update parameters.", "required": true, "schema": { "$ref": "#/definitions/AccountUpdateParameters" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Account" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/Account" } }, "default": { "description": "An error response received from the provider.", "schema": { "$ref": "#/definitions/ErrorResponseModel" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Accounts_Update": { "$ref": "./examples/Accounts_Update.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/listkeys": { "post": { "tags": [ "Account" ], "summary": "Lists the keys asynchronous.", "description": "List the authorization keys associated with this account.", "operationId": "Accounts_ListKeys", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/accountName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/AccessKeys" } }, "default": { "description": "An error response received from the provider.", "schema": { "$ref": "#/definitions/ErrorResponseModel" } } }, "x-ms-examples": { "Accounts_ListKeys": { "$ref": "./examples/Accounts_ListKeys.json" } } } }, "/providers/Microsoft.Purview/getDefaultAccount": { "get": { "tags": [ "DefaultAccount" ], "summary": "Gets the default account information set for the scope.", "description": "Get the default account for the scope.", "operationId": "DefaultAccounts_Get", "parameters": [ { "name": "scopeTenantId", "in": "query", "description": "The tenant ID.", "required": true, "type": "string", "format": "uuid" }, { "name": "scopeType", "in": "query", "description": "The scope for the default account.", "required": true, "type": "string", "enum": [ "Tenant", "Subscription" ], "x-ms-enum": { "name": "ScopeType", "modelAsString": true } }, { "name": "scope", "in": "query", "description": "The Id of the scope object, for example if the scope is \"Subscription\" then it is the ID of that subscription.", "required": false, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DefaultAccountPayload" } }, "default": { "description": "An error response received from the provider.", "schema": { "$ref": "#/definitions/ErrorResponseModel" } } }, "x-ms-examples": { "DefaultAccounts_Get": { "$ref": "./examples/DefaultAccounts_Get.json" } } } }, "/providers/Microsoft.Purview/setDefaultAccount": { "post": { "tags": [ "DefaultAccount" ], "summary": "Sets the default account for the scope.", "description": "Sets the default account for the scope.", "operationId": "DefaultAccounts_Set", "parameters": [ { "name": "defaultAccountPayload", "in": "body", "description": "The payload containing the default account information and the scope.", "required": true, "schema": { "$ref": "#/definitions/DefaultAccountPayload" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DefaultAccountPayload" } }, "default": { "description": "An error response received from the provider.", "schema": { "$ref": "#/definitions/ErrorResponseModel" } } }, "x-ms-examples": { "DefaultAccounts_Set": { "$ref": "./examples/DefaultAccounts_Set.json" } } } }, "/providers/Microsoft.Purview/removeDefaultAccount": { "post": { "tags": [ "DefaultAccount" ], "summary": "Removes the default account from the scope.", "description": "Removes the default account from the scope.", "operationId": "DefaultAccounts_Remove", "parameters": [ { "name": "scopeTenantId", "in": "query", "description": "The tenant ID.", "required": true, "type": "string", "format": "uuid" }, { "name": "scopeType", "in": "query", "description": "The scope for the default account.", "required": true, "type": "string", "enum": [ "Tenant", "Subscription" ], "x-ms-enum": { "name": "ScopeType", "modelAsString": true } }, { "name": "scope", "in": "query", "description": "The Id of the scope object, for example if the scope is \"Subscription\" then it is the ID of that subscription.", "required": false, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success" }, "204": { "description": "Success" }, "default": { "description": "An error response received from the provider.", "schema": { "$ref": "#/definitions/ErrorResponseModel" } } }, "x-ms-examples": { "DefaultAccounts_Remove": { "$ref": "./examples/DefaultAccounts_Remove.json" } } } }, "/providers/Microsoft.Purview/operations": { "get": { "tags": [ "Operation" ], "summary": "Lists the available operations", "description": "List of available operations", "operationId": "Operations_List", "parameters": [ { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/OperationList" } }, "default": { "description": "An error response received from the provider.", "schema": { "$ref": "#/definitions/ErrorResponseModel" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "Operations_List": { "$ref": "./examples/Operations_List.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections": { "get": { "tags": [ "PrivateEndpointConnection" ], "summary": "Gets private endpoint connections.", "description": "Get private endpoint connections for account", "operationId": "PrivateEndpointConnections_ListByAccount", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/accountName" }, { "$ref": "#/parameters/api-version" }, { "name": "$skipToken", "in": "query", "description": "The skip token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionList" } }, "default": { "description": "An error response received from the provider.", "schema": { "$ref": "#/definitions/ErrorResponseModel" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "PrivateEndpointConnections_ListByAccount": { "$ref": "./examples/PrivateEndpointConnections_ListByAccount.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": { "get": { "tags": [ "PrivateEndpointConnection" ], "summary": "Gets private endpoint connection information.", "description": "Get a private endpoint connection", "operationId": "PrivateEndpointConnections_Get", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/accountName" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "Name of the private endpoint connection.", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { "description": "An error response received from the provider.", "schema": { "$ref": "#/definitions/ErrorResponseModel" } } }, "x-ms-examples": { "PrivateEndpointConnections_Get": { "$ref": "./examples/PrivateEndpointConnections_Get.json" } } }, "put": { "tags": [ "PrivateEndpointConnection" ], "summary": "Approves/Rejects private endpoint connection request.", "description": "Create or update a private endpoint connection", "operationId": "PrivateEndpointConnections_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/accountName" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "Name of the private endpoint connection.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "The request.", "required": true, "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "201": { "description": "Success", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { "description": "An error response received from the provider.", "schema": { "$ref": "#/definitions/ErrorResponseModel" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "PrivateEndpointConnections_CreateOrUpdate": { "$ref": "./examples/PrivateEndpointConnections_CreateOrUpdate.json" } } }, "delete": { "tags": [ "PrivateEndpointConnection" ], "summary": "Deletes private endpoint connection.", "description": "Delete a private endpoint connection", "operationId": "PrivateEndpointConnections_Delete", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/accountName" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "Name of the private endpoint connection.", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success" }, "202": { "description": "Accepted" }, "204": { "description": "Success" }, "default": { "description": "An error response received from the provider.", "schema": { "$ref": "#/definitions/ErrorResponseModel" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "PrivateEndpointConnections_Delete": { "$ref": "./examples/PrivateEndpointConnections_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateLinkResources": { "get": { "tags": [ "PrivateLinkResource" ], "summary": "Gets a list of privately linkable resources for an account.", "description": "Gets a list of privately linkable resources for an account", "operationId": "PrivateLinkResources_ListByAccount", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/accountName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/PrivateLinkResourceList" } }, "default": { "description": "An error response received from the provider.", "schema": { "$ref": "#/definitions/ErrorResponseModel" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "PrivateLinkResources_ListByAccount": { "$ref": "./examples/PrivateLinkResources_ListByAccount.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateLinkResources/{groupId}": { "get": { "tags": [ "PrivateLinkResource" ], "summary": "Gets a privately linkable resources for an account with given group identifier.", "description": "Gets a privately linkable resources for an account with given group identifier", "operationId": "PrivateLinkResources_GetByGroupId", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/accountName" }, { "name": "groupId", "in": "path", "description": "The group identifier.", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/PrivateLinkResource" } }, "default": { "description": "An error response received from the provider.", "schema": { "$ref": "#/definitions/ErrorResponseModel" } } }, "x-ms-examples": { "PrivateLinkResources_GetByGroupId": { "$ref": "./examples/PrivateLinkResources_GetByGroupId.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Purview/checkNameAvailability": { "post": { "tags": [ "Provider" ], "summary": "Checks the account name availability.", "description": "Checks if account name is available.", "operationId": "Accounts_CheckNameAvailability", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "checkNameAvailabilityRequest", "in": "body", "description": "The check name availability request.", "required": true, "schema": { "$ref": "#/definitions/CheckNameAvailabilityRequest" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CheckNameAvailabilityResult" } }, "default": { "description": "An error response received from the provider.", "schema": { "$ref": "#/definitions/ErrorResponseModel" } } }, "x-ms-examples": { "Accounts_CheckNameAvailability": { "$ref": "./examples/Accounts_CheckNameAvailability.json" } } } } }, "definitions": { "AccountList": { "description": "Paged list of account resources", "required": [ "value" ], "type": "object", "properties": { "count": { "format": "int64", "description": "Total item count.", "type": "integer" }, "nextLink": { "description": "The Url of next result page.", "type": "string" }, "value": { "description": "Collection of items of type results.", "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/Account" } } } }, "Account": { "description": "Account resource", "type": "object", "allOf": [ { "$ref": "#/definitions/TrackedResource" } ], "properties": { "properties": { "$ref": "#/definitions/AccountProperties", "description": "Gets or sets the properties.", "x-ms-client-flatten": true }, "sku": { "description": "Gets or sets the Sku.", "allOf": [ { "$ref": "#/definitions/AccountSku" } ], "readOnly": true } } }, "AccountSku": { "description": "The Sku", "type": "object", "properties": { "capacity": { "format": "int32", "description": "Gets or sets the sku capacity.", "type": "integer" }, "name": { "description": "Gets or sets the sku name.", "enum": [ "Standard" ], "type": "string", "x-ms-enum": { "name": "name", "modelAsString": true } } } }, "AccountProperties": { "description": "The account properties", "type": "object", "properties": { "cloudConnectors": { "$ref": "#/definitions/CloudConnectors", "description": "Cloud connectors.\r\nExternal cloud identifier used as part of scanning configuration." }, "createdAt": { "format": "date-time", "description": "Gets the time at which the entity was created.", "type": "string", "readOnly": true }, "createdBy": { "description": "Gets the creator of the entity.", "type": "string", "readOnly": true }, "createdByObjectId": { "description": "Gets the creators of the entity's object id.", "type": "string", "readOnly": true }, "endpoints": { "description": "The URIs that are the public endpoints of the account.", "allOf": [ { "$ref": "#/definitions/AccountEndpoints" } ], "readOnly": true }, "friendlyName": { "description": "Gets or sets the friendly name.", "type": "string", "readOnly": true }, "managedResourceGroupName": { "description": "Gets or sets the managed resource group name", "type": "string", "x-ms-mutability": [ "read", "create" ] }, "managedResources": { "description": "Gets the resource identifiers of the managed resources.", "allOf": [ { "$ref": "#/definitions/ManagedResources" } ], "readOnly": true }, "privateEndpointConnections": { "description": "Gets the private endpoint connections information.", "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/PrivateEndpointConnection" }, "readOnly": true }, "provisioningState": { "description": "Gets or sets the state of the provisioning.", "enum": [ "Unknown", "Creating", "Moving", "Deleting", "SoftDeleting", "SoftDeleted", "Failed", "Succeeded", "Canceled" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "provisioningState", "modelAsString": true } }, "publicNetworkAccess": { "description": "Gets or sets the public network access.", "default": "Enabled", "enum": [ "NotSpecified", "Enabled", "Disabled" ], "type": "string", "x-ms-enum": { "name": "publicNetworkAccess", "modelAsString": true } }, "systemData": { "description": "Metadata pertaining to creation and last modification of the resource.", "allOf": [ { "$ref": "#/definitions/SystemData" } ], "readOnly": true } } }, "Identity": { "description": "The Managed Identity of the resource", "type": "object", "properties": { "principalId": { "description": "Service principal object Id", "type": "string", "readOnly": true }, "tenantId": { "description": "Tenant Id", "type": "string", "readOnly": true }, "type": { "description": "Identity Type", "enum": [ "SystemAssigned" ], "type": "string", "x-ms-enum": { "name": "type", "modelAsString": true } } } }, "CloudConnectors": { "type": "object", "properties": { "awsExternalId": { "description": "AWS external identifier.\r\nConfigured in AWS to allow use of the role arn used for scanning", "type": "string", "readOnly": true } } }, "AccountEndpoints": { "description": "The account endpoints", "type": "object", "properties": { "catalog": { "description": "Gets the catalog endpoint.", "type": "string", "readOnly": true }, "guardian": { "description": "Gets the guardian endpoint.", "type": "string", "readOnly": true }, "scan": { "description": "Gets the scan endpoint.", "type": "string", "readOnly": true } } }, "PrivateEndpointConnection": { "description": "A private endpoint connection class.", "type": "object", "allOf": [ { "$ref": "#/definitions/ProxyResource" } ], "properties": { "properties": { "$ref": "#/definitions/PrivateEndpointConnectionProperties", "description": "The connection identifier.", "x-ms-client-flatten": true } } }, "ManagedResources": { "description": "The managed resources in customer subscription.", "type": "object", "properties": { "eventHubNamespace": { "description": "Gets the managed event hub namespace resource identifier.", "type": "string", "readOnly": true }, "resourceGroup": { "description": "Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account.", "type": "string", "readOnly": true }, "storageAccount": { "description": "Gets the managed storage account resource identifier.", "type": "string", "readOnly": true } } }, "SystemData": { "description": "Metadata pertaining to creation and last modification of the resource.", "type": "object", "properties": { "createdAt": { "format": "date-time", "description": "The timestamp of resource creation (UTC).", "type": "string", "readOnly": true }, "createdBy": { "description": "The identity that created the resource.", "type": "string", "readOnly": true }, "createdByType": { "description": "The type of identity that created the resource.", "enum": [ "User", "Application", "ManagedIdentity", "Key" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "createdByType", "modelAsString": true } }, "lastModifiedAt": { "format": "date-time", "description": "The timestamp of the last modification the resource (UTC).", "type": "string", "readOnly": true }, "lastModifiedBy": { "description": "The identity that last modified the resource.", "type": "string", "readOnly": true }, "lastModifiedByType": { "description": "The type of identity that last modified the resource.", "enum": [ "User", "Application", "ManagedIdentity", "Key" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "lastModifiedByType", "modelAsString": true } } } }, "PrivateEndpointConnectionProperties": { "description": "A private endpoint connection properties class.", "type": "object", "properties": { "privateEndpoint": { "$ref": "#/definitions/PrivateEndpoint", "description": "The private endpoint information." }, "privateLinkServiceConnectionState": { "$ref": "#/definitions/PrivateLinkServiceConnectionState", "description": "The private link service connection state." }, "provisioningState": { "description": "The provisioning state.", "type": "string", "readOnly": true } } }, "PrivateEndpoint": { "description": "A private endpoint class.", "type": "object", "properties": { "id": { "description": "The private endpoint identifier.", "type": "string" } } }, "PrivateLinkServiceConnectionState": { "description": "The private link service connection state.", "type": "object", "properties": { "actionsRequired": { "description": "The required actions.", "type": "string" }, "description": { "description": "The description.", "type": "string" }, "status": { "description": "The status.", "enum": [ "Unknown", "Pending", "Approved", "Rejected", "Disconnected" ], "type": "string", "x-ms-enum": { "name": "status", "modelAsString": true } } } }, "ErrorResponseModel": { "description": "Default error response model", "type": "object", "properties": { "error": { "description": "Gets or sets the error.", "allOf": [ { "$ref": "#/definitions/ErrorModel" } ], "readOnly": true } } }, "ErrorModel": { "description": "Default error model", "type": "object", "properties": { "code": { "description": "Gets or sets the code.", "type": "string", "readOnly": true }, "details": { "description": "Gets or sets the details.", "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/ErrorModel" }, "readOnly": true }, "message": { "description": "Gets or sets the messages.", "type": "string", "readOnly": true }, "target": { "description": "Gets or sets the target.", "type": "string", "readOnly": true } } }, "AccountUpdateParameters": { "description": "The account update properties.", "type": "object", "properties": { "properties": { "$ref": "#/definitions/AccountProperties", "description": "The account properties." }, "tags": { "description": "Tags on the azure resource.", "type": "object", "additionalProperties": { "type": "string" } } } }, "AccessKeys": { "description": "The Account access keys.", "type": "object", "properties": { "atlasKafkaPrimaryEndpoint": { "description": "Gets or sets the primary connection string.", "type": "string" }, "atlasKafkaSecondaryEndpoint": { "description": "Gets or sets the secondary connection string.", "type": "string" } } }, "DefaultAccountPayload": { "description": "Payload to get and set the default account in the given scope", "type": "object", "properties": { "accountName": { "description": "The name of the account that is set as the default.", "type": "string" }, "resourceGroupName": { "description": "The resource group name of the account that is set as the default.", "type": "string" }, "scope": { "description": "The scope object ID. For example, sub ID or tenant ID.", "type": "string" }, "scopeTenantId": { "description": "The scope tenant in which the default account is set.", "type": "string" }, "scopeType": { "description": "The scope where the default account is set.", "enum": [ "Tenant", "Subscription" ], "type": "string", "x-ms-enum": { "name": "scopeType", "modelAsString": true } }, "subscriptionId": { "description": "The subscription ID of the account that is set as the default.", "type": "string" } } }, "OperationList": { "description": "Paged list of operation resources", "required": [ "value" ], "type": "object", "properties": { "count": { "format": "int64", "description": "Total item count.", "type": "integer" }, "nextLink": { "description": "The Url of next result page.", "type": "string" }, "value": { "description": "Collection of items of type results.", "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/Operation" } } } }, "Operation": { "description": "Operation resource", "type": "object", "properties": { "display": { "$ref": "#/definitions/OperationDisplay", "description": "Properties on the operation" }, "isDataAction": { "description": "Whether operation is a data action", "type": "boolean" }, "name": { "description": "Operation name for display purposes", "type": "string" }, "origin": { "description": "origin of the operation", "type": "string" }, "properties": { "$ref": "#/definitions/OperationProperties", "description": "properties for the operation meta info", "x-ms-client-flatten": true } } }, "OperationDisplay": { "description": "The response model for get operation properties", "type": "object", "properties": { "description": { "description": "Description of the operation for display purposes", "type": "string" }, "operation": { "description": "Name of the operation for display purposes", "type": "string" }, "provider": { "description": "Name of the provider for display purposes", "type": "string" }, "resource": { "description": "Name of the resource type for display purposes", "type": "string" } } }, "OperationProperties": { "description": "properties on meta info", "type": "object", "properties": { "serviceSpecification": { "$ref": "#/definitions/OperationMetaServiceSpecification", "description": "meta service specification" } } }, "OperationMetaServiceSpecification": { "description": "The operation meta service specification", "type": "object", "properties": { "logSpecifications": { "description": "log specifications for the operation", "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/OperationMetaLogSpecification" } }, "metricSpecifications": { "description": "metric specifications for the operation", "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/OperationMetaMetricSpecification" } } } }, "OperationMetaMetricSpecification": { "description": "metric specifications for the operation", "type": "object", "properties": { "aggregationType": { "description": "aggregation type of metric", "type": "string" }, "dimensions": { "description": "properties for dimension", "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/DimensionProperties" } }, "displayDescription": { "description": "description of the metric", "type": "string" }, "displayName": { "description": "localized name of the metric", "type": "string" }, "enableRegionalMdmAccount": { "description": "enable regional mdm account", "type": "string" }, "internalMetricName": { "description": "internal metric name", "type": "string" }, "name": { "description": "name of the metric", "type": "string" }, "resourceIdDimensionNameOverride": { "description": "dimension name use to replace resource id if specified", "type": "string" }, "sourceMdmNamespace": { "description": "Metric namespace.\r\nOnly set the namespace if different from the default value, \r\nleaving it empty makes it use the value from the ARM manifest.", "type": "string" }, "supportedAggregationTypes": { "description": "supported aggregation types", "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "supportedTimeGrainTypes": { "description": "supported time grain types", "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "unit": { "description": "units for the metric", "type": "string" } } }, "OperationMetaLogSpecification": { "description": "log specifications for operation api", "type": "object", "properties": { "blobDuration": { "description": "blob duration of the log", "type": "string" }, "displayName": { "description": "localized name of the log category", "type": "string" }, "name": { "description": "name of the log category", "type": "string" } } }, "DimensionProperties": { "description": "properties for dimension", "type": "object", "properties": { "displayName": { "description": "localized display name of the dimension to customer", "type": "string" }, "name": { "description": "dimension name", "type": "string" }, "toBeExportedForCustomer": { "description": "flag indicating whether this dimension should be included to the customer in Azure Monitor logs (aka Shoebox)", "type": "boolean" } } }, "PrivateEndpointConnectionList": { "description": "Paged list of private endpoint connections", "required": [ "value" ], "type": "object", "properties": { "count": { "format": "int64", "description": "Total item count.", "type": "integer" }, "nextLink": { "description": "The Url of next result page.", "type": "string" }, "value": { "description": "Collection of items of type results.", "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/PrivateEndpointConnection" } } } }, "PrivateLinkResourceList": { "description": "Paged list of private link resources", "required": [ "value" ], "type": "object", "properties": { "count": { "format": "int64", "description": "Total item count.", "type": "integer" }, "nextLink": { "description": "The Url of next result page.", "type": "string" }, "value": { "description": "Collection of items of type results.", "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/PrivateLinkResource" } } } }, "PrivateLinkResource": { "description": "A privately linkable resource.", "type": "object", "properties": { "id": { "description": "The private link resource identifier.", "type": "string", "readOnly": true }, "name": { "description": "The private link resource name.", "type": "string", "readOnly": true }, "properties": { "$ref": "#/definitions/PrivateLinkResourceProperties", "description": "The private link resource properties.", "readOnly": true }, "type": { "description": "The private link resource type.", "type": "string", "readOnly": true } } }, "PrivateLinkResourceProperties": { "description": "A privately linkable resource properties.", "type": "object", "properties": { "groupId": { "description": "The private link resource group identifier.", "type": "string", "readOnly": true }, "requiredMembers": { "description": "This translates to how many Private IPs should be created for each privately linkable resource.", "uniqueItems": false, "type": "array", "items": { "type": "string" }, "readOnly": true }, "requiredZoneNames": { "description": "The required zone names for private link resource.", "uniqueItems": false, "type": "array", "items": { "type": "string" }, "readOnly": true } } }, "CheckNameAvailabilityRequest": { "description": "The request payload for CheckNameAvailability API", "type": "object", "properties": { "name": { "description": "Resource name to verify for availability", "type": "string" }, "type": { "description": "Fully qualified resource type which includes provider namespace", "type": "string" } } }, "CheckNameAvailabilityResult": { "description": "The response payload for CheckNameAvailability API", "type": "object", "properties": { "message": { "description": "Error message", "type": "string" }, "nameAvailable": { "description": "Indicates if name is valid and available.", "type": "boolean" }, "reason": { "description": "The reason the name is not available.", "enum": [ "Invalid", "AlreadyExists" ], "type": "string", "x-ms-enum": { "name": "reason", "modelAsString": true } } } }, "TrackedResource": { "description": "Azure ARM Tracked Resource", "type": "object", "properties": { "id": { "description": "Gets or sets the identifier.", "type": "string", "readOnly": true }, "identity": { "$ref": "#/definitions/Identity", "description": "Identity Info on the tracked resource" }, "location": { "description": "Gets or sets the location.", "type": "string" }, "name": { "description": "Gets or sets the name.", "type": "string", "readOnly": true }, "tags": { "description": "Tags on the azure resource.", "type": "object", "additionalProperties": { "type": "string" } }, "type": { "description": "Gets or sets the type.", "type": "string", "readOnly": true } }, "x-ms-azure-resource": true }, "ProxyResource": { "description": "Proxy Azure Resource", "type": "object", "properties": { "id": { "description": "Gets or sets the identifier.", "type": "string", "readOnly": true }, "name": { "description": "Gets or sets the name.", "type": "string", "readOnly": true }, "type": { "description": "Gets or sets the type.", "type": "string", "readOnly": true } }, "x-ms-azure-resource": true } }, "parameters": { "subscriptionId": { "name": "subscriptionId", "in": "path", "description": "The subscription identifier", "required": true, "type": "string" }, "accountName": { "name": "accountName", "in": "path", "description": "The name of the account.", "required": true, "type": "string", "maxLength": 63, "minLength": 3, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$", "x-ms-parameter-location": "method" }, "api-version": { "name": "api-version", "in": "query", "description": "The api version to use.", "required": true, "type": "string" }, "resourceGroupName": { "name": "resourceGroupName", "in": "path", "description": "The resource group name.", "required": true, "type": "string", "x-ms-parameter-location": "method" } }, "securityDefinitions": { "azure_auth": { "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" }, "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow." } }, "security": [ { "azure_auth": [ "user_impersonation" ] } ], "tags": [] }