Billing Role Definitions - List By Billing Profile

Servicio:

Billing

Versión de la API:

2020-05-01

Enumera las definiciones de roles de un perfil de facturación. La operación es compatible con las cuentas de facturación con el tipo de contrato Microsoft Partner Agreement o El Contrato de cliente de Microsoft.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions?api-version=2020-05-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
billingAccountName	path	True	string	Identificador que identifica de forma única una cuenta de facturación.
billingProfileName	path	True	string	Identificador que identifica de forma única un perfil de facturación.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente. La versión actual es 2020-05-01.

Respuestas

Nombre	Tipo	Description
200 OK	BillingRoleDefinitionListResult	De acuerdo. La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

BillingProfileRoleDefinitionsList

Solicitud de ejemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions?api-version=2020-05-01

Java

/** Samples for BillingRoleDefinitions ListByBillingProfile. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleDefinitionsList.json
     */
    /**
     * Sample code: BillingProfileRoleDefinitionsList.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void billingProfileRoleDefinitionsList(com.azure.resourcemanager.billing.BillingManager manager) {
        manager
            .billingRoleDefinitions()
            .listByBillingProfile("{billingAccountName}", "{billingProfileName}", 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 billing_profile_role_definitions_list.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_definitions.list_by_billing_profile(
        billing_account_name="{billingAccountName}",
        billing_profile_name="{billingProfileName}",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleDefinitionsList.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/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleDefinitionsList.json
func ExampleRoleDefinitionsClient_NewListByBillingProfilePager() {
	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.NewRoleDefinitionsClient().NewListByBillingProfilePager("{billingAccountName}", "{billingProfileName}", 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.RoleDefinitionListResult = armbilling.RoleDefinitionListResult{
		// 	Value: []*armbilling.RoleDefinition{
		// 		{
		// 			Name: to.Ptr("10000000-aaaa-bbbb-cccc-100000000000"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000"),
		// 			Properties: &armbilling.RoleDefinitionProperties{
		// 				Description: to.Ptr("The Owner role gives the user all permissions including access management rights to the billing profile."),
		// 				Permissions: []*armbilling.PermissionsProperties{
		// 					{
		// 						Actions: []*string{
		// 							to.Ptr("10000000-aaaa-bbbb-cccc-200000000000"),
		// 							to.Ptr("10000000-aaaa-bbbb-cccc-200000000008"),
		// 							to.Ptr("10000000-aaaa-bbbb-cccc-200000000001"),
		// 							to.Ptr("10000000-aaaa-bbbb-cccc-200000000002"),
		// 							to.Ptr("10000000-aaaa-bbbb-cccc-200000000003"),
		// 							to.Ptr("10000000-aaaa-bbbb-cccc-200000000006"),
		// 							to.Ptr("10000000-aaaa-bbbb-cccc-200000000007"),
		// 							to.Ptr("20000000-aaaa-bbbb-cccc-200000000000"),
		// 							to.Ptr("30000000-aaaa-bbbb-cccc-200000000000"),
		// 							to.Ptr("40000000-aaaa-bbbb-cccc-200000000000"),
		// 							to.Ptr("30000000-aaaa-bbbb-cccc-200000000009"),
		// 							to.Ptr("20000000-aaaa-bbbb-cccc-200000000002"),
		// 							to.Ptr("30000000-aaaa-bbbb-cccc-200000000015"),
		// 							to.Ptr("30000000-aaaa-bbbb-cccc-200000000004"),
		// 							to.Ptr("30000000-aaaa-bbbb-cccc-200000000007"),
		// 							to.Ptr("30000000-aaaa-bbbb-cccc-200000000001"),
		// 							to.Ptr("30000000-aaaa-bbbb-cccc-200000000010"),
		// 							to.Ptr("40000000-aaaa-bbbb-cccc-200000000007"),
		// 							to.Ptr("40000000-aaaa-bbbb-cccc-200000000006"),
		// 							to.Ptr("40000000-aaaa-bbbb-cccc-200000000008")},
		// 							NotActions: []*string{
		// 							},
		// 					}},
		// 					RoleName: to.Ptr("Billing profile owner"),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("10000000-aaaa-bbbb-cccc-100000000001"),
		// 				Type: to.Ptr("Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions"),
		// 				ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000001"),
		// 				Properties: &armbilling.RoleDefinitionProperties{
		// 					Description: to.Ptr("The Contributor role give the user all permissions except access management rights to the billing profile."),
		// 					Permissions: []*armbilling.PermissionsProperties{
		// 						{
		// 							Actions: []*string{
		// 								to.Ptr("10000000-aaaa-bbbb-cccc-200000000008"),
		// 								to.Ptr("10000000-aaaa-bbbb-cccc-200000000001"),
		// 								to.Ptr("10000000-aaaa-bbbb-cccc-200000000002"),
		// 								to.Ptr("10000000-aaaa-bbbb-cccc-200000000003"),
		// 								to.Ptr("10000000-aaaa-bbbb-cccc-200000000006"),
		// 								to.Ptr("10000000-aaaa-bbbb-cccc-200000000007"),
		// 								to.Ptr("30000000-aaaa-bbbb-cccc-200000000009"),
		// 								to.Ptr("20000000-aaaa-bbbb-cccc-200000000002"),
		// 								to.Ptr("30000000-aaaa-bbbb-cccc-200000000015"),
		// 								to.Ptr("30000000-aaaa-bbbb-cccc-200000000004"),
		// 								to.Ptr("30000000-aaaa-bbbb-cccc-200000000007"),
		// 								to.Ptr("30000000-aaaa-bbbb-cccc-200000000001"),
		// 								to.Ptr("30000000-aaaa-bbbb-cccc-200000000010"),
		// 								to.Ptr("40000000-aaaa-bbbb-cccc-200000000007"),
		// 								to.Ptr("40000000-aaaa-bbbb-cccc-200000000006"),
		// 								to.Ptr("40000000-aaaa-bbbb-cccc-200000000008")},
		// 								NotActions: []*string{
		// 								},
		// 						}},
		// 						RoleName: to.Ptr("Billing profile contributor"),
		// 					},
		// 			}},
		// 		}
	}
}

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 definitions for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
 *
 * @summary Lists the role definitions for a billing profile. 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/2020-05-01/examples/BillingProfileRoleDefinitionsList.json
 */
