Partner Transfers - List

Serviço:

Billing

Versão da API:

2024-04-01

Lista as solicitações de transferência enviadas a um cliente. A operação tem suporte apenas para contas de cobrança com o tipo de contrato Microsoft Partner Agreement.

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

Parâmetros de URI

Nome	Em	Obrigató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})?)$	A ID que identifica exclusivamente uma conta de cobrança.
billingProfileName	path	True	string pattern: ^[a-zA-Z\d-_]{1,128}$	A ID que identifica exclusivamente um perfil de cobrança.
customerName	path	True	string pattern: ^[a-zA-Z\d-_]{1,128}$	A ID que identifica exclusivamente um cliente.
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

Nome	Tipo	Description
200 OK	PartnerTransferDetailsListResult	Lista de transferências iniciadas nesta seção da fatura.
Other Status Codes	ErrorResponse	Erro inesperado.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

PartnerTransfersList

Solicitação de exemplo

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/customers/11111111-1111-1111-1111-111111111111/transfers?api-version=2024-04-01

Java

/**
 * Samples for PartnerTransfers List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/partnerTransfersList.json
     */
    /**
     * Sample code: PartnerTransfersList.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void partnerTransfersList(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.partnerTransfers().list(
            "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "xxxx-xxxx-xxx-xxx",
            "11111111-1111-1111-1111-111111111111", 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 partner_transfers_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.partner_transfers.list(
        billing_account_name="10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        billing_profile_name="xxxx-xxxx-xxx-xxx",
        customer_name="11111111-1111-1111-1111-111111111111",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/partnerTransfersList.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/partnerTransfersList.json
func ExamplePartnerTransfersClient_NewListPager() {
	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.NewPartnerTransfersClient().NewListPager("10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "xxxx-xxxx-xxx-xxx", "11111111-1111-1111-1111-111111111111", 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.PartnerTransferDetailsListResult = armbilling.PartnerTransferDetailsListResult{
		// 	Value: []*armbilling.PartnerTransferDetails{
		// 		{
		// 			Name: to.Ptr("aabb123"),
		// 			Type: to.Ptr("Microsoft.Billing/transfers"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123"),
		// 			Properties: &armbilling.PartnerTransferProperties{
		// 				DetailedTransferStatus: []*armbilling.DetailedTransferStatus{
		// 					{
		// 						ProductID: to.Ptr("subscriptionId"),
		// 						ProductName: to.Ptr("Azure subscription 1"),
		// 						ProductType: to.Ptr(armbilling.ProductTypeAzureSubscription),
		// 						SKUDescription: to.Ptr("MS-AZR-0017G"),
		// 						TransferStatus: to.Ptr(armbilling.ProductTransferStatusInProgress),
		// 					},
		// 					{
		// 						ProductID: to.Ptr("reservedInstanceId"),
		// 						ProductName: to.Ptr("Reservation name"),
		// 						ProductType: to.Ptr(armbilling.ProductTypeAzureReservation),
		// 						SKUDescription: to.Ptr("Standard_D2s_v3;VirtualMachines;P1Y"),
		// 						TransferStatus: to.Ptr(armbilling.ProductTransferStatusInProgress),
		// 				}},
		// 				ExpirationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-05T17:32:28.000Z"); return t}()),
		// 				InitiatorCustomerType: to.Ptr(armbilling.InitiatorCustomerTypePartner),
		// 				InitiatorEmailID: to.Ptr("xyz@contoso.com"),
		// 				RecipientEmailID: to.Ptr("user@contoso.com"),
		// 				TransferStatus: to.Ptr(armbilling.TransferStatusInProgress),
		// 			},
		// 	}},
		// }
	}
}

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 transfer requests sent to a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
 *
 * @summary Lists the transfer requests sent to a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/partnerTransfersList.json
 */
