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 매개 변수

Name	In(다음 안에)	필수	형식	Description
environmentName	path	True	string	지정된 리소스 그룹과 연결된 Time Series Insights 환경의 이름입니다.
resourceGroupName	path	True	string	Azure 리소스 그룹의 이름입니다.
subscriptionId	path	True	string	Azure 구독 ID입니다.
api-version	query	True	string	클라이언트 요청과 함께 사용할 API의 버전입니다.

응답

Name	형식	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

범위

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

정의

Name	Description
AccessPolicyListResponse	액세스 정책 나열 작업의 응답입니다.
AccessPolicyResource	액세스 정책은 사용자 및 애플리케이션에 환경에 대한 액세스 권한을 부여하는 데 사용됩니다. 역할은 Azure Active Directory의 서비스 주체에 할당됩니다. 이러한 역할은 보안 주체가 Time Series Insights 데이터 평면 API를 통해 수행할 수 있는 작업을 정의합니다.
AccessPolicyRole	보안 주체가 환경에 할당된 역할 목록입니다.
CloudError	API 오류에 대한 정보를 포함합니다.
CloudErrorBody	오류 코드와 메시지가 있는 특정 API 오류를 설명합니다.

AccessPolicyListResponse

Object

액세스 정책 나열 작업의 응답입니다.

Name	형식	Description
value	AccessPolicyResource[]	액세스 정책 나열 작업의 결과입니다.

AccessPolicyResource

Object

액세스 정책은 사용자 및 애플리케이션에 환경에 대한 액세스 권한을 부여하는 데 사용됩니다. 역할은 Azure Active Directory의 서비스 주체에 할당됩니다. 이러한 역할은 보안 주체가 Time Series Insights 데이터 평면 API를 통해 수행할 수 있는 작업을 정의합니다.

Name	형식	Description
id	string	리소스 ID
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 오류에 대한 정보를 포함합니다.

Name	형식	Description
error	CloudErrorBody	오류 코드와 메시지가 있는 특정 API 오류를 설명합니다.

CloudErrorBody

Object

오류 코드와 메시지가 있는 특정 API 오류를 설명합니다.

Name	형식	Description
code	string	HTTP 상태 코드보다 오류 조건을 보다 정확하게 설명하는 오류 코드입니다. 프로그래밍 방식으로 특정 오류 사례를 처리하는 데 사용할 수 있습니다.
details	CloudErrorBody[]	이 오류와 관련된 중첩된 오류를 포함합니다.
message	string	오류를 자세히 설명하고 디버깅 정보를 제공하는 메시지입니다.
target	string	특정 오류의 대상입니다(예: 오류에 있는 속성의 이름).