Accounts - List By Resource Group
Gets the accounts resources by resource group.
List accounts in ResourceGroup
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts?api-version=2021-12-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts?api-version=2021-12-01&$skipToken={$skipToken}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The resource group name. |
subscription
|
path | True |
string |
The subscription identifier |
api-version
|
query | True |
string |
The api version to use. |
$skip
|
query |
string |
The skip token. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Success |
|
Other Status Codes |
An error response received from the provider. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Accounts_ListByResourceGroup
Sample Request
GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts?api-version=2021-12-01
Sample Response
Date: Wed, 13 Sep 2017 17:33:55 GMT
x-ms-request-id: 8e58266a-de42-40d5-b3c4-c6a7e159cfba
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14993
x-ms-correlation-request-id: 5d862c55-4de9-4a46-969d-cf1ed3e235ed
{
"value": [
{
"location": "West US 2",
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1",
"name": "account1",
"type": "Microsoft.Purview/accounts",
"sku": {
"name": "Standard",
"capacity": 1
},
"systemData": {
"createdBy": "client-name",
"createdByType": "User",
"createdAt": "2019-11-22T18:39:58.6929344Z",
"lastModifiedBy": "client-name",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-03-16T23:24:34.3430059Z"
},
"properties": {
"friendlyName": "friendly-account1",
"provisioningState": "Succeeded",
"accountStatus": {
"accountProvisioningState": "Succeeded",
"errorDetails": {}
},
"endpoints": {
"catalog": "https://account1.catalog.purview.azure-test.com",
"scan": "https://account1.scan.purview.azure-test.com",
"guardian": "https://account1.guardian.purview.azure-test.com"
},
"publicNetworkAccess": "Enabled"
}
},
{
"location": "West US 2",
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account2",
"name": "account2",
"type": "Microsoft.Purview/accounts",
"sku": {
"name": "Standard",
"capacity": 1
},
"systemData": {
"createdBy": "client-name",
"createdByType": "User",
"createdAt": "2019-11-22T18:39:58.6929344Z",
"lastModifiedBy": "client-name",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-03-16T23:24:34.3430059Z"
},
"properties": {
"friendlyName": "friendly-account1",
"provisioningState": "Succeeded",
"endpoints": {
"catalog": "https://account2.catalog.purview.azure-test.com",
"scan": "https://account2.scan.purview.azure-test.com",
"guardian": "https://account1.guardian.purview.azure-test.com"
},
"publicNetworkAccess": "Enabled"
}
}
]
}
Definitions
Name | Description |
---|---|
Account |
Account resource |
Account |
Paged list of Account resources |
account |
Gets the account status code. |
Account |
Gets or sets the status of the account. |
Cloud |
External Cloud Service connectors |
created |
The type of identity that created the resource. |
Endpoints |
The URIs that are the public endpoints of the account. |
Error |
Gets or sets the error. |
Error |
Gets the account error details. |
Error |
Default error model |
Error |
Default error response model |
Identity |
The Managed Identity of the resource |
last |
The type of identity that last modified the resource. |
managed |
Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. |
Managed |
Gets the resource identifiers of the managed resources. |
managed |
Gets or sets the public network access for managed resources. |
name |
Gets or sets the sku name. |
Private |
A private endpoint class. |
Private |
A private endpoint connection class. |
Private |
The private link service connection state. |
provisioning |
Gets or sets the state of the provisioning. |
public |
Gets or sets the public network access. |
Sku |
Gets or sets the Sku. |
status |
The status. |
System |
Metadata pertaining to creation and last modification of the resource. |
Tracked |
Metadata pertaining to creation and last modification of the resource. |
type |
Identity Type |
User |
Uses client ID and Principal ID |
Account
Account resource
Name | Type | Default Value | Description |
---|---|---|---|
id |
string |
Gets or sets the identifier. |
|
identity |
Identity Info on the tracked resource |
||
location |
string |
Gets or sets the location. |
|
name |
string |
Gets or sets the name. |
|
properties.accountStatus |
Gets or sets the status of the account. |
||
properties.cloudConnectors |
Cloud connectors. External cloud identifier used as part of scanning configuration. |
||
properties.createdAt |
string |
Gets the time at which the entity was created. |
|
properties.createdBy |
string |
Gets the creator of the entity. |
|
properties.createdByObjectId |
string |
Gets the creators of the entity's object id. |
|
properties.endpoints |
The URIs that are the public endpoints of the account. |
||
properties.friendlyName |
string |
Gets or sets the friendly name. |
|
properties.managedEventHubState | NotSpecified |
Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. |
|
properties.managedResourceGroupName |
string |
Gets or sets the managed resource group name |
|
properties.managedResources |
Gets the resource identifiers of the managed resources. |
||
properties.managedResourcesPublicNetworkAccess | NotSpecified |
Gets or sets the public network access for managed resources. |
|
properties.privateEndpointConnections |
Gets the private endpoint connections information. |
||
properties.provisioningState |
Gets or sets the state of the provisioning. |
||
properties.publicNetworkAccess | Enabled |
Gets or sets the public network access. |
|
sku |
Gets or sets the Sku. |
||
systemData |
Metadata pertaining to creation and last modification of the resource. |
||
tags |
object |
Tags on the azure resource. |
|
type |
string |
Gets or sets the type. |
AccountList
Paged list of Account resources
Name | Type | Description |
---|---|---|
count |
integer |
Total item count. |
nextLink |
string |
The Url of next result page. |
value |
Account[] |
Collection of items of type results. |
accountProvisioningState
Gets the account status code.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Moving |
string |
|
SoftDeleted |
string |
|
SoftDeleting |
string |
|
Succeeded |
string |
|
Unknown |
string |
|
Updating |
string |
AccountStatus
Gets or sets the status of the account.
Name | Type | Description |
---|---|---|
accountProvisioningState |
Gets the account status code. |
|
errorDetails |
Gets the account error details. |
CloudConnectors
External Cloud Service connectors
Name | Type | Description |
---|---|---|
awsExternalId |
string |
AWS external identifier. Configured in AWS to allow use of the role arn used for scanning |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Endpoints
The URIs that are the public endpoints of the account.
Name | Type | Description |
---|---|---|
catalog |
string |
Gets the catalog endpoint. |
guardian |
string |
Gets the guardian endpoint. |
scan |
string |
Gets the scan endpoint. |
Error
Gets or sets the error.
Name | Type | Description |
---|---|---|
code |
string |
Gets or sets the code. |
details |
Gets or sets the details. |
|
message |
string |
Gets or sets the messages. |
target |
string |
Gets or sets the target. |
ErrorDetails
Gets the account error details.
Name | Type | Description |
---|---|---|
code |
string |
Gets or sets the code. |
details |
Gets or sets the details. |
|
message |
string |
Gets or sets the messages. |
target |
string |
Gets or sets the target. |
ErrorModel
Default error model
Name | Type | Description |
---|---|---|
code |
string |
Gets or sets the code. |
details |
Gets or sets the details. |
|
message |
string |
Gets or sets the messages. |
target |
string |
Gets or sets the target. |
ErrorResponseModel
Default error response model
Name | Type | Description |
---|---|---|
error |
Gets or sets the error. |
Identity
The Managed Identity of the resource
Name | Type | Description |
---|---|---|
principalId |
string |
Service principal object Id |
tenantId |
string |
Tenant Id |
type |
Identity Type |
|
userAssignedIdentities |
<string,
User |
User Assigned Identities |
lastModifiedByType
The type of identity that last modified the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
managedEventHubState
Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
|
NotSpecified |
string |
ManagedResources
Gets the resource identifiers of the managed resources.
Name | Type | Description |
---|---|---|
eventHubNamespace |
string |
Gets the managed event hub namespace resource identifier. |
resourceGroup |
string |
Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account. |
storageAccount |
string |
Gets the managed storage account resource identifier. |
managedResourcesPublicNetworkAccess
Gets or sets the public network access for managed resources.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
|
NotSpecified |
string |
name
Gets or sets the sku name.
Name | Type | Description |
---|---|---|
Standard |
string |
PrivateEndpoint
A private endpoint class.
Name | Type | Description |
---|---|---|
id |
string |
The private endpoint identifier. |
PrivateEndpointConnection
A private endpoint connection class.
Name | Type | Description |
---|---|---|
id |
string |
Gets or sets the identifier. |
name |
string |
Gets or sets the name. |
properties.privateEndpoint |
The private endpoint information. |
|
properties.privateLinkServiceConnectionState |
The private link service connection state. |
|
properties.provisioningState |
string |
The provisioning state. |
systemData |
Metadata pertaining to creation and last modification of the resource. |
|
type |
string |
Gets or sets the type. |
PrivateLinkServiceConnectionState
The private link service connection state.
Name | Type | Description |
---|---|---|
actionsRequired |
string |
The required actions. |
description |
string |
The description. |
status |
The status. |
provisioningState
Gets or sets the state of the provisioning.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Moving |
string |
|
SoftDeleted |
string |
|
SoftDeleting |
string |
|
Succeeded |
string |
|
Unknown |
string |
publicNetworkAccess
Gets or sets the public network access.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
|
NotSpecified |
string |
Sku
Gets or sets the Sku.
Name | Type | Description |
---|---|---|
capacity |
integer |
Gets or sets the sku capacity. |
name |
Gets or sets the sku name. |
status
The status.
Name | Type | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
|
Unknown |
string |
SystemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of the last modification the resource (UTC). |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |
TrackedResource.SystemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of the last modification the resource (UTC). |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |
type
Identity Type
Name | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
UserAssigned |
string |
UserAssignedIdentity
Uses client ID and Principal ID
Name | Type | Description |
---|---|---|
clientId |
string |
Gets or Sets Client ID |
principalId |
string |
Gets or Sets Principal ID |