Billing Role Assignments - Resolve By Billing Profile

Serviço:

Billing

Versão da API:

2024-04-01

Lista as atribuições de função para o chamador em um perfil de cobrança ao buscar informações do usuário para cada atribuição de função. A operação tem suporte para contas de cobrança com o tipo de contrato Microsoft Partner Agreement ou Contrato de Cliente da Microsoft.

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/resolveBillingRoleAssignments?api-version=2024-04-01

Com parâmetros opcionais:

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/resolveBillingRoleAssignments?resolveScopeDisplayNames={resolveScopeDisplayNames}&api-version=2024-04-01&filter={filter}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
billingAccountName	path	True	string	A ID que identifica exclusivamente uma conta de cobrança. Padrão Regex: ^([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})?)$
billingProfileName	path	True	string	A ID que identifica exclusivamente um perfil de cobrança. Padrão Regex: ^[a-zA-Z\d-_]{1,128}$
api-version	query	True	string	A versão da API a ser usada com a solicitação do cliente. A versão atual é 2024-04-01.
filter	query		string	A opção de consulta de filtro permite que os clientes filtrem uma coleção de recursos que são endereçados por uma URL de solicitação.
resolveScopeDisplayNames	query		boolean	Resolve o nome de exibição do escopo para cada uma das atribuições de função.

Respostas

Nome	Tipo	Description
200 OK	BillingRoleAssignmentListResult	A lista das atribuições de função de cobrança.
202 Accepted		A lista das atribuições de função de cobrança. Cabeçalhos Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Exemplos

ResolveBillingRoleAssignmentByBillingProfile

Solicitação de exemplo

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/resolveBillingRoleAssignments?api-version=2024-04-01

Java

/**
 * Samples for BillingRoleAssignments ResolveByBillingProfile.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * resolveBillingRoleAssignmentByBillingProfile.json
     */
    /**
     * Sample code: ResolveBillingRoleAssignmentByBillingProfile.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void
        resolveBillingRoleAssignmentByBillingProfile(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingRoleAssignments().resolveByBillingProfile(
            "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", "xxxx-xxxx-xxx-xxx",
            null, null, 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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python resolve_billing_role_assignment_by_billing_profile.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.begin_resolve_by_billing_profile(
        billing_account_name="00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30",
        billing_profile_name="xxxx-xxxx-xxx-xxx",
    ).result()
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByBillingProfile.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

Go

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/resolveBillingRoleAssignmentByBillingProfile.json
func ExampleRoleAssignmentsClient_BeginResolveByBillingProfile() {
	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)
	}
	poller, err := clientFactory.NewRoleAssignmentsClient().BeginResolveByBillingProfile(ctx, "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", "xxxx-xxxx-xxx-xxx", &armbilling.RoleAssignmentsClientBeginResolveByBillingProfileOptions{ResolveScopeDisplayNames: nil,
		Filter: nil,
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.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/billingProfiles/billingRoleAssignments"),
	// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/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/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000000"),
	// 				Scope: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47"),
	// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments"),
	// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/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/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000001"),
	// 				Scope: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx"),
	// 			},
	// 	}},
	// }
}

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 { BillingManagementClient } = require("@azure/arm-billing");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists the role assignments for the caller on an billing profile while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
 *
 * @summary Lists the role assignments for the caller on an billing profile while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByBillingProfile.json
 */
async function resolveBillingRoleAssignmentByBillingProfile() {
  const billingAccountName =
    "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30";
  const billingProfileName = "xxxx-xxxx-xxx-xxx";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.billingRoleAssignments.beginResolveByBillingProfileAndWait(
    billingAccountName,
    billingProfileName,
  );
  console.log(result);
}

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

dotnet

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/resolveBillingRoleAssignmentByBillingProfile.json
// this example is just showing the usage of "BillingRoleAssignments_ResolveByBillingProfile" 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 BillingProfileResource created on azure
// for more information of creating BillingProfileResource, please refer to the document of BillingProfileResource
string billingAccountName = "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30";
string billingProfileName = "xxxx-xxxx-xxx-xxx";
ResourceIdentifier billingProfileResourceId = BillingProfileResource.CreateResourceIdentifier(billingAccountName, billingProfileName);
BillingProfileResource billingProfile = client.GetBillingProfileResource(billingProfileResourceId);

// invoke the operation
ArmOperation<BillingRoleAssignmentListResult> lro = await billingProfile.ResolveByBillingProfileBillingRoleAssignmentAsync(WaitUntil.Completed);
BillingRoleAssignmentListResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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

Resposta de exemplo

Código de status:

200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/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/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000000",
        "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx",
        "principalType": "User"
      },
      "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/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/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000001",
        "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx",
        "principalType": "User"
      },
      "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments"
    }
  ]
}

Código de status:

202

location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/operationResults/resolveBillingRoleAssignments_10000000-0000-0000-0000-000000000001?api-version=2024-04-01
retry-after: 5

