Transfers - List

Serviço:

Billing

Versão da API:

2024-04-01

Lista as solicitações de transferência para uma seção de fatura. A operação é suportada apenas 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}/transfers?api-version=2024-04-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
billingAccountName	path	True	string pattern: ^([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})?)$	O ID que identifica exclusivamente uma conta de cobrança.
billingProfileName	path	True	string pattern: ^[a-zA-Z\d-_]{1,128}$	O ID que identifica exclusivamente um perfil de faturamento.
invoiceSectionName	path	True	string pattern: ^[a-zA-Z\d-_]{1,128}$	O ID que identifica exclusivamente uma seção de fatura.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	TransferDetailsListResult	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

TransfersList

Pedido de amostra

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers?api-version=2024-04-01

Resposta da amostra

Código de estado:

200

{
  "value": [
    {
      "name": "aabb123",
      "type": "Microsoft.Billing/transfers",
      "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123",
      "properties": {
        "detailedTransferStatus": [
          {
            "productId": "subscriptionId",
            "productName": "Azure subscription 1",
            "productType": "AzureSubscription",
            "skuDescription": "MS-AZR-0017G",
            "transferStatus": "InProgress"
          },
          {
            "productId": "reservedInstanceId",
            "productName": "Reservation name",
            "productType": "AzureReservation",
            "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y",
            "transferStatus": "InProgress"
          }
        ],
        "expirationTime": "2018-11-05T17:32:28Z",
        "initiatorEmailId": "xyz@contoso.com",
        "recipientEmailId": "user@contoso.com",
        "transferStatus": "InProgress"
      }
    }
  ]
}

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
DetailedTransferStatus	Status detalhado da transferência.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ProductTransferStatus	O estado de uma transferência.
ProductType	O tipo de produto que é transferido.
systemData	Metadados referentes à criação e última modificação do recurso.
TransferDetails	Detalhes da transferência.
TransferDetailsListResult	Coleção paginada de itens TransferDetails
TransferError	Detalhes do erro para execução da transferência.
TransferStatus	O estado de uma transferência.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DetailedTransferStatus

Object

Status detalhado da transferência.

Name	Tipo	Description
errorDetails	TransferError	Detalhes do erro para execução da transferência.
productId	string	A ID do produto que é transferido.
productName	string	O nome do produto que é transferido.
productType	ProductType	Tipo de produto que é transferido.
skuDescription	string	O SKU do produto que é transferido.
transferStatus	ProductTransferStatus	Estado da transferência.

ErrorAdditionalInfo

Object

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

Object

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

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ProductTransferStatus

Enumeração

O estado de uma transferência.

Valor	Description
NotStarted	Não Iniciado
InProgress	Em curso
Completed	Concluído
Failed	Falha

ProductType

Enumeração

O tipo de produto que é transferido.

Valor	Description
AzureSubscription	AzureSubscription
AzureReservation	AzureReservation
Department	Departamento
SavingsPlan	Poupança-Plano
SAAS	SaaS

systemData

Object

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

Name	Tipo	Description
createdAt	string (date-time)	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 (date-time)	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.

TransferDetails

Object

Detalhes da transferência.

Name	Tipo	Description
id	string (arm-id)	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.canceledBy	string	O ID de e-mail do usuário que cancelou a solicitação de transferência.
properties.detailedTransferStatus	DetailedTransferStatus[]	Status detalhado da transferência.
properties.expirationTime	string (date-time)	O momento em que o pedido de transferência expira.
properties.initiatorEmailId	string	O ID de e-mail do usuário que enviou a solicitação de transferência.
properties.recipientEmailId	string	O ID de e-mail do usuário para quem a solicitação de transferência foi enviada.
properties.transferStatus	TransferStatus	Status geral da transferência.
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"

TransferDetailsListResult

Object

Coleção paginada de itens TransferDetails

Name	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	TransferDetails[]	Os itens TransferDetails nesta página

TransferError

Object

Detalhes do erro para execução da transferência.

Name	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro.

TransferStatus

Enumeração

O estado de uma transferência.

Valor	Description
Expired	Fora do prazo
Pending	Pendente
InProgress	Em curso
Completed	Concluído
CompletedWithErrors	CompletedWithErrors
Failed	Falha
Canceled	Cancelado
Declined	Recusado