Billing Role Assignments - List By Enrollment Account

Ссылка

Служба:: Billing

Версия API:: 2024-04-01

Выводит список назначений ролей для вызывающего объекта в учетной записи регистрации. Эта операция поддерживается для учетных записей выставления счетов типа Enterprise Agreement.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleAssignments?api-version=2024-04-01

Параметры URI

Имя В Обязательно Тип Описание

billingAccountName

path

True

string

Идентификатор, который однозначно идентифицирует учетную запись выставления счетов.

Шаблон регулярного выражения: ^([0-9]+|([Pp][Cc][Nn]\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$

enrollmentAccountName

path

True

string

Имя учетной записи регистрации.

Шаблон регулярного выражения: ^[a-zA-Z\d-_]{1,128}$

api-version

query

True

string

Версия API, используемая с клиентским запросом. Текущая версия — 2024-04-01.

Ответы

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

Примеры

BillingRoleAssignmentListByEnrollmentAccount

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

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleAssignments?api-version=2024-04-01


/**
 * Samples for BillingRoleAssignments ListByEnrollmentAccount.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * billingRoleAssignmentListByEnrollmentAccount.json
     */
    /**
     * Sample code: BillingRoleAssignmentListByEnrollmentAccount.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void
        billingRoleAssignmentListByEnrollmentAccount(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingRoleAssignments().listByEnrollmentAccount("6100092", "123456", 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python billing_role_assignment_list_by_enrollment_account.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = BillingManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.billing_role_assignments.list_by_enrollment_account(
        billing_account_name="6100092",
        enrollment_account_name="123456",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByEnrollmentAccount.json
if __name__ == "__main__":
    main()

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

package armbilling_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/billing/armbilling"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c08ac9813477921ad8295b98ced8f82d11b8f913/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByEnrollmentAccount.json
func ExampleRoleAssignmentsClient_NewListByEnrollmentAccountPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbilling.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewRoleAssignmentsClient().NewListByEnrollmentAccountPager("6100092", "123456", nil)
	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.RoleAssignmentListResult = armbilling.RoleAssignmentListResult{
		// 	Value: []*armbilling.RoleAssignment{
		// 		{
		// 			Name: to.Ptr("10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9"),
		// 			Properties: &armbilling.RoleAssignmentProperties{
		// 				CreatedByPrincipalID: to.Ptr("00000000-0000-0000-0000-000000000001"),
		// 				CreatedByPrincipalTenantID: to.Ptr("076915e7-de10-4323-bb34-a58c904068bb"),
		// 				CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-10-19T20:10:50.102Z"); return t}()),
		// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				PrincipalType: to.Ptr(armbilling.PrincipalTypeUser),
		// 				RoleDefinitionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleDefinitions/50000000-0000-0000-0000-000000000000"),
		// 				Scope: to.Ptr("/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47"),
		// 			Properties: &armbilling.RoleAssignmentProperties{
		// 				CreatedByPrincipalID: to.Ptr("00000000-0000-0000-0000-000000000001"),
		// 				CreatedByPrincipalTenantID: to.Ptr("076915e7-de10-4323-bb34-a58c904068bb"),
		// 				CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-10-19T20:10:50.102Z"); return t}()),
		// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				PrincipalType: to.Ptr(armbilling.PrincipalTypeUser),
		// 				RoleDefinitionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleDefinitions/50000000-0000-0000-0000-000000000001"),
		// 				Scope: to.Ptr("/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456"),
		// 			},
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to Lists the role assignments for the caller on a enrollment account. The operation is supported for billing accounts of type Enterprise Agreement.
 *
 * @summary Lists the role assignments for the caller on a enrollment account. The operation is supported for billing accounts of type Enterprise Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByEnrollmentAccount.json
 */
async function billingRoleAssignmentListByEnrollmentAccount() {
  const billingAccountName = "6100092";
  const enrollmentAccountName = "123456";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.billingRoleAssignments.listByEnrollmentAccount(
    billingAccountName,
    enrollmentAccountName,
  )) {
    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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Billing.Models;
using Azure.ResourceManager.Billing;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByEnrollmentAccount.json
// this example is just showing the usage of "BillingRoleAssignments_ListByEnrollmentAccount" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BillingEnrollmentAccountResource created on azure
// for more information of creating BillingEnrollmentAccountResource, please refer to the document of BillingEnrollmentAccountResource
string billingAccountName = "6100092";
string enrollmentAccountName = "123456";
ResourceIdentifier billingEnrollmentAccountResourceId = BillingEnrollmentAccountResource.CreateResourceIdentifier(billingAccountName, enrollmentAccountName);
BillingEnrollmentAccountResource billingEnrollmentAccount = client.GetBillingEnrollmentAccountResource(billingEnrollmentAccountResourceId);

// get the collection of this BillingEnrollmentAccountRoleAssignmentResource
BillingEnrollmentAccountRoleAssignmentCollection collection = billingEnrollmentAccount.GetBillingEnrollmentAccountRoleAssignments();

// invoke the operation and iterate over the result
await foreach (BillingEnrollmentAccountRoleAssignmentResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    BillingRoleAssignmentData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
      "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
      "properties": {
        "createdOn": "2023-10-19T20:10:50.1028398Z",
        "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb",
        "createdByPrincipalId": "00000000-0000-0000-0000-000000000001",
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleDefinitions/50000000-0000-0000-0000-000000000000",
        "scope": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456",
        "principalType": "User"
      },
      "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47",
      "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47",
      "properties": {
        "createdOn": "2023-10-19T20:10:50.1028398Z",
        "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb",
        "createdByPrincipalId": "00000000-0000-0000-0000-000000000001",
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleDefinitions/50000000-0000-0000-0000-000000000001",
        "scope": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456",
        "principalType": "User"
      },
      "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments"
    }
  ]
}

Определения

Имя	Описание
BillingRoleAssignment	Свойства назначения роли выставления счетов.
BillingRoleAssignmentListResult	Контейнер для списка ресурсов
BillingRoleAssignmentProperties	Свойства назначения роли выставления счетов.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
PrincipalType	Тип назначения роли.
ProvisioningState	Состояние подготовки ресурса во время длительной операции.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

BillingRoleAssignment

Свойства назначения роли выставления счетов.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса
properties	BillingRoleAssignmentProperties	Свойства назначения роли выставления счетов.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object	Словарь метаданных, связанных с ресурсом. Он не может быть заполнен для всех типов ресурсов. Максимальная длина ключа и значения, поддерживаемая 256 символами. Ключи или значение не должны пустыми значениями и значениями NULL. Ключи не могут содержать <> % & \ ? /
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

BillingRoleAssignmentListResult

Контейнер для списка ресурсов

Имя	Тип	Описание
nextLink	string	Ссылка (URL-адрес) на следующую страницу результатов.
value	BillingRoleAssignment[]	Список ресурсов.

BillingRoleAssignmentProperties

Свойства назначения роли выставления счетов.

Имя	Тип	Описание
billingAccountDisplayName	string	Имя учетной записи выставления счетов.
billingAccountId	string	Полный идентификатор, который однозначно идентифицирует учетную запись выставления счетов.
billingProfileDisplayName	string	Имя профиля выставления счетов.
billingProfileId	string	Полный идентификатор, который однозначно идентифицирует профиль выставления счетов.
billingRequestId	string	Идентификатор запроса на выставление счетов, созданного для назначения роли. Это применимо только к назначениям ролей клиента или назначениям ролей, созданным с помощью запроса выставления счетов.
createdByPrincipalId	string	Идентификатор объекта пользователя, создавшего назначение роли.
createdByPrincipalPuid	string	Основной PUID пользователя, создавшего назначение роли.
createdByPrincipalTenantId	string	Идентификатор клиента пользователя, создавшего назначение роли.
createdByUserEmailAddress	string	Адрес электронной почты пользователя, создавшего назначение роли. Это поддерживается только для учетных записей выставления счетов с типом соглашения Enterprise.
createdOn	string	Дата создания назначения роли.
customerDisplayName	string	Имя клиента.
customerId	string	Полный идентификатор, который однозначно идентифицирует клиента.
invoiceSectionDisplayName	string	Имя раздела счета.
invoiceSectionId	string	Полный идентификатор, который однозначно идентифицирует раздел счета.
modifiedByPrincipalId	string	Основной PUID пользователя, который изменил назначение роли.
modifiedByPrincipalPuid	string	Основной PUID пользователя, который изменил назначение роли.
modifiedByPrincipalTenantId	string	Идентификатор клиента пользователя, изменившего назначение роли.
modifiedByUserEmailAddress	string	Адрес электронной почты пользователя, изменившего назначение роли. Это поддерживается только для учетных записей выставления счетов с типом соглашения Enterprise.
modifiedOn	string	Дата изменения назначения роли.
principalDisplayName	string	Отображаемое имя субъекта, которому назначена роль.
principalId	string	Идентификатор объекта пользователя, которому была назначена роль.
principalPuid	string	Основной PUID пользователя, которому назначена роль.
principalTenantId	string	Идентификатор основного клиента пользователя, которому назначена роль.
principalTenantName	string	Понятное имя клиента пользователя, которому назначена роль. Это будет "основной клиент" для основного клиента учетной записи выставления счетов.
principalType	PrincipalType	Тип назначения роли.
provisioningState	ProvisioningState	Состояние подготовки ресурса во время длительной операции.
roleDefinitionId	string	Идентификатор определения роли.
scope	string	Область назначения роли.
userAuthenticationType	string	Тип проверки подлинности пользователя( организации или MSA) пользователя, которому назначена роль. Это поддерживается только для учетных записей выставления счетов с типом соглашения Enterprise.
userEmailAddress	string	Адрес электронной почты пользователя, которому назначена роль. Это поддерживается только для учетных записей выставления счетов с типом соглашения Enterprise.

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

PrincipalType

Тип назначения роли.

Имя	Тип	Описание
DirectoryRole	string
Everyone	string
Group	string
None	string
ServicePrincipal	string
Unknown	string
User	string

ProvisioningState

Состояние подготовки ресурса во время длительной операции.

Имя	Тип	Описание
Canceled	string
Failed	string
New	string
Pending	string
Provisioning	string
Succeeded	string

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.