Definições

Nome	Description
BillingRoleAssignment	As propriedades da atribuição de função de cobrança.
BillingRoleAssignmentListResult	Um contêiner para uma lista de recursos
BillingRoleAssignmentProperties	As propriedades da atribuição de função de cobrança.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
PrincipalType	O tipo de uma atribuição de função.
ProvisioningState	O estado de provisionamento do recurso durante uma operação de execução prolongada.
systemData	Metadados relativos à criação e última modificação do recurso.

BillingRoleAssignment

As propriedades da atribuição de função de cobrança.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties	BillingRoleAssignmentProperties	As propriedades da atribuição de função de cobrança.
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags	object	Dicionário de metadados associados ao recurso. Ele pode não ser preenchido para todos os tipos de recursos. Comprimento máximo de chave/valor com suporte de 256 caracteres. Chaves/valor não devem esvaziar valor nem nulo. As chaves não podem conter <> % & \ ? /
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

BillingRoleAssignmentListResult

Um contêiner para uma lista de recursos

Nome	Tipo	Description
nextLink	string	O link (url) para a próxima página de resultados.
value	BillingRoleAssignment[]	A lista de recursos.

BillingRoleAssignmentProperties

As propriedades da atribuição de função de cobrança.

Nome	Tipo	Description
billingAccountDisplayName	string	O nome da conta de cobrança.
billingAccountId	string	A ID totalmente qualificada que identifica exclusivamente uma conta de cobrança.
billingProfileDisplayName	string	O nome do perfil de cobrança.
billingProfileId	string	A ID totalmente qualificada que identifica exclusivamente um perfil de cobrança.
billingRequestId	string	A ID da solicitação de cobrança que foi criada para a atribuição de função. Isso só é aplicável a atribuições de função entre locatários ou atribuições de função criadas por meio da solicitação de cobrança.
createdByPrincipalId	string	A ID do objeto do usuário que criou a atribuição de função.
createdByPrincipalPuid	string	A PUID principal do usuário que criou a atribuição de função.
createdByPrincipalTenantId	string	A ID do locatário do usuário que criou a atribuição de função.
createdByUserEmailAddress	string	O endereço de email do usuário que criou a atribuição de função. Isso tem suporte apenas para contas de cobrança com o tipo de contrato Enterprise Agreement.
createdOn	string	A data em que a atribuição de função foi criada.
customerDisplayName	string	O nome do cliente.
customerId	string	A ID totalmente qualificada que identifica exclusivamente um cliente.
invoiceSectionDisplayName	string	O nome da seção da fatura.
invoiceSectionId	string	A ID totalmente qualificada que identifica exclusivamente uma seção de fatura.
modifiedByPrincipalId	string	A PUID principal do usuário que modificou a atribuição de função.
modifiedByPrincipalPuid	string	A PUID principal do usuário que modificou a atribuição de função.
modifiedByPrincipalTenantId	string	A ID do locatário do usuário que modificou a atribuição de função.
modifiedByUserEmailAddress	string	O endereço de email do usuário que modificou a atribuição de função. Isso tem suporte apenas para contas de cobrança com o tipo de contrato Enterprise Agreement.
modifiedOn	string	A data em que a atribuição de função foi modificada.
principalDisplayName	string	O nome de exibição da entidade de segurança a quem a função foi atribuída.
principalId	string	A ID do objeto do usuário a quem a função foi atribuída.
principalPuid	string	A PUID principal do usuário ao qual a função foi atribuída.
principalTenantId	string	A ID do locatário principal do usuário ao qual a função foi atribuída.
principalTenantName	string	O nome amigável do locatário do usuário ao qual a função foi atribuída. Esse será o "Locatário Primário" para o locatário primário da conta de cobrança.
principalType	PrincipalType	O tipo de uma atribuição de função.
provisioningState	ProvisioningState	O estado de provisionamento do recurso durante uma operação de execução prolongada.
roleDefinitionId	string	A ID da definição de função.
scope	string	O escopo no qual a função foi atribuída.
userAuthenticationType	string	O tipo de autenticação do usuário, seja Organização ou MSA, do usuário ao qual a função foi atribuída. Isso tem suporte apenas para contas de cobrança com o tipo de contrato Enterprise Agreement.
userEmailAddress	string	O endereço de email do usuário ao qual a função foi atribuída. Isso tem suporte apenas para contas de cobrança com o tipo de contrato Enterprise Agreement.

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

PrincipalType

O tipo de uma atribuição de função.

Nome	Tipo	Description
DirectoryRole	string
Everyone	string
Group	string
None	string
ServicePrincipal	string
Unknown	string
User	string

ProvisioningState

O estado de provisionamento do recurso durante uma operação de execução prolongada.

Nome	Tipo	Description
Canceled	string
Failed	string
New	string
Pending	string
Provisioning	string
Succeeded	string

systemData

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.