Eligible Child Resources - Get

Служба:

Authorization

Версия API:

2020-10-01

Получение дочерних ресурсов ресурса, к которому у пользователя есть соответствующий доступ

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/eligibleChildResources?api-version=2020-10-01

С использованием необязательных параметров:

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/eligibleChildResources?$filter={$filter}&api-version=2020-10-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
scope	path	True	string	Область политики управления ролями.
api-version	query	True	string	Версия API, используемая для данной операции.
$filter	query		string	Фильтр, применяемый к операции. Используйте $filter=resourceType+eq+'Subscription', чтобы отфильтровать только ресурс типа "Подписка". Используйте $filter=resourceType+eq+'subscription'+or+resourceType+eq+'resourcegroup' для фильтрации по ресурсу типа = "Подписка" или "Группа ресурсов".

Ответы

Имя	Тип	Описание
200 OK	EligibleChildResourcesListResult	ОК — возвращает сведения о политике управления ролями.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

GetEligibleChildResourcesByScope

Образец запроса

HTTP

GET https://management.azure.com/providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/eligibleChildResources?$filter=resourceType+eq+'resourcegroup'&api-version=2020-10-01

Java

/**
 * Samples for EligibleChildResources Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/
     * GetEligibleChildResourcesByScope.json
     */
    /**
     * Sample code: GetEligibleChildResourcesByScope.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getEligibleChildResourcesByScope(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.accessManagement().roleAssignments().manager().roleServiceClient().getEligibleChildResources().get(
            "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f",
            "resourceType eq 'resourcegroup'", 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 armauthorization_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/53b1affe357b3bfbb53721d0a2002382a046d3b0/specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/GetEligibleChildResourcesByScope.json
func ExampleEligibleChildResourcesClient_NewGetPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armauthorization.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewEligibleChildResourcesClient().NewGetPager("providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", &armauthorization.EligibleChildResourcesClientGetOptions{Filter: to.Ptr("resourceType+eq+'resourcegroup'")})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.EligibleChildResourcesListResult = armauthorization.EligibleChildResourcesListResult{
		// 	Value: []*armauthorization.EligibleChildResource{
		// 		{
		// 			Name: to.Ptr("RG-1"),
		// 			Type: to.Ptr("resourcegroup"),
		// 			ID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/resourceGroups/RG-1"),
		// 		},
		// 		{
		// 			Name: to.Ptr("RG-2"),
		// 			Type: to.Ptr("resourcegroup"),
		// 			ID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/resourceGroups/RG-2"),
		// 	}},
		// }
	}
}

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

JavaScript

const { AuthorizationManagementClient } = require("@azure/arm-authorization");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get the child resources of a resource on which user has eligible access
 *
 * @summary Get the child resources of a resource on which user has eligible access
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/GetEligibleChildResourcesByScope.json
 */
async function getEligibleChildResourcesByScope() {
  const subscriptionId =
    process.env["AUTHORIZATION_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const scope =
    "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f";
  const filter = "resourceType+eq+'resourcegroup'";
  const options = { filter };
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.eligibleChildResources.list(scope, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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": [
    {
      "name": "RG-1",
      "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/resourceGroups/RG-1",
      "type": "resourcegroup"
    },
    {
      "name": "RG-2",
      "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/resourceGroups/RG-2",
      "type": "resourcegroup"
    }
  ]
}

Определения

Имя	Описание
CloudError	Ответ об ошибке от службы.
CloudErrorBody	Ответ об ошибке от службы.
EligibleChildResource	Подходящий дочерний ресурс
EligibleChildResourcesListResult	Допустимый результат операции списка дочерних ресурсов.

CloudError

Ответ об ошибке от службы.

Имя	Тип	Описание
error	CloudErrorBody	Ответ об ошибке от службы.

CloudErrorBody

Ответ об ошибке от службы.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.

EligibleChildResource

Подходящий дочерний ресурс

Имя	Тип	Описание
id	string	Идентификатор область ресурса.
name	string	Имя ресурса.
type	string	Тип ресурса.

EligibleChildResourcesListResult

Допустимый результат операции списка дочерних ресурсов.

Имя	Тип	Описание
nextLink	string	URL-адрес, используемый для получения следующего набора результатов.
value	EligibleChildResource[]	Список допустимых дочерних ресурсов.