Access Policies - List By Environment

リファレンス

サービス:: Time Series Insights

API バージョン:: 2020-05-15

環境に関連付けられている使用可能なすべてのアクセスポリシーを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


/**
 * Samples for AccessPolicies ListByEnvironment.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/
     * AccessPoliciesListByEnvironment.json
     */
    /**
     * Sample code: AccessPoliciesByEnvironment.
     * 
     * @param manager Entry point to TimeSeriesInsightsManager.
     */
    public static void
        accessPoliciesByEnvironment(com.azure.resourcemanager.timeseriesinsights.TimeSeriesInsightsManager manager) {
        manager.accessPolicies().listByEnvironmentWithResponse("rg1", "env1", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armtimeseriesinsights_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesListByEnvironment.json
func ExampleAccessPoliciesClient_ListByEnvironment() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armtimeseriesinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccessPoliciesClient().ListByEnvironment(ctx, "rg1", "env1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AccessPolicyListResponse = armtimeseriesinsights.AccessPolicyListResponse{
	// 	Value: []*armtimeseriesinsights.AccessPolicyResource{
	// 		{
	// 			Name: to.Ptr("ap1"),
	// 			Type: to.Ptr("Microsoft.TimeSeriesInsights/Environments/AccessPolicies"),
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1"),
	// 			Properties: &armtimeseriesinsights.AccessPolicyResourceProperties{
	// 				Description: to.Ptr("some description"),
	// 				PrincipalObjectID: to.Ptr("aGuid"),
	// 				Roles: []*armtimeseriesinsights.AccessPolicyRole{
	// 					to.Ptr(armtimeseriesinsights.AccessPolicyRoleReader)},
	// 				},
	// 		}},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "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	特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。

次の方法で共有