Accounts - List By Subscription

Ссылка

Service:: Purview

API Version:: 2021-12-01

Возвращает ресурсы учетных записей по подписке.
Перечисление учетных записей в подписке

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

With optional parameters:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
subscriptionId	path	True	string	Идентификатор подписки
api-version	query	True	string	Используемая версия API.
$skipToken	query		string	Токен пропуска.

Ответы

Имя	Тип	Описание
200 OK	AccountList	Успешное завершение
Other Status Codes	ErrorResponseModel	От поставщика получен ответ об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Accounts_ListBySubscription

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Purview/accounts?api-version=2021-12-01

Sample Response

Status code:: 200

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

Response Body

{
  "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"
      }
    }
  ]
}

Определения

Имя	Описание
Account	Ресурс учетной записи
AccountList	Страничный список ресурсов учетной записи
accountProvisioningState	Возвращает код состояния учетной записи.
AccountStatus	Возвращает или задает состояние учетной записи.
CloudConnectors	Соединители внешних облачных служб
createdByType	Тип удостоверения, создавшего ресурс.
Endpoints	URI, которые являются общедоступными конечными точками учетной записи.
Error	Возвращает или задает ошибку.
ErrorDetails	Возвращает сведения об ошибке учетной записи.
ErrorModel	Модель ошибок по умолчанию
ErrorResponseModel	Модель ответа на ошибки по умолчанию
Identity	Управляемое удостоверение ресурса
lastModifiedByType	Тип удостоверения, которое последним изменял ресурс.
managedEventHubState	Возвращает или задает состояние управляемого концентратора событий. Если управляемый концентратор событий включен, будет создан, если он отключен, управляемый концентратор событий будет удален.
ManagedResources	Возвращает идентификаторы управляемых ресурсов.
managedResourcesPublicNetworkAccess	Возвращает или задает доступ к общедоступной сети для управляемых ресурсов.
name	Возвращает или задает имя SKU.
PrivateEndpoint	Класс частной конечной точки.
PrivateEndpointConnection	Класс подключения к частной конечной точке.
PrivateLinkServiceConnectionState	Состояние подключения службы приватного канала.
provisioningState	Получает или задает состояние подготовки.
publicNetworkAccess	Возвращает или задает доступ к общедоступной сети.
Sku	Возвращает или задает номер SKU.
status	Состояние.
SystemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
TrackedResource.SystemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
type	Identity Type
UserAssignedIdentity	Использует идентификатор клиента и идентификатор субъекта

Account

Ресурс учетной записи

Имя	Тип	Значение по умолчанию	Описание
id	string		Возвращает или задает идентификатор.
identity	Identity		Сведения об удостоверениях для отслеживаемого ресурса
location	string		Получает или задает расположение.
name	string		Возвращает или задает имя.
properties.accountStatus	AccountStatus		Возвращает или задает состояние учетной записи.
properties.cloudConnectors	CloudConnectors		Облачные соединители. Идентификатор внешнего облака, используемый в рамках конфигурации сканирования.
properties.createdAt	string		Возвращает время создания сущности.
properties.createdBy	string		Возвращает создателя сущности.
properties.createdByObjectId	string		Возвращает создателей идентификатора объекта сущности.
properties.endpoints	Endpoints		URI, которые являются общедоступными конечными точками учетной записи.
properties.friendlyName	string		Возвращает или задает понятное имя.
properties.managedEventHubState	managedEventHubState	NotSpecified	Возвращает или задает состояние управляемого концентратора событий. Если управляемый концентратор событий включен, будет создан, если он отключен, управляемый концентратор событий будет удален.
properties.managedResourceGroupName	string		Возвращает или задает имя управляемой группы ресурсов.
properties.managedResources	ManagedResources		Возвращает идентификаторы управляемых ресурсов.
properties.managedResourcesPublicNetworkAccess	managedResourcesPublicNetworkAccess	NotSpecified	Возвращает или задает доступ к общедоступной сети для управляемых ресурсов.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Возвращает сведения о подключениях к частной конечной точке.
properties.provisioningState	provisioningState		Получает или задает состояние подготовки.
properties.publicNetworkAccess	publicNetworkAccess	Enabled	Возвращает или задает доступ к общедоступной сети.
sku	Sku		Возвращает или задает номер SKU.
systemData	TrackedResource.SystemData		Метаданные, относящиеся к созданию и последнему изменению ресурса.
tags	object		Теги в ресурсе Azure.
type	string		Возвращает или задает тип .

AccountList

Страничный список ресурсов учетной записи

Имя	Тип	Описание
count	integer	Общее количество элементов.
nextLink	string	URL-адрес следующей страницы результатов.
value	Account[]	Коллекция элементов типа результатов.

accountProvisioningState

Возвращает код состояния учетной записи.

Имя	Тип	Описание
Canceled	string
Creating	string
Deleting	string
Failed	string
Moving	string
SoftDeleted	string
SoftDeleting	string
Succeeded	string
Unknown	string
Updating	string

