Microsoft.Purview (stable:2021-12-01)

2025/12/05 • 26 new, 26 deleted methods

Accounts_ListByResourceGroup (new)
Description :  List accounts in ResourceGroup
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: The skip token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
count:
{
Description: Total item count. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type results. ,
Required: True ,
}
[
{
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
accountStatus:
{
Description: Gets or sets the status of the account. ,
Required: False ,
}
string ,
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Gets or sets the Sku. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_ListBySubscription (new)
Description :  List accounts in Subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Purview/accounts
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: The skip token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
count:
{
Description: Total item count. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type results. ,
Required: True ,
}
[
{
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
accountStatus:
{
Description: Gets or sets the status of the account. ,
Required: False ,
}
string ,
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Gets or sets the Sku. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_Get (new)
Description :  Get an account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
accountStatus:
{
Description: Gets or sets the status of the account. ,
Required: False ,
}
string ,
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Gets or sets the Sku. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_CreateOrUpdate (new)
Description :  Creates or updates an account
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
account:
{
Description: The account. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
accountStatus:
{
Description: Gets or sets the status of the account. ,
Required: False ,
}
string ,
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Gets or sets the Sku. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
accountStatus:
{
Description: Gets or sets the status of the account. ,
Required: False ,
}
string ,
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Gets or sets the Sku. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
accountStatus:
{
Description: Gets or sets the status of the account. ,
Required: False ,
}
string ,
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Gets or sets the Sku. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_Delete (new)
Description :  Deletes an account resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_Update (new)
Description :  Updates an account
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
accountUpdateParameters:
{
Description: The account update parameters. ,
Required: True ,
}
{
identity:
{
Description: Identity related info to add/remove userAssignedIdentities. ,
Required: False ,
}
{
principalId:
{
Description: Service principal object Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: User Assigned Identities ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The account properties. ,
Required: False ,
}
{
accountStatus:
{
Description: Gets or sets the status of the account. ,
Required: False ,
}
string ,
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Tags on the azure resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
accountStatus:
{
Description: Gets or sets the status of the account. ,
Required: False ,
}
string ,
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Gets or sets the Sku. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
accountStatus:
{
Description: Gets or sets the status of the account. ,
Required: False ,
}
string ,
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Gets or sets the Sku. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_ListKeys (new)
Description :  List the authorization keys associated with this account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/listkeys
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
atlasKafkaPrimaryEndpoint:
{
Description: Gets or sets the primary connection string. ,
Required: False ,
}
string ,
atlasKafkaSecondaryEndpoint:
{
Description: Gets or sets the secondary connection string. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_AddRootCollectionAdmin (new)
Description :  Add the administrator for root collection associated with this account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/addRootCollectionAdmin
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
collectionAdminUpdate:
{
Description: The collection admin update payload. ,
Required: True ,
}
{
objectId:
{
Description: Gets or sets the object identifier of the admin. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
DefaultAccounts_Get (new)
Description :  Get the default account for the scope.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Purview/getDefaultAccount
{
scopeTenantId:
{
Description: The tenant ID. ,
Format: uuid ,
Required: True ,
}
string ,
scopeType:
{
Description: The scope for the default account. ,
Required: True ,
}
string ,
scope:
{
Description: The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription. ,
Required: False ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
accountName:
{
Description: The name of the account that is set as the default. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: The resource group name of the account that is set as the default. ,
Required: False ,
}
string ,
scope:
{
Description: The scope object ID. For example, sub ID or tenant ID. ,
Required: False ,
}
string ,
scopeTenantId:
{
Description: The scope tenant in which the default account is set. ,
Required: False ,
}
string ,
scopeType:
{
Description: The scope where the default account is set. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The subscription ID of the account that is set as the default. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
DefaultAccounts_Set (new)
Description :  Sets the default account for the scope.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Purview/setDefaultAccount
{
defaultAccountPayload:
{
Description: The payload containing the default account information and the scope. ,
Required: True ,
}
{
accountName:
{
Description: The name of the account that is set as the default. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: The resource group name of the account that is set as the default. ,
Required: False ,
}
string ,
scope:
{
Description: The scope object ID. For example, sub ID or tenant ID. ,
Required: False ,
}
string ,
scopeTenantId:
{
Description: The scope tenant in which the default account is set. ,
Required: False ,
}
string ,
scopeType:
{
Description: The scope where the default account is set. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The subscription ID of the account that is set as the default. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
accountName:
{
Description: The name of the account that is set as the default. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: The resource group name of the account that is set as the default. ,
Required: False ,
}
string ,
scope:
{
Description: The scope object ID. For example, sub ID or tenant ID. ,
Required: False ,
}
string ,
scopeTenantId:
{
Description: The scope tenant in which the default account is set. ,
Required: False ,
}
string ,
scopeType:
{
Description: The scope where the default account is set. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The subscription ID of the account that is set as the default. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
DefaultAccounts_Remove (new)
Description :  Removes the default account from the scope.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Purview/removeDefaultAccount
{
scopeTenantId:
{
Description: The tenant ID. ,
Format: uuid ,
Required: True ,
}
string ,
scopeType:
{
Description: The scope for the default account. ,
Required: True ,
}
string ,
scope:
{
Description: The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription. ,
Required: False ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Features_AccountGet (new)
Description :  Gets details from a list of feature names.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/listFeatures
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
featureRequest:
{
Description: Request body with feature names. ,
Required: True ,
}
{
features:
{
Description: Set of features ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
features:
{
Description: Features with enabled status ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Features_SubscriptionGet (new)
Description :  Gets details from a list of feature names.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Purview/locations/{locations}/listFeatures
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
locations:
{
Description: Location of feature. ,
Required: True ,
}
string ,
featureRequest:
{
Description: Request body with feature names. ,
Required: True ,
}
{
features:
{
Description: Set of features ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
features:
{
Description: Features with enabled status ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
KafkaConfigurations_Get (new)
Description :  Gets the kafka configuration for the account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations/{kafkaConfigurationName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
kafkaConfigurationName:
{
Description: Name of kafka configuration. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the kafka configuration properties. ,
Required: False ,
}
{
consumerGroup:
{
Description: Consumer group for hook event hub. ,
Required: False ,
}
string ,
credentials:
{
Description: Credentials to access event hub. ,
Required: False ,
}
{
identityId:
{
Description: Identity identifier for UserAssign type. ,
Required: False ,
}
string ,
type:
{
Description: Identity Type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
eventHubResourceId:
{
Format: arm-id ,
Required: False ,
}
string ,
eventHubType:
{
Description: The event hub type. ,
Enum:
{
Notification: No description available. ,
Hook: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingState:
{
Description: The state of the event streaming service ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingType:
{
Description: The event streaming service type ,
Enum:
{
None: No description available. ,
Managed: No description available. ,
Azure: No description available. ,
}
,
Required: False ,
}
enum ,
eventHubPartitionId:
{
Description: Optional partition Id for notification event hub. If not set, all partitions will be leveraged. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
KafkaConfigurations_CreateOrUpdate (new)
Description :  Create or update Kafka Configuration
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations/{kafkaConfigurationName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
kafkaConfigurationName:
{
Description: The kafka configuration name. ,
Required: True ,
}
string ,
kafkaConfiguration:
{
Description: The kafka configuration of the account. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the kafka configuration properties. ,
Required: False ,
}
{
consumerGroup:
{
Description: Consumer group for hook event hub. ,
Required: False ,
}
string ,
credentials:
{
Description: Credentials to access event hub. ,
Required: False ,
}
{
identityId:
{
Description: Identity identifier for UserAssign type. ,
Required: False ,
}
string ,
type:
{
Description: Identity Type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
eventHubResourceId:
{
Format: arm-id ,
Required: False ,
}
string ,
eventHubType:
{
Description: The event hub type. ,
Enum:
{
Notification: No description available. ,
Hook: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingState:
{
Description: The state of the event streaming service ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingType:
{
Description: The event streaming service type ,
Enum:
{
None: No description available. ,
Managed: No description available. ,
Azure: No description available. ,
}
,
Required: False ,
}
enum ,
eventHubPartitionId:
{
Description: Optional partition Id for notification event hub. If not set, all partitions will be leveraged. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the kafka configuration properties. ,
Required: False ,
}
{
consumerGroup:
{
Description: Consumer group for hook event hub. ,
Required: False ,
}
string ,
credentials:
{
Description: Credentials to access event hub. ,
Required: False ,
}
{
identityId:
{
Description: Identity identifier for UserAssign type. ,
Required: False ,
}
string ,
type:
{
Description: Identity Type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
eventHubResourceId:
{
Format: arm-id ,
Required: False ,
}
string ,
eventHubType:
{
Description: The event hub type. ,
Enum:
{
Notification: No description available. ,
Hook: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingState:
{
Description: The state of the event streaming service ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingType:
{
Description: The event streaming service type ,
Enum:
{
None: No description available. ,
Managed: No description available. ,
Azure: No description available. ,
}
,
Required: False ,
}
enum ,
eventHubPartitionId:
{
Description: Optional partition Id for notification event hub. If not set, all partitions will be leveraged. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the kafka configuration properties. ,
Required: False ,
}
{
consumerGroup:
{
Description: Consumer group for hook event hub. ,
Required: False ,
}
string ,
credentials:
{
Description: Credentials to access event hub. ,
Required: False ,
}
{
identityId:
{
Description: Identity identifier for UserAssign type. ,
Required: False ,
}
string ,
type:
{
Description: Identity Type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
eventHubResourceId:
{
Format: arm-id ,
Required: False ,
}
string ,
eventHubType:
{
Description: The event hub type. ,
Enum:
{
Notification: No description available. ,
Hook: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingState:
{
Description: The state of the event streaming service ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingType:
{
Description: The event streaming service type ,
Enum:
{
None: No description available. ,
Managed: No description available. ,
Azure: No description available. ,
}
,
Required: False ,
}
enum ,
eventHubPartitionId:
{
Description: Optional partition Id for notification event hub. If not set, all partitions will be leveraged. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
KafkaConfigurations_Delete (new)
Description :  Deletes a KafkaConfiguration resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations/{kafkaConfigurationName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
kafkaConfigurationName:
{
Description: Name of kafka configuration. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
KafkaConfigurations_ListByAccount (new)
Description :  Lists the Kafka configurations in the Account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: The skip token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type results. ,
Required: True ,
}
[
{
properties:
{
Description: Gets or sets the kafka configuration properties. ,
Required: False ,
}
{
consumerGroup:
{
Description: Consumer group for hook event hub. ,
Required: False ,
}
string ,
credentials:
{
Description: Credentials to access event hub. ,
Required: False ,
}
{
identityId:
{
Description: Identity identifier for UserAssign type. ,
Required: False ,
}
string ,
type:
{
Description: Identity Type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
eventHubResourceId:
{
Format: arm-id ,
Required: False ,
}
string ,
eventHubType:
{
Description: The event hub type. ,
Enum:
{
Notification: No description available. ,
Hook: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingState:
{
Description: The state of the event streaming service ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingType:
{
Description: The event streaming service type ,
Enum:
{
None: No description available. ,
Managed: No description available. ,
Azure: No description available. ,
}
,
Required: False ,
}
enum ,
eventHubPartitionId:
{
Description: Optional partition Id for notification event hub. If not set, all partitions will be leveraged. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Operations_List (new)
Description :  List of available operations
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Purview/operations
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type results. ,
Required: True ,
}
[
{
display:
{
Description: Properties on the operation ,
Required: False ,
}
{
description:
{
Description: Description of the operation for display purposes ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation for display purposes ,
Required: False ,
}
string ,
provider:
{
Description: Name of the provider for display purposes ,
Required: False ,
}
string ,
resource:
{
Description: Name of the resource type for display purposes ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: Whether operation is a data action ,
Required: False ,
}
boolean ,
name:
{
Description: Operation name for display purposes ,
Required: False ,
}
string ,
origin:
{
Description: origin of the operation ,
Required: False ,
}
string ,
properties:
{
Description: properties for the operation meta info ,
Required: False ,
}
{
serviceSpecification:
{
Description: meta service specification ,
Required: False ,
}
{
logSpecifications:
{
Description: log specifications for the operation ,
Required: False ,
}
[
{
blobDuration:
{
Description: blob duration of the log ,
Required: False ,
}
string ,
displayName:
{
Description: localized name of the log category ,
Required: False ,
}
string ,
name:
{
Description: name of the log category ,
Required: False ,
}
string ,
}
,
]
,
metricSpecifications:
{
Description: metric specifications for the operation ,
Required: False ,
}
[
{
aggregationType:
{
Description: aggregation type of metric ,
Required: False ,
}
string ,
dimensions:
{
Description: properties for dimension ,
Required: False ,
}
[
{
displayName:
{
Description: localized display name of the dimension to customer ,
Required: False ,
}
string ,
name:
{
Description: dimension name ,
Required: False ,
}
string ,
toBeExportedForCustomer:
{
Description: flag indicating whether this dimension should be included to the customer in Azure Monitor logs (aka Shoebox) ,
Required: False ,
}
boolean ,
}
,
]
,
displayDescription:
{
Description: description of the metric ,
Required: False ,
}
string ,
displayName:
{
Description: localized name of the metric ,
Required: False ,
}
string ,
enableRegionalMdmAccount:
{
Description: enable regional mdm account ,
Required: False ,
}
string ,
internalMetricName:
{
Description: internal metric name ,
Required: False ,
}
string ,
name:
{
Description: name of the metric ,
Required: False ,
}
string ,
resourceIdDimensionNameOverride:
{
Description: dimension name use to replace resource id if specified ,
Required: False ,
}
string ,
sourceMdmNamespace:
{
Description: Metric namespace. Only set the namespace if different from the default value, leaving it empty makes it use the value from the ARM manifest. ,
Required: False ,
}
string ,
supportedAggregationTypes:
{
Description: supported aggregation types ,
Required: False ,
}
[
string ,
]
,
supportedTimeGrainTypes:
{
Description: supported time grain types ,
Required: False ,
}
[
string ,
]
,
unit:
{
Description: units for the metric ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_ListByAccount (new)
Description :  Get private endpoint connections for account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: The skip token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type results. ,
Required: True ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_Get (new)
Description :  Get a private endpoint connection
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Name of the private endpoint connection. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_CreateOrUpdate (new)
Description :  Create or update a private endpoint connection
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Name of the private endpoint connection. ,
Required: True ,
}
string ,
request:
{
Description: The request. ,
Required: True ,
}
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_Delete (new)
Description :  Delete a private endpoint connection
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Name of the private endpoint connection. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
PrivateLinkResources_ListByAccount (new)
Description :  Gets a list of privately linkable resources for an account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateLinkResources
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type results. ,
Required: True ,
}
[
{
id:
{
Description: The private link resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The private link resource name. ,
Required: False ,
}
string ,
properties:
{
Description: The private link resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group identifier. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: This translates to how many Private IPs should be created for each privately linkable resource. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The required zone names for private link resource. ,
Required: False ,
}
[
string ,
]
,
}
,
type:
{
Description: The private link resource type. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
PrivateLinkResources_GetByGroupId (new)
Description :  Gets a privately linkable resources for an account with given group identifier
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateLinkResources/{groupId}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
groupId:
{
Description: The group identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The private link resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The private link resource name. ,
Required: False ,
}
string ,
properties:
{
Description: The private link resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group identifier. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: This translates to how many Private IPs should be created for each privately linkable resource. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The required zone names for private link resource. ,
Required: False ,
}
[
string ,
]
,
}
,
type:
{
Description: The private link resource type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_CheckNameAvailability (new)
Description :  Checks if account name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Purview/checkNameAvailability
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
checkNameAvailabilityRequest:
{
Description: The check name availability request. ,
Required: True ,
}
{
name:
{
Description: Resource name to verify for availability ,
Required: False ,
}
string ,
type:
{
Description: Fully qualified resource type which includes provider namespace ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
message:
{
Description: Error message ,
Required: False ,
}
string ,
nameAvailable:
{
Description: Indicates if name is valid and available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason the name is not available. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Usages_Get (new)
Description :  Get the usage quota configuration
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Purview/locations/{location}/usages
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
location:
{
Description: The region. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$filter:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of usage values. ,
Required: False ,
}
[
{
currentValue:
{
Description: Current usage quota value ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: Fully qualified ARM resource Id ,
Required: False ,
}
string ,
limit:
{
Description: Usage quota limit ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Quota name ,
Required: False ,
}
string ,
unit:
{
Description: Quota usage unit. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_ListByResourceGroup (removed)
Description :  List accounts in ResourceGroup
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: The skip token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
count:
{
Description: Total item count. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type results. ,
Required: True ,
}
[
{
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
accountStatus:
{
Description: Gets or sets the status of the account. ,
Required: False ,
}
string ,
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Gets or sets the Sku. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_ListBySubscription (removed)
Description :  List accounts in Subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Purview/accounts
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: The skip token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
count:
{
Description: Total item count. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type results. ,
Required: True ,
}
[
{
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
accountStatus:
{
Description: Gets or sets the status of the account. ,
Required: False ,
}
string ,
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Gets or sets the Sku. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_Get (removed)
Description :  Get an account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
accountStatus:
{
Description: Gets or sets the status of the account. ,
Required: False ,
}
string ,
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Gets or sets the Sku. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_CreateOrUpdate (removed)
Description :  Creates or updates an account
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
account:
{
Description: The account. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
accountStatus:
{
Description: Gets or sets the status of the account. ,
Required: False ,
}
string ,
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Gets or sets the Sku. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
accountStatus:
{
Description: Gets or sets the status of the account. ,
Required: False ,
}
string ,
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Gets or sets the Sku. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
accountStatus:
{
Description: Gets or sets the status of the account. ,
Required: False ,
}
string ,
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Gets or sets the Sku. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_Delete (removed)
Description :  Deletes an account resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_Update (removed)
Description :  Updates an account
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
accountUpdateParameters:
{
Description: The account update parameters. ,
Required: True ,
}
{
identity:
{
Description: Identity related info to add/remove userAssignedIdentities. ,
Required: False ,
}
{
principalId:
{
Description: Service principal object Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: User Assigned Identities ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The account properties. ,
Required: False ,
}
{
accountStatus:
{
Description: Gets or sets the status of the account. ,
Required: False ,
}
string ,
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Tags on the azure resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
accountStatus:
{
Description: Gets or sets the status of the account. ,
Required: False ,
}
string ,
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Gets or sets the Sku. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
accountStatus:
{
Description: Gets or sets the status of the account. ,
Required: False ,
}
string ,
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Gets or sets the Sku. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_ListKeys (removed)
Description :  List the authorization keys associated with this account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/listkeys
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
atlasKafkaPrimaryEndpoint:
{
Description: Gets or sets the primary connection string. ,
Required: False ,
}
string ,
atlasKafkaSecondaryEndpoint:
{
Description: Gets or sets the secondary connection string. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_AddRootCollectionAdmin (removed)
Description :  Add the administrator for root collection associated with this account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/addRootCollectionAdmin
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
collectionAdminUpdate:
{
Description: The collection admin update payload. ,
Required: True ,
}
{
objectId:
{
Description: Gets or sets the object identifier of the admin. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
DefaultAccounts_Get (removed)
Description :  Get the default account for the scope.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Purview/getDefaultAccount
{
scopeTenantId:
{
Description: The tenant ID. ,
Format: uuid ,
Required: True ,
}
string ,
scopeType:
{
Description: The scope for the default account. ,
Required: True ,
}
string ,
scope:
{
Description: The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription. ,
Required: False ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
accountName:
{
Description: The name of the account that is set as the default. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: The resource group name of the account that is set as the default. ,
Required: False ,
}
string ,
scope:
{
Description: The scope object ID. For example, sub ID or tenant ID. ,
Required: False ,
}
string ,
scopeTenantId:
{
Description: The scope tenant in which the default account is set. ,
Required: False ,
}
string ,
scopeType:
{
Description: The scope where the default account is set. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The subscription ID of the account that is set as the default. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
DefaultAccounts_Set (removed)
Description :  Sets the default account for the scope.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Purview/setDefaultAccount
{
defaultAccountPayload:
{
Description: The payload containing the default account information and the scope. ,
Required: True ,
}
{
accountName:
{
Description: The name of the account that is set as the default. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: The resource group name of the account that is set as the default. ,
Required: False ,
}
string ,
scope:
{
Description: The scope object ID. For example, sub ID or tenant ID. ,
Required: False ,
}
string ,
scopeTenantId:
{
Description: The scope tenant in which the default account is set. ,
Required: False ,
}
string ,
scopeType:
{
Description: The scope where the default account is set. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The subscription ID of the account that is set as the default. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
accountName:
{
Description: The name of the account that is set as the default. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: The resource group name of the account that is set as the default. ,
Required: False ,
}
string ,
scope:
{
Description: The scope object ID. For example, sub ID or tenant ID. ,
Required: False ,
}
string ,
scopeTenantId:
{
Description: The scope tenant in which the default account is set. ,
Required: False ,
}
string ,
scopeType:
{
Description: The scope where the default account is set. ,
Enum:
{
Tenant: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The subscription ID of the account that is set as the default. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
DefaultAccounts_Remove (removed)
Description :  Removes the default account from the scope.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Purview/removeDefaultAccount
{
scopeTenantId:
{
Description: The tenant ID. ,
Format: uuid ,
Required: True ,
}
string ,
scopeType:
{
Description: The scope for the default account. ,
Required: True ,
}
string ,
scope:
{
Description: The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription. ,
Required: False ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Features_AccountGet (removed)
Description :  Gets details from a list of feature names.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/listFeatures
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
featureRequest:
{
Description: Request body with feature names. ,
Required: True ,
}
{
features:
{
Description: Set of features ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
features:
{
Description: Features with enabled status ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Features_SubscriptionGet (removed)
Description :  Gets details from a list of feature names.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Purview/locations/{locations}/listFeatures
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
locations:
{
Description: Location of feature. ,
Required: True ,
}
string ,
featureRequest:
{
Description: Request body with feature names. ,
Required: True ,
}
{
features:
{
Description: Set of features ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
features:
{
Description: Features with enabled status ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
KafkaConfigurations_Get (removed)
Description :  Gets the kafka configuration for the account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations/{kafkaConfigurationName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
kafkaConfigurationName:
{
Description: Name of kafka configuration. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the kafka configuration properties. ,
Required: False ,
}
{
consumerGroup:
{
Description: Consumer group for hook event hub. ,
Required: False ,
}
string ,
credentials:
{
Description: Credentials to access event hub. ,
Required: False ,
}
{
identityId:
{
Description: Identity identifier for UserAssign type. ,
Required: False ,
}
string ,
type:
{
Description: Identity Type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
eventHubResourceId:
{
Format: arm-id ,
Required: False ,
}
string ,
eventHubType:
{
Description: The event hub type. ,
Enum:
{
Notification: No description available. ,
Hook: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingState:
{
Description: The state of the event streaming service ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingType:
{
Description: The event streaming service type ,
Enum:
{
None: No description available. ,
Managed: No description available. ,
Azure: No description available. ,
}
,
Required: False ,
}
enum ,
eventHubPartitionId:
{
Description: Optional partition Id for notification event hub. If not set, all partitions will be leveraged. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
KafkaConfigurations_CreateOrUpdate (removed)
Description :  Create or update Kafka Configuration
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations/{kafkaConfigurationName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
kafkaConfigurationName:
{
Description: The kafka configuration name. ,
Required: True ,
}
string ,
kafkaConfiguration:
{
Description: The kafka configuration of the account. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the kafka configuration properties. ,
Required: False ,
}
{
consumerGroup:
{
Description: Consumer group for hook event hub. ,
Required: False ,
}
string ,
credentials:
{
Description: Credentials to access event hub. ,
Required: False ,
}
{
identityId:
{
Description: Identity identifier for UserAssign type. ,
Required: False ,
}
string ,
type:
{
Description: Identity Type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
eventHubResourceId:
{
Format: arm-id ,
Required: False ,
}
string ,
eventHubType:
{
Description: The event hub type. ,
Enum:
{
Notification: No description available. ,
Hook: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingState:
{
Description: The state of the event streaming service ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingType:
{
Description: The event streaming service type ,
Enum:
{
None: No description available. ,
Managed: No description available. ,
Azure: No description available. ,
}
,
Required: False ,
}
enum ,
eventHubPartitionId:
{
Description: Optional partition Id for notification event hub. If not set, all partitions will be leveraged. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the kafka configuration properties. ,
Required: False ,
}
{
consumerGroup:
{
Description: Consumer group for hook event hub. ,
Required: False ,
}
string ,
credentials:
{
Description: Credentials to access event hub. ,
Required: False ,
}
{
identityId:
{
Description: Identity identifier for UserAssign type. ,
Required: False ,
}
string ,
type:
{
Description: Identity Type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
eventHubResourceId:
{
Format: arm-id ,
Required: False ,
}
string ,
eventHubType:
{
Description: The event hub type. ,
Enum:
{
Notification: No description available. ,
Hook: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingState:
{
Description: The state of the event streaming service ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingType:
{
Description: The event streaming service type ,
Enum:
{
None: No description available. ,
Managed: No description available. ,
Azure: No description available. ,
}
,
Required: False ,
}
enum ,
eventHubPartitionId:
{
Description: Optional partition Id for notification event hub. If not set, all partitions will be leveraged. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the kafka configuration properties. ,
Required: False ,
}
{
consumerGroup:
{
Description: Consumer group for hook event hub. ,
Required: False ,
}
string ,
credentials:
{
Description: Credentials to access event hub. ,
Required: False ,
}
{
identityId:
{
Description: Identity identifier for UserAssign type. ,
Required: False ,
}
string ,
type:
{
Description: Identity Type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
eventHubResourceId:
{
Format: arm-id ,
Required: False ,
}
string ,
eventHubType:
{
Description: The event hub type. ,
Enum:
{
Notification: No description available. ,
Hook: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingState:
{
Description: The state of the event streaming service ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingType:
{
Description: The event streaming service type ,
Enum:
{
None: No description available. ,
Managed: No description available. ,
Azure: No description available. ,
}
,
Required: False ,
}
enum ,
eventHubPartitionId:
{
Description: Optional partition Id for notification event hub. If not set, all partitions will be leveraged. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
KafkaConfigurations_Delete (removed)
Description :  Deletes a KafkaConfiguration resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations/{kafkaConfigurationName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
kafkaConfigurationName:
{
Description: Name of kafka configuration. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
KafkaConfigurations_ListByAccount (removed)
Description :  Lists the Kafka configurations in the Account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: The skip token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type results. ,
Required: True ,
}
[
{
properties:
{
Description: Gets or sets the kafka configuration properties. ,
Required: False ,
}
{
consumerGroup:
{
Description: Consumer group for hook event hub. ,
Required: False ,
}
string ,
credentials:
{
Description: Credentials to access event hub. ,
Required: False ,
}
{
identityId:
{
Description: Identity identifier for UserAssign type. ,
Required: False ,
}
string ,
type:
{
Description: Identity Type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
eventHubResourceId:
{
Format: arm-id ,
Required: False ,
}
string ,
eventHubType:
{
Description: The event hub type. ,
Enum:
{
Notification: No description available. ,
Hook: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingState:
{
Description: The state of the event streaming service ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
eventStreamingType:
{
Description: The event streaming service type ,
Enum:
{
None: No description available. ,
Managed: No description available. ,
Azure: No description available. ,
}
,
Required: False ,
}
enum ,
eventHubPartitionId:
{
Description: Optional partition Id for notification event hub. If not set, all partitions will be leveraged. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Operations_List (removed)
Description :  List of available operations
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Purview/operations
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type results. ,
Required: True ,
}
[
{
display:
{
Description: Properties on the operation ,
Required: False ,
}
{
description:
{
Description: Description of the operation for display purposes ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation for display purposes ,
Required: False ,
}
string ,
provider:
{
Description: Name of the provider for display purposes ,
Required: False ,
}
string ,
resource:
{
Description: Name of the resource type for display purposes ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: Whether operation is a data action ,
Required: False ,
}
boolean ,
name:
{
Description: Operation name for display purposes ,
Required: False ,
}
string ,
origin:
{
Description: origin of the operation ,
Required: False ,
}
string ,
properties:
{
Description: properties for the operation meta info ,
Required: False ,
}
{
serviceSpecification:
{
Description: meta service specification ,
Required: False ,
}
{
logSpecifications:
{
Description: log specifications for the operation ,
Required: False ,
}
[
{
blobDuration:
{
Description: blob duration of the log ,
Required: False ,
}
string ,
displayName:
{
Description: localized name of the log category ,
Required: False ,
}
string ,
name:
{
Description: name of the log category ,
Required: False ,
}
string ,
}
,
]
,
metricSpecifications:
{
Description: metric specifications for the operation ,
Required: False ,
}
[
{
aggregationType:
{
Description: aggregation type of metric ,
Required: False ,
}
string ,
dimensions:
{
Description: properties for dimension ,
Required: False ,
}
[
{
displayName:
{
Description: localized display name of the dimension to customer ,
Required: False ,
}
string ,
name:
{
Description: dimension name ,
Required: False ,
}
string ,
toBeExportedForCustomer:
{
Description: flag indicating whether this dimension should be included to the customer in Azure Monitor logs (aka Shoebox) ,
Required: False ,
}
boolean ,
}
,
]
,
displayDescription:
{
Description: description of the metric ,
Required: False ,
}
string ,
displayName:
{
Description: localized name of the metric ,
Required: False ,
}
string ,
enableRegionalMdmAccount:
{
Description: enable regional mdm account ,
Required: False ,
}
string ,
internalMetricName:
{
Description: internal metric name ,
Required: False ,
}
string ,
name:
{
Description: name of the metric ,
Required: False ,
}
string ,
resourceIdDimensionNameOverride:
{
Description: dimension name use to replace resource id if specified ,
Required: False ,
}
string ,
sourceMdmNamespace:
{
Description: Metric namespace. Only set the namespace if different from the default value, leaving it empty makes it use the value from the ARM manifest. ,
Required: False ,
}
string ,
supportedAggregationTypes:
{
Description: supported aggregation types ,
Required: False ,
}
[
string ,
]
,
supportedTimeGrainTypes:
{
Description: supported time grain types ,
Required: False ,
}
[
string ,
]
,
unit:
{
Description: units for the metric ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_ListByAccount (removed)
Description :  Get private endpoint connections for account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: The skip token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type results. ,
Required: True ,
}
[
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_Get (removed)
Description :  Get a private endpoint connection
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Name of the private endpoint connection. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_CreateOrUpdate (removed)
Description :  Create or update a private endpoint connection
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Name of the private endpoint connection. ,
Required: True ,
}
string ,
request:
{
Description: The request. ,
Required: True ,
}
{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_Delete (removed)
Description :  Delete a private endpoint connection
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Name of the private endpoint connection. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
PrivateLinkResources_ListByAccount (removed)
Description :  Gets a list of privately linkable resources for an account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateLinkResources
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type results. ,
Required: True ,
}
[
{
id:
{
Description: The private link resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The private link resource name. ,
Required: False ,
}
string ,
properties:
{
Description: The private link resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group identifier. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: This translates to how many Private IPs should be created for each privately linkable resource. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The required zone names for private link resource. ,
Required: False ,
}
[
string ,
]
,
}
,
type:
{
Description: The private link resource type. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
PrivateLinkResources_GetByGroupId (removed)
Description :  Gets a privately linkable resources for an account with given group identifier
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateLinkResources/{groupId}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the account. ,
Required: True ,
}
string ,
groupId:
{
Description: The group identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The private link resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The private link resource name. ,
Required: False ,
}
string ,
properties:
{
Description: The private link resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group identifier. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: This translates to how many Private IPs should be created for each privately linkable resource. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The required zone names for private link resource. ,
Required: False ,
}
[
string ,
]
,
}
,
type:
{
Description: The private link resource type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_CheckNameAvailability (removed)
Description :  Checks if account name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Purview/checkNameAvailability
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
checkNameAvailabilityRequest:
{
Description: The check name availability request. ,
Required: True ,
}
{
name:
{
Description: Resource name to verify for availability ,
Required: False ,
}
string ,
type:
{
Description: Fully qualified resource type which includes provider namespace ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
message:
{
Description: Error message ,
Required: False ,
}
string ,
nameAvailable:
{
Description: Indicates if name is valid and available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason the name is not available. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Usages_Get (removed)
Description :  Get the usage quota configuration
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Purview/locations/{location}/usages
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
location:
{
Description: The region. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$filter:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of usage values. ,
Required: False ,
}
[
{
currentValue:
{
Description: Current usage quota value ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: Fully qualified ARM resource Id ,
Required: False ,
}
string ,
limit:
{
Description: Usage quota limit ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Quota name ,
Required: False ,
}
string ,
unit:
{
Description: Quota usage unit. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}