Accounts - Get

Service:: Purview

API Version:: 2021-12-01

Gets the account resource.
Get an account

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}?api-version=2021-12-01

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	The name of the account.
resourceGroupName	path	True	string	The resource group name.
subscriptionId	path	True	string	The subscription identifier
api-version	query	True	string	The api version to use.

Responses

Name	Type	Description
200 OK	Account	Success
Other Status Codes	ErrorResponseModel	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_Get

Sample request

HTTP

GET https://management.azure.com/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1?api-version=2021-12-01

Sample response

Status code:: 200

Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-tenant-reads: 14999
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd

{
  "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"
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "provisioningState": "Succeeded",
          "privateEndpoint": {
            "id": "/subscriptions/baca8a88-4527-4c35-a13e-b2775ce0d7fc/resourceGroups/nrpResourceGroupName/providers/Microsoft.Network/privateEndpoints/peName"
          },
          "privateLinkServiceConnectionState": {
            "status": "Pending",
            "description": "Please approve my connection, thanks.",
            "actionsRequired": "None"
          }
        },
        "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/peName-8536c337-7b36-4d67-a7ce-081655baf59e",
        "name": "peName-8536c337-7b36-4d67-a7ce-081655baf59e",
        "type": "Microsoft.Purview/accounts/privateEndpointConnections"
      }
    ],
    "publicNetworkAccess": "Enabled",
    "managedResourceGroupName": "managed-rg-mwjotkl",
    "managedResourcesPublicNetworkAccess": "Enabled",
    "managedResources": {
      "resourceGroup": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl",
      "storageAccount": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr",
      "eventHubNamespace": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp"
    }
  }
}

Definitions

Name	Description
Account	Account resource
accountProvisioningState	Gets the account status code.
AccountStatus	Gets or sets the status of the account.
CloudConnectors	External Cloud Service connectors
createdByType	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.
ErrorDetails	Gets the account error details.
ErrorModel	Default error model
ErrorResponseModel	Default error response model
Identity	The Managed Identity of the resource
lastModifiedByType	The type of identity that last modified the resource.
managedEventHubState	Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed.
ManagedResources	Gets the resource identifiers of the managed resources.
managedResourcesPublicNetworkAccess	Gets or sets the public network access for managed resources.
name	Gets or sets the sku name.
PrivateEndpoint	A private endpoint class.
PrivateEndpointConnection	A private endpoint connection class.
PrivateLinkServiceConnectionState	The private link service connection state.
provisioningState	Gets or sets the state of the provisioning.
publicNetworkAccess	Gets or sets the public network access.
Sku	Gets or sets the Sku.
status	The status.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource.SystemData	Metadata pertaining to creation and last modification of the resource.
type	Identity Type
UserAssignedIdentity	Uses client ID and Principal ID

Account

Object

Account resource

Name	Type	Default value	Description
id	string		Gets or sets the identifier.
identity	Identity		Identity Info on the tracked resource
location	string		Gets or sets the location.
name	string		Gets or sets the name.
properties.accountStatus	AccountStatus		Gets or sets the status of the account.
properties.cloudConnectors	CloudConnectors		Cloud connectors. External cloud identifier used as part of scanning configuration.
properties.createdAt	string (date-time)		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	Endpoints		The URIs that are the public endpoints of the account.
properties.friendlyName	string		Gets or sets the friendly name.
properties.managedEventHubState	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	ManagedResources		Gets the resource identifiers of the managed resources.
properties.managedResourcesPublicNetworkAccess	managedResourcesPublicNetworkAccess	NotSpecified	Gets or sets the public network access for managed resources.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Gets the private endpoint connections information.
properties.provisioningState	provisioningState		Gets or sets the state of the provisioning.
properties.publicNetworkAccess	publicNetworkAccess	Enabled	Gets or sets the public network access.
sku	Sku		Gets or sets the Sku.
systemData	TrackedResource.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.

accountProvisioningState

Enumeration

Gets the account status code.

Value	Description
Unknown
Creating
Updating
Moving
Deleting
SoftDeleting
SoftDeleted
Failed
Succeeded
Canceled