AccountStatus

Возвращает или задает состояние учетной записи.

Имя	Тип	Описание
accountProvisioningState	accountProvisioningState	Возвращает код состояния учетной записи.
errorDetails	ErrorDetails	Возвращает сведения об ошибке учетной записи.

CloudConnectors

Соединители внешних облачных служб

Имя	Тип	Описание
awsExternalId	string	Внешний идентификатор AWS. Настроено в AWS для разрешения использования роли arn, используемой для сканирования

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

Endpoints

URI, которые являются общедоступными конечными точками учетной записи.

Имя	Тип	Описание
catalog	string	Возвращает конечную точку каталога.
guardian	string	Возвращает конечную точку защиты.
scan	string	Возвращает конечную точку сканирования.

Error

Возвращает или задает ошибку.

Имя	Тип	Описание
code	string	Возвращает или задает код.
details	ErrorModel[]	Возвращает или задает сведения.
message	string	Возвращает или задает сообщения.
target	string	Возвращает или задает целевой объект.

ErrorDetails

Возвращает сведения об ошибке учетной записи.

Имя	Тип	Описание
code	string	Возвращает или задает код.
details	ErrorModel[]	Возвращает или задает сведения.
message	string	Возвращает или задает сообщения.
target	string	Возвращает или задает целевой объект.

ErrorModel

Модель ошибок по умолчанию

Имя	Тип	Описание
code	string	Возвращает или задает код.
details	ErrorModel[]	Возвращает или задает сведения.
message	string	Возвращает или задает сообщения.
target	string	Возвращает или задает целевой объект.

ErrorResponseModel

Модель ответа на ошибки по умолчанию

Имя	Тип	Описание
error	Error	Возвращает или задает ошибку.

Identity

Управляемое удостоверение ресурса

Имя	Тип	Описание
principalId	string	Идентификатор объекта субъекта-службы
tenantId	string	Идентификатор клиента
type	type	Identity Type
userAssignedIdentities	<string, UserAssignedIdentity>	Удостоверения, назначаемые пользователем

lastModifiedByType

Тип удостоверения, которое последним изменял ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

managedEventHubState

Возвращает или задает состояние управляемого концентратора событий. Если управляемый концентратор событий включен, будет создан, если он отключен, управляемый концентратор событий будет удален.

Имя	Тип	Описание
Disabled	string
Enabled	string
NotSpecified	string

ManagedResources

Возвращает идентификаторы управляемых ресурсов.

Имя	Тип	Описание
eventHubNamespace	string	Возвращает идентификатор ресурса пространства имен управляемого концентратора событий.
resourceGroup	string	Возвращает идентификатор ресурса управляемой группы ресурсов. Эта группа ресурсов будет размещать зависимости ресурсов для учетной записи.
storageAccount	string	Возвращает идентификатор ресурса управляемой учетной записи хранения.

managedResourcesPublicNetworkAccess

Возвращает или задает доступ к общедоступной сети для управляемых ресурсов.

Имя	Тип	Описание
Disabled	string
Enabled	string
NotSpecified	string

name

Возвращает или задает имя SKU.

Имя	Тип	Описание
Standard	string

PrivateEndpoint

Класс частной конечной точки.

Имя	Тип	Описание
id	string	Идентификатор частной конечной точки.

PrivateEndpointConnection

Класс подключения к частной конечной точке.

Имя	Тип	Описание
id	string	Возвращает или задает идентификатор.
name	string	Возвращает или задает имя.
properties.privateEndpoint	PrivateEndpoint	Сведения о частной конечной точке.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Состояние подключения службы приватного канала.
properties.provisioningState	string	Состояние подготовки.
systemData	SystemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
type	string	Возвращает или задает тип .

PrivateLinkServiceConnectionState

Состояние подключения службы приватного канала.

Имя	Тип	Описание
actionsRequired	string	Необходимые действия.
description	string	Описание.
status	status	Состояние.

provisioningState

Получает или задает состояние подготовки.

Имя	Тип	Описание
Canceled	string
Creating	string
Deleting	string
Failed	string
Moving	string
SoftDeleted	string
SoftDeleting	string
Succeeded	string
Unknown	string

publicNetworkAccess

Возвращает или задает доступ к общедоступной сети.

Имя	Тип	Описание
Disabled	string
Enabled	string
NotSpecified	string

Sku

Возвращает или задает номер SKU.

Имя	Тип	Описание
capacity	integer	Возвращает или задает емкость SKU.
name	name	Возвращает или задает имя SKU.

status

Состояние.

Имя	Тип	Описание
Approved	string
Disconnected	string
Pending	string
Rejected	string
Unknown	string

SystemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC).
lastModifiedBy	string	Удостоверение, которое последним изменял ресурс.
lastModifiedByType	lastModifiedByType	Тип удостоверения, которое последним изменял ресурс.

TrackedResource.SystemData