Compartilhar via


Billing Role Assignments - Create By Invoice Section

Adiciona uma atribuição de função em uma seção de fatura. A operação tem suporte para contas de cobrança com o tipo de contrato Microsoft Customer Agreement.

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

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}$

invoiceSectionName
path True

string

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

Corpo da solicitação

Nome Obrigatório Tipo Description
roleDefinitionId True

string

A ID da definição de função.

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.

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.

Respostas

Nome Tipo Description
200 OK

BillingRoleAssignment

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

202 Accepted

As propriedades da atribuição 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

BillingRoleAssignmentCreateByInvoiceSection

Solicitação de exemplo

POST 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/createBillingRoleAssignment?api-version=2024-04-01

{
  "principalId": "00000000-0000-0000-0000-000000000000",
  "principalTenantId": "076915e7-de10-4323-bb34-a58c904068bb",
  "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/10000000-aaaa-bbbb-cccc-100000000000",
  "userEmailAddress": "john@contoso.com"
}

Resposta de exemplo

{
  "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_00000000-0000-0000-0000-000000000000",
  "name": "10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000",
  "properties": {
    "createdOn": "2023-10-19T20:10:50.1028398Z",
    "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb",
    "createdByPrincipalId": "47309529-17e6-4104-b9e8-39f62fa1e5ed",
    "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/10000000-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"
}
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/invoiceSections/xxxx-xxxx-xxx-xxx/operationResults/createBillingRoleAssignment_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.

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"

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.