async function partnerTransfersList() {
  const billingAccountName =
    "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
  const billingProfileName = "xxxx-xxxx-xxx-xxx";
  const customerName = "11111111-1111-1111-1111-111111111111";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.partnerTransfers.list(
    billingAccountName,
    billingProfileName,
    customerName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/partnerTransfersList.json
// this example is just showing the usage of "PartnerTransfers_List" 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 BillingProfileCustomerResource created on azure
// for more information of creating BillingProfileCustomerResource, please refer to the document of BillingProfileCustomerResource
string billingAccountName = "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
string billingProfileName = "xxxx-xxxx-xxx-xxx";
string customerName = "11111111-1111-1111-1111-111111111111";
ResourceIdentifier billingProfileCustomerResourceId = BillingProfileCustomerResource.CreateResourceIdentifier(billingAccountName, billingProfileName, customerName);
BillingProfileCustomerResource billingProfileCustomer = client.GetBillingProfileCustomerResource(billingProfileCustomerResourceId);

// get the collection of this PartnerTransferDetailResource
PartnerTransferDetailCollection collection = billingProfileCustomer.GetPartnerTransferDetails();

// invoke the operation and iterate over the result
await foreach (PartnerTransferDetailResource item in collection.GetAllAsync())
{
    // the variable item 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
    PartnerTransferDetailData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123",
      "name": "aabb123",
      "type": "Microsoft.Billing/transfers",
      "properties": {
        "expirationTime": "2018-11-05T17:32:28Z",
        "transferStatus": "InProgress",
        "recipientEmailId": "user@contoso.com",
        "initiatorEmailId": "xyz@contoso.com",
        "initiatorCustomerType": "Partner",
        "detailedTransferStatus": [
          {
            "productType": "AzureSubscription",
            "productId": "subscriptionId",
            "productName": "Azure subscription 1",
            "skuDescription": "MS-AZR-0017G",
            "transferStatus": "InProgress"
          },
          {
            "productType": "AzureReservation",
            "productId": "reservedInstanceId",
            "productName": "Reservation name",
            "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y",
            "transferStatus": "InProgress"
          }
        ]
      }
    }
  ]
}

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
DetailedTransferStatus	Status de transferência detalhado.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
initiatorCustomerType	O tipo de cliente que enviou a solicitação de transferência.
PartnerTransferDetails	Detalhes da transferência.
PartnerTransferDetailsListResult	A lista de transferências iniciadas pelo parceiro.
productTransferStatus	Status da transferência.
productType	Tipo do produto que é transferido.
systemData	Metadados relativos à criação e última modificação do recurso.
TransferError	Detalhes do erro para a execução da transferência.
transferStatus	Status geral da transferência.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DetailedTransferStatus

Objeto

Status de transferência detalhado.

Nome	Tipo	Description
errorDetails	TransferError	Detalhes do erro para a 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 transferido.
skuDescription	string	A SKU do produto que é transferido.
transferStatus	productTransferStatus	Status da transferência.

ErrorAdditionalInfo

Objeto

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

Objeto

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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

initiatorCustomerType

Enumeração

O tipo de cliente que enviou a solicitação de transferência.

Valor	Description
EA
Partner

PartnerTransferDetails

Objeto

Detalhes da transferência.

Nome	Tipo	Description
id	string (arm-id)	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.canceledBy	string	A ID de email do usuário que cancelou a solicitação de transferência.
properties.detailedTransferStatus	DetailedTransferStatus[]	Status de transferência detalhado.
properties.expirationTime	string (date-time)	A hora em que a solicitação de transferência expira.
properties.initiatorCustomerType	initiatorCustomerType	O tipo de cliente que enviou a solicitação de transferência.
properties.initiatorEmailId	string	A ID de email do usuário que enviou a solicitação de transferência.
properties.recipientEmailId	string	A ID de email do usuário para o qual a solicitação de transferência foi enviada.
properties.resellerId	string	ID opcional do MPN do revendedor para solicitações de transferência que são enviadas de uma conta de cobrança do Contrato de Parceiro da Microsoft.
properties.resellerName	string	Nome opcional do revendedor para solicitações de transferência que são enviadas da conta de cobrança do Contrato de Parceiro da Microsoft.
properties.transferStatus	transferStatus	Status geral da transferência.
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"

PartnerTransferDetailsListResult

Objeto

A lista de transferências iniciadas pelo parceiro.

Nome	Tipo	Description
nextLink	string	O link (url) para a próxima página de resultados.
value	PartnerTransferDetails[]	A lista de transferências iniciadas pelo parceiro.

productTransferStatus

Enumeração

Status da transferência.

Valor	Description
Completed
Failed
InProgress
NotStarted

productType

Enumeração

Tipo do produto que é transferido.

Valor	Description
AzureReservation
AzureSubscription
Department
SAAS
SavingsPlan

systemData

Objeto

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

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

TransferError

Objeto

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

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

transferStatus

Enumeração

Status geral da transferência.

Valor	Description
Canceled
Completed
CompletedWithErrors
Declined
Expired
Failed
InProgress
Pending