AccountStatus

Object

Gets or sets the status of the account.

Name	Type	Description
accountProvisioningState	accountProvisioningState	Gets the account status code.
errorDetails	ErrorDetails	Gets the account error details.

CloudConnectors

Object

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

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

Endpoints

Object

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

Object

Gets or sets the error.

Name	Type	Description
code	string	Gets or sets the code.
details	ErrorModel[]	Gets or sets the details.
message	string	Gets or sets the messages.
target	string	Gets or sets the target.

ErrorDetails

Object

Gets the account error details.

Name	Type	Description
code	string	Gets or sets the code.
details	ErrorModel[]	Gets or sets the details.
message	string	Gets or sets the messages.
target	string	Gets or sets the target.

ErrorModel

Object

Default error model

Name	Type	Description
code	string	Gets or sets the code.
details	ErrorModel[]	Gets or sets the details.
message	string	Gets or sets the messages.
target	string	Gets or sets the target.

ErrorResponseModel

Object

Default error response model

Name	Type	Description
error	Error	Gets or sets the error.

Identity

Object

The Managed Identity of the resource

Name	Type	Description
principalId	string	Service principal object Id
tenantId	string	Tenant Id
type	type	Identity Type
userAssignedIdentities	<string, UserAssignedIdentity>	User Assigned Identities

lastModifiedByType

Enumeration

The type of identity that last modified the resource.

Value	Description
User
Application
ManagedIdentity
Key

managedEventHubState

Enumeration

Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed.

Value	Description
NotSpecified
Disabled
Enabled

ManagedResources

Object

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

Enumeration

Gets or sets the public network access for managed resources.

Value	Description
NotSpecified
Enabled
Disabled

name

Enumeration

Gets or sets the sku name.

Value	Description
Standard

PrivateEndpoint

Object

A private endpoint class.

Name	Type	Description
id	string	The private endpoint identifier.

PrivateEndpointConnection

Object

A private endpoint connection class.

Name	Type	Description
id	string	Gets or sets the identifier.
name	string	Gets or sets the name.
properties.privateEndpoint	PrivateEndpoint	The private endpoint information.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	The private link service connection state.
properties.provisioningState	string	The provisioning state.
systemData	SystemData	Metadata pertaining to creation and last modification of the resource.
type	string	Gets or sets the type.

PrivateLinkServiceConnectionState

Object

The private link service connection state.

Name	Type	Description
actionsRequired	string	The required actions.
description	string	The description.
status	status	The status.

provisioningState

Enumeration

Gets or sets the state of the provisioning.

Value	Description
Unknown
Creating
Moving
Deleting
SoftDeleting
SoftDeleted
Failed
Succeeded
Canceled

publicNetworkAccess

Enumeration

Gets or sets the public network access.

Value	Description
NotSpecified
Enabled
Disabled

Sku

Object

Gets or sets the Sku.

Name	Type	Description
capacity	integer (int32)	Gets or sets the sku capacity.
name	name	Gets or sets the sku name.

status

Enumeration

The status.

Value	Description
Unknown
Pending
Approved
Rejected
Disconnected

SystemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of the last modification the resource (UTC).
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	lastModifiedByType	The type of identity that last modified the resource.

TrackedResource.SystemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of the last modification the resource (UTC).
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	lastModifiedByType	The type of identity that last modified the resource.

type

Enumeration

Identity Type

Value	Description
None
SystemAssigned
UserAssigned

UserAssignedIdentity

Object

Uses client ID and Principal ID

Name	Type	Description
clientId	string	Gets or Sets Client ID
principalId	string	Gets or Sets Principal ID

Share via

Accounts - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Accounts_Get

Sample request

Sample response

Definitions

Account

accountProvisioningState

AccountStatus

CloudConnectors

createdByType

Endpoints

Error

ErrorDetails

ErrorModel

ErrorResponseModel

Identity

lastModifiedByType

managedEventHubState

ManagedResources

managedResourcesPublicNetworkAccess

name

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkServiceConnectionState

provisioningState

publicNetworkAccess

Sku

status

SystemData

TrackedResource.SystemData

type

UserAssignedIdentity