Access Policies - List By Environment

環境に関連付けられている使用可能なすべてのアクセス ポリシーをListsします。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/accessPolicies?api-version=2020-05-15

URI パラメーター

名前 / 必須 説明
environmentName
path True

string

指定したリソース グループに関連付けられている Time Series Insights 環境の名前。

resourceGroupName
path True

string

Azure リソース グループの名前。

subscriptionId
path True

string

Azure サブスクリプション ID。

api-version
query True

string

クライアント要求で使用される API のバージョン。

応答

名前 説明
200 OK

AccessPolicyListResponse

アクセス ポリシーが正常に返されました。

Other Status Codes

CloudError

HTTP 404 (見つかりません): サブスクリプション、リソース グループ、または環境が見つかりませんでした。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

AccessPoliciesByEnvironment

要求のサンプル

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/environments/env1/accessPolicies?api-version=2020-05-15

応答のサンプル

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1",
      "name": "ap1",
      "type": "Microsoft.TimeSeriesInsights/Environments/AccessPolicies",
      "properties": {
        "principalObjectId": "aGuid",
        "roles": [
          "Reader"
        ],
        "description": "some description"
      }
    }
  ]
}

定義

名前 説明
AccessPolicyListResponse

アクセス ポリシーの一覧表示操作の応答。

AccessPolicyResource

アクセス ポリシーは、ユーザーとアプリケーションに環境へのアクセスを許可するために使用されます。 ロールは、Azure Active Directory のサービス プリンシパルに割り当てられます。 これらのロールは、プリンシパルが Time Series Insights データ プレーン API を介して実行できるアクションを定義します。

AccessPolicyRole

プリンシパルが環境に割り当てられているロールの一覧。

CloudError

API エラーに関する情報が含まれます。

CloudErrorBody

エラー コードとメッセージを含む特定の API エラーについて説明します。

AccessPolicyListResponse

アクセス ポリシーの一覧表示操作の応答。

名前 説明
value

AccessPolicyResource[]

アクセス ポリシーの一覧表示操作の結果。

AccessPolicyResource

アクセス ポリシーは、ユーザーとアプリケーションに環境へのアクセスを許可するために使用されます。 ロールは、Azure Active Directory のサービス プリンシパルに割り当てられます。 これらのロールは、プリンシパルが Time Series Insights データ プレーン API を介して実行できるアクションを定義します。

名前 説明
id

string

リソース ID

name

string

リソース名

properties.description

string

アクセス ポリシーの説明。

properties.principalObjectId

string

Azure Active Directory のプリンシパルの objectId。

properties.roles

AccessPolicyRole[]

プリンシパルが環境に割り当てられているロールの一覧。

type

string

リソースの種類

AccessPolicyRole

プリンシパルが環境に割り当てられているロールの一覧。

名前 説明
Contributor

string

Reader

string

CloudError

API エラーに関する情報が含まれます。

名前 説明
error

CloudErrorBody

エラー コードとメッセージを含む特定の API エラーについて説明します。

CloudErrorBody

エラー コードとメッセージを含む特定の API エラーについて説明します。

名前 説明
code

string

エラー状態を HTTP 状態コードよりも正確に記述するエラー コード。 特定のエラー ケースをプログラムで処理するために使用できます。

details

CloudErrorBody[]

このエラーに関連する入れ子になったエラーが含まれています。

message

string

エラーを詳細に説明し、デバッグ情報を提供するメッセージ。

target

string

特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。