async function billingProfileRoleDefinitionsList() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountName = "{billingAccountName}";
  const billingProfileName = "{billingProfileName}";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.billingRoleDefinitions.listByBillingProfile(
    billingAccountName,
    billingProfileName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

billingProfileRoleDefinitionsList().catch(console.error);

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

Respuesta de muestra

status code:

200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000",
      "name": "10000000-aaaa-bbbb-cccc-100000000000",
      "properties": {
        "description": "The Owner role gives the user all permissions including access management rights to the billing profile.",
        "permissions": [
          {
            "actions": [
              "10000000-aaaa-bbbb-cccc-200000000000",
              "10000000-aaaa-bbbb-cccc-200000000008",
              "10000000-aaaa-bbbb-cccc-200000000001",
              "10000000-aaaa-bbbb-cccc-200000000002",
              "10000000-aaaa-bbbb-cccc-200000000003",
              "10000000-aaaa-bbbb-cccc-200000000006",
              "10000000-aaaa-bbbb-cccc-200000000007",
              "20000000-aaaa-bbbb-cccc-200000000000",
              "30000000-aaaa-bbbb-cccc-200000000000",
              "40000000-aaaa-bbbb-cccc-200000000000",
              "30000000-aaaa-bbbb-cccc-200000000009",
              "20000000-aaaa-bbbb-cccc-200000000002",
              "30000000-aaaa-bbbb-cccc-200000000015",
              "30000000-aaaa-bbbb-cccc-200000000004",
              "30000000-aaaa-bbbb-cccc-200000000007",
              "30000000-aaaa-bbbb-cccc-200000000001",
              "30000000-aaaa-bbbb-cccc-200000000010",
              "40000000-aaaa-bbbb-cccc-200000000007",
              "40000000-aaaa-bbbb-cccc-200000000006",
              "40000000-aaaa-bbbb-cccc-200000000008"
            ],
            "notActions": []
          }
        ],
        "roleName": "Billing profile owner"
      },
      "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000001",
      "name": "10000000-aaaa-bbbb-cccc-100000000001",
      "properties": {
        "description": "The Contributor role give the user all permissions except access management rights to the billing profile.",
        "permissions": [
          {
            "actions": [
              "10000000-aaaa-bbbb-cccc-200000000008",
              "10000000-aaaa-bbbb-cccc-200000000001",
              "10000000-aaaa-bbbb-cccc-200000000002",
              "10000000-aaaa-bbbb-cccc-200000000003",
              "10000000-aaaa-bbbb-cccc-200000000006",
              "10000000-aaaa-bbbb-cccc-200000000007",
              "30000000-aaaa-bbbb-cccc-200000000009",
              "20000000-aaaa-bbbb-cccc-200000000002",
              "30000000-aaaa-bbbb-cccc-200000000015",
              "30000000-aaaa-bbbb-cccc-200000000004",
              "30000000-aaaa-bbbb-cccc-200000000007",
              "30000000-aaaa-bbbb-cccc-200000000001",
              "30000000-aaaa-bbbb-cccc-200000000010",
              "40000000-aaaa-bbbb-cccc-200000000007",
              "40000000-aaaa-bbbb-cccc-200000000006",
              "40000000-aaaa-bbbb-cccc-200000000008"
            ],
            "notActions": []
          }
        ],
        "roleName": "Billing profile contributor"
      },
      "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions"
    }
  ]
}

Definiciones

Nombre	Description
BillingPermissionsProperties	Conjunto de acciones permitidas y acciones no permitidas que un autor de llamada tiene en una cuenta de facturación
BillingRoleDefinition	Propiedades de una definición de roles.
BillingRoleDefinitionListResult	Lista de definiciones de roles.
ErrorDetails	Detalles del error.
ErrorResponse	La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.
ErrorSubDetails

BillingPermissionsProperties

Object

Conjunto de acciones permitidas y acciones no permitidas que un autor de llamada tiene en una cuenta de facturación

Nombre	Tipo	Description
actions	string[]	Conjunto de acciones que el autor de la llamada puede realizar.
notActions	string[]	Conjunto de acciones que el autor de la llamada no puede realizar.

BillingRoleDefinition

Object

Propiedades de una definición de roles.

Nombre	Tipo	Description
id	string	Identificador de recurso.
name	string	Nombre del recurso.
properties.description	string	Descripción del rol
properties.permissions	BillingPermissionsProperties[]	BillingPermissions el rol tiene
properties.roleName	string	Nombre del rol
type	string	Tipo de recurso.

BillingRoleDefinitionListResult

Object

Lista de definiciones de roles.

Nombre	Tipo	Description
nextLink	string	Vínculo (url) a la página siguiente de resultados.
value	BillingRoleDefinition[]	Definiciones de roles.

ErrorDetails

Object

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
details	ErrorSubDetails[]	Los detalles secundarios del error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.
target	string	Destino del error concreto.

ErrorResponse

Object

La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error.

ErrorSubDetails

Object

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.
target	string	Destino del error concreto.