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

Имя	В	Обязательно	Тип	Описание
environmentName	path	True	string	Имя среды Аналитики временных рядов, связанной с указанной группой ресурсов.
resourceGroupName	path	True	string	Имя группы ресурсов Azure.
subscriptionId	path	True	string	Идентификатор подписки Azure.
api-version	query	True	string	Версия API для использования с клиентским запросом.

Ответы

Имя	Тип	Описание
200 OK	AccessPolicyListResponse	политики доступа успешно возвращены.
Other Status Codes	CloudError	HTTP 404 (не найдено). Не удалось найти подписку, группу ресурсов или среду.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
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. Эти роли определяют действия, которые субъект может выполнять с помощью API плоскости данных Аналитики временных рядов.
AccessPolicyRole	Список ролей, назначенных субъекту в среде.
CloudError	Содержит сведения об ошибке API.
CloudErrorBody	Описывает конкретную ошибку API с кодом ошибки и сообщением.

AccessPolicyListResponse

Ответ операции списка политик доступа.

Имя	Тип	Описание
value	AccessPolicyResource[]	Результат операции списка политик доступа.

AccessPolicyResource

Политика доступа используется для предоставления пользователям и приложениям доступа к среде. Роли назначаются субъектам-службам в Azure Active Directory. Эти роли определяют действия, которые субъект может выполнять с помощью API плоскости данных Аналитики временных рядов.

Имя	Тип	Описание
id	string	Идентификатор ресурса
name	string	Имя ресурса
properties.description	string	Описание политики доступа.
properties.principalObjectId	string	ObjectId субъекта в Azure Active Directory.
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	Целевой объект конкретной ошибки (например, имя свойства в ошибке).

Поделиться через