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	Success
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	リソースを作成した ID の種類。
Endpoints	アカウントのパブリックエンドポイントである URI。
Error	エラーを取得または設定します。
ErrorDetails	アカウントエラーの詳細を取得します。
ErrorModel	既定のエラーモデル
ErrorResponseModel	既定のエラー応答モデル
Identity	リソースのマネージド ID
lastModifiedByType	リソースを最後に変更した ID の種類。
managedEventHubState	マネージド eventhub の状態を取得または設定します。有効なマネージド eventhub が作成される場合、無効にした場合、マネージド eventhub は削除されます。
ManagedResources	マネージドリソースのリソース識別子を取得します。
managedResourcesPublicNetworkAccess	マネージドリソースのパブリックネットワークアクセスを取得または設定します。
name	SKU 名を取得または設定します。
PrivateEndpoint	プライベートエンドポイントクラス。
PrivateEndpointConnection	プライベートエンドポイント接続クラス。
PrivateLinkServiceConnectionState	プライベートリンクサービスの接続状態。
provisioningState	プロビジョニングの状態を取得または設定します。
publicNetworkAccess	パブリックネットワークアクセスを取得または設定します。
Sku	Sku を取得または設定します。
status	ステータス。
SystemData	リソースの作成と最後の変更に関連するメタデータ。
TrackedResource.SystemData	リソースの作成と最後の変更に関連するメタデータ。
type	Identity Type
UserAssignedIdentity	クライアント ID とプリンシパル ID を使用します

Account

アカウントリソース

名前	型	既定値	説明
id	string		識別子を取得または設定します。
identity	Identity		追跡対象リソースの ID 情報
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	マネージド eventhub の状態を取得または設定します。有効なマネージド eventhub が作成される場合、無効にした場合、マネージド eventhub は削除されます。
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 外部識別子。スキャンに使用されるロール arn の使用を許可するように AWS で構成

createdByType

リソースを作成した ID の種類。

名前	型	説明
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

リソースのマネージド ID

名前	型	説明
principalId	string	サービスプリンシパルオブジェクト ID
tenantId	string	テナント ID
type	type	Identity Type
userAssignedIdentities	<string, UserAssignedIdentity>	ユーザー割り当て ID

lastModifiedByType

リソースを最後に変更した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

managedEventHubState

マネージド eventhub の状態を取得または設定します。有効なマネージド eventhub が作成される場合、無効にした場合、マネージド eventhub は削除されます。

名前	型	説明
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	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最後の変更のタイムスタンプ (UTC)。
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	lastModifiedByType	リソースを最後に変更した ID の種類。

TrackedResource.SystemData