Accounts - Get Account Properties

Service:

Purview

API Version:

2019-11-01-preview

Get an account

GET {endpoint}/?api-version=2019-11-01-preview

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string	The account endpoint of your Purview account. Example: https://{accountName}.purview.azure.com/account/
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_GetAccountProperties

Sample Request

HTTP

GET {endpoint}/?api-version=2019-11-01-preview

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

Response Body

{
  "location": "West US 2",
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.ProjectBabylon/accounts/account1",
  "name": "account1",
  "type": "Microsoft.ProjectBabylon/accounts",
  "sku": {
    "name": "Standard",
    "capacity": 4
  },
  "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",
    "createdBy": "client-name",
    "createdByObjectId": "client-objectId",
    "createdAt": "2019-11-22T18:39:58.6929344Z",
    "provisioningState": "Succeeded",
    "endpoints": {
      "catalog": "https://account1.catalog.babylon.azure-test.com",
      "scan": "https://account1.scan.babylon.azure-test.com",
      "guardian": "https://account1.guardian.babylon.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.ProjectBabylon/accounts/account1/privateEndpointConnections/peName-8536c337-7b36-4d67-a7ce-081655baf59e",
        "name": "peName-8536c337-7b36-4d67-a7ce-081655baf59e",
        "type": "Microsoft.ProjectBabylon/accounts/privateEndpointConnections"
      }
    ],
    "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
AccountProperties	The account properties
AccountSku	The Sku
CloudConnectors
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.
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.
ManagedResources	The managed resources in customer subscription.
name	Gets or sets the sku name.
PrivateEndpoint	A private endpoint class.
PrivateEndpointConnection	A private endpoint connection class.
PrivateEndpointConnectionProperties	A private endpoint connection properties 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.
status	The status.
SystemData	Metadata pertaining to creation and last modification of the resource.
type	Identity Type

Account

Account resource

Name	Type	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	AccountProperties	Gets or sets the properties.
sku	AccountSku	Gets or sets the Sku.
systemData	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.

AccountProperties

The account properties

Name	Type	Default Value	Description
cloudConnectors	CloudConnectors		Cloud connectors. External cloud identifier used as part of scanning configuration.
createdAt	string		Gets the time at which the entity was created.
createdBy	string		Gets the creator of the entity.
createdByObjectId	string		Gets the creators of the entity's object id.
endpoints	Endpoints		The URIs that are the public endpoints of the account.
friendlyName	string		Gets or sets the friendly name.
managedResourceGroupName	string		Gets or sets the managed resource group name
managedResources	ManagedResources		Gets the resource identifiers of the managed resources.
privateEndpointConnections	PrivateEndpointConnection[]		Gets the private endpoint connections information.
provisioningState	provisioningState		Gets or sets the state of the provisioning.
publicNetworkAccess	publicNetworkAccess	Enabled	Gets or sets the public network access.

AccountSku

The Sku

Name	Type	Description
capacity	integer	Gets or sets the sku capacity. Possible values include: 4, 16
name	name	Gets or sets the sku name.

CloudConnectors

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	ErrorModel[]	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	ErrorModel[]	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	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	type	Identity Type

lastModifiedByType

The type of identity that last modified the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedResources

The managed resources in customer subscription.

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.

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	PrivateEndpointConnectionProperties	The connection identifier.
type	string	Gets or sets the type.

PrivateEndpointConnectionProperties

A private endpoint connection properties class.

Name	Type	Description
privateEndpoint	PrivateEndpoint	The private endpoint information.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	The private link service connection state.
provisioningState	string	The provisioning state.

PrivateLinkServiceConnectionState

The private link service connection state.

Name	Type	Description
actionsRequired	string	The required actions.
description	string	The description.
status	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

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	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	lastModifiedByType	The type of identity that last modified the resource.

type

Identity Type

Name	Type	Description
SystemAssigned	string