Billing Role Assignments - Get By Invoice Section

Referência

Serviço:: Billing

Versão da API:: 2024-04-01

Obtém uma atribuição de função para o chamador em uma seção de fatura. A operação é suportada para contas de cobrança com contrato tipo Microsoft Customer Agreement.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments/{billingRoleAssignmentName}?api-version=2024-04-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
billingAccountName	path	True	string	O 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	O ID que identifica exclusivamente um perfil de faturamento. Padrão Regex: `^[a-zA-Z\d-_]{1,128}$`
billingRoleAssignmentName	path	True	string	A ID que identifica exclusivamente uma atribuição de função. Padrão Regex: `^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$`
invoiceSectionName	path	True	string	O ID que identifica exclusivamente uma seção de fatura. 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.

Respostas

Name	Tipo	Description
200 OK	BillingRoleAssignment	As propriedades da atribuição de função de cobrança.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Exemplos

BillingRoleAssignmentGetByInvoiceSection

Pedido de amostra

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9?api-version=2024-04-01


/**
 * Samples for BillingRoleAssignments GetByInvoiceSection.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * billingRoleAssignmentGetByInvoiceSection.json
     */
    /**
     * Sample code: BillingRoleAssignmentGetByInvoiceSection.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void
        billingRoleAssignmentGetByInvoiceSection(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingRoleAssignments().getByInvoiceSectionWithResponse(
            "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", "BKM6-54VH-BG7-PGB",
            "xxxx-xxxx-xxx-xxx", "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
            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_get_by_invoice_section.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.get_by_invoice_section(
        billing_account_name="00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30",
        billing_profile_name="BKM6-54VH-BG7-PGB",
        invoice_section_name="xxxx-xxxx-xxx-xxx",
        billing_role_assignment_name="10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByInvoiceSection.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/billingRoleAssignmentGetByInvoiceSection.json
func ExampleRoleAssignmentsClient_GetByInvoiceSection() {
	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)
	}
	res, err := clientFactory.NewRoleAssignmentsClient().GetByInvoiceSection(ctx, "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", "BKM6-54VH-BG7-PGB", "xxxx-xxxx-xxx-xxx", "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", 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.RoleAssignment = armbilling.RoleAssignment{
	// 	Name: to.Ptr("10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9"),
	// 	Type: to.Ptr("Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments"),
	// 	ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9"),
	// 	Properties: &armbilling.RoleAssignmentProperties{
	// 		CreatedByPrincipalID: to.Ptr("46b831ec-42b2-4f1a-8b54-3fd5ff9d6aa1"),
	// 		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/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000"),
	// 		Scope: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/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

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

/**
 * This sample demonstrates how to Gets a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
 *
 * @summary Gets a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByInvoiceSection.json
 */
async function billingRoleAssignmentGetByInvoiceSection() {
  const billingAccountName =
    "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30";
  const billingProfileName = "BKM6-54VH-BG7-PGB";
  const invoiceSectionName = "xxxx-xxxx-xxx-xxx";
  const billingRoleAssignmentName =
    "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.billingRoleAssignments.getByInvoiceSection(
    billingAccountName,
    billingProfileName,
    invoiceSectionName,
    billingRoleAssignmentName,
  );
  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

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

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByInvoiceSection.json
// this example is just showing the usage of "BillingRoleAssignments_GetByInvoiceSection" 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 BillingInvoiceSectionResource created on azure
// for more information of creating BillingInvoiceSectionResource, please refer to the document of BillingInvoiceSectionResource
string billingAccountName = "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30";
string billingProfileName = "BKM6-54VH-BG7-PGB";
string invoiceSectionName = "xxxx-xxxx-xxx-xxx";
ResourceIdentifier billingInvoiceSectionResourceId = BillingInvoiceSectionResource.CreateResourceIdentifier(billingAccountName, billingProfileName, invoiceSectionName);
BillingInvoiceSectionResource billingInvoiceSection = client.GetBillingInvoiceSectionResource(billingInvoiceSectionResourceId);

// get the collection of this BillingInvoiceSectionRoleAssignmentResource
BillingInvoiceSectionRoleAssignmentCollection collection = billingInvoiceSection.GetBillingInvoiceSectionRoleAssignments();

// invoke the operation
string billingRoleAssignmentName = "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9";
NullableResponse<BillingInvoiceSectionRoleAssignmentResource> response = await collection.GetIfExistsAsync(billingRoleAssignmentName);
BillingInvoiceSectionRoleAssignmentResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Resposta da amostra

Código de estado:: 200

{
  "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/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": "46b831ec-42b2-4f1a-8b54-3fd5ff9d6aa1",
    "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/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000",
    "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx",
    "principalType": "User"
  },
  "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments"
}

Definições

Name	Description
BillingRoleAssignment	As propriedades da atribuição de função de cobrança.
BillingRoleAssignmentProperties	As propriedades da atribuição de função de cobrança.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
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 longa duração.
systemData	Metadados referentes à criação e última modificação do recurso.

BillingRoleAssignment

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

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado 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 contendo 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 suportado 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"

BillingRoleAssignmentProperties

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

Name	Tipo	Description
billingAccountDisplayName	string	O nome da conta de cobrança.
billingAccountId	string	O ID totalmente qualificado que identifica exclusivamente uma conta de cobrança.
billingProfileDisplayName	string	O nome do perfil de cobrança.
billingProfileId	string	O ID totalmente qualificado que identifica exclusivamente um perfil de faturamento.
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	O 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 e-mail do usuário que criou a atribuição de função. Isso é suportado apenas para contas de cobrança com 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	O ID totalmente qualificado que identifica exclusivamente um cliente.
invoiceSectionDisplayName	string	O nome da seção da fatura.
invoiceSectionId	string	O ID totalmente qualificado que identifica exclusivamente uma seção de fatura.
modifiedByPrincipalId	string	O PUID principal do usuário que modificou a atribuição de função.
modifiedByPrincipalPuid	string	O 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 e-mail do usuário que modificou a atribuição de função. Isso é suportado apenas para contas de cobrança com tipo de contrato Enterprise Agreement.
modifiedOn	string	A data em que a atribuição de função foi modificada.
principalDisplayName	string	O nome para exibição do principal ao qual a função foi atribuída.
principalId	string	A id do objeto do usuário ao qual a função foi atribuída.
principalPuid	string	O 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. Este será o "Inquilino principal" para o inquilino principal da conta de faturação.
principalType	PrincipalType	O tipo de uma atribuição de função.
provisioningState	ProvisioningState	O estado de provisionamento do recurso durante uma operação de longa duração.
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 é suportado apenas para contas de cobrança com tipo de contrato Enterprise Agreement.
userEmailAddress	string	O endereço de e-mail do usuário ao qual a função foi atribuída. Isso é suportado apenas para contas de cobrança com tipo de contrato Enterprise Agreement.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

PrincipalType

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

Name	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 longa duração.

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

systemData

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

Name	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.