你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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

Azure Active Directory OAuth2 流。

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	标识类型
UserAssignedIdentity	使用客户端 ID 和主体 ID

Account

帐户资源

名称	类型	默认值	说明
id	string		获取或设置标识符。
identity	Identity		跟踪资源上的标识信息
location	string		获取或设置位置。
name	string		获取或设置名称。
properties.accountStatus	AccountStatus		获取或设置帐户的状态。
properties.cloudConnectors	CloudConnectors		云连接器。用作扫描配置的一部分的外部云标识符。
properties.createdAt	string		获取创建实体的时间。
properties.createdBy	string		获取实体的创建者。
properties.createdByObjectId	string		获取实体的对象 ID 的创建者。
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 中配置为允许使用用于扫描的角色

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	服务主体对象 ID
tenantId	string	租户 ID
type	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