Access Policies - List By Environment

服務:

Time Series Insights

API 版本:

2020-05-15

清單 與環境相關聯的所有可用存取原則。

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

URI 參數

名稱	位於	必要	類型	Description
environmentName	path	True	string	與指定之資源群組相關聯的時間序列深入解析環境名稱。
resourceGroupName	path	True	string	Azure 資源群組的名稱。
subscriptionId	path	True	string	Azure 訂用帳戶識別碼。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。

回應

名稱	類型	Description
200 OK	AccessPolicyListResponse	成功傳回存取原則。
Other Status Codes	CloudError	找不到 HTTP 404 () ：找不到訂用帳戶、資源群組或環境。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

AccessPoliciesByEnvironment

範例要求

HTTP

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

Java

/**
 * 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

Go

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

定義

名稱	Description
AccessPolicyListResponse	清單存取原則作業的回應。
AccessPolicyResource	存取原則可用來將環境的存取權授與使用者和應用程式。 角色會指派給 Azure Active Directory 中的服務主體。 這些角色會定義主體可透過時間序列深入解析數據平面 API 執行的動作。
AccessPolicyRole	主體在環境上指派的角色清單。
CloudError	包含 API 錯誤的相關信息。
CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。

AccessPolicyListResponse

Object

清單存取原則作業的回應。

名稱	類型	Description
value	AccessPolicyResource[]	清單存取原則作業的結果。

AccessPolicyResource

Object

存取原則可用來將環境的存取權授與使用者和應用程式。 角色會指派給 Azure Active Directory 中的服務主體。 這些角色會定義主體可透過時間序列深入解析數據平面 API 執行的動作。

名稱	類型	Description
id	string	資源標識碼
name	string	資源名稱
properties.description	string	存取原則的描述。
properties.principalObjectId	string	Azure Active Directory 中主體的 objectId。
properties.roles	AccessPolicyRole[]	主體在環境上指派的角色清單。
type	string	資源類型

AccessPolicyRole

Enumeration

主體在環境上指派的角色清單。

值	Description
Contributor
Reader

CloudError

Object

包含 API 錯誤的相關信息。

名稱	類型	Description
error	CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。

CloudErrorBody

Object

描述具有錯誤碼和訊息的特定 API 錯誤。

名稱	類型	Description
code	string	比起 HTTP 狀態代碼，更精確地描述錯誤狀況的錯誤碼。 可用來以程式設計方式處理特定錯誤案例。
details	CloudErrorBody[]	包含與此錯誤相關的巢狀錯誤。
message	string	描述錯誤的詳細訊息，並提供偵錯資訊。
target	string	例如，錯誤 (中屬性的名稱) 的特定錯誤目標。