Partner Transfers - List

Service:

Billing

API-versie:

2024-04-01

Geeft een lijst weer van de overdrachtsaanvragen die naar een klant worden verzonden. De bewerking wordt alleen ondersteund voor factureringsaccounts met het overeenkomsttype Microsoft Partner-overeenkomst.

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

URI-parameters

Name	In	Vereist	Type	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})?)$	De id waarmee een factureringsrekening uniek wordt geïdentificeerd.
billingProfileName	path	True	string pattern: ^[a-zA-Z\d-_]{1,128}$	De id waarmee een factureringsprofiel uniek wordt geïdentificeerd.
customerName	path	True	string pattern: ^[a-zA-Z\d-_]{1,128}$	De id waarmee een klant uniek wordt geïdentificeerd.
api-version	query	True	string	De versie van de API die moet worden gebruikt met de clientaanvraag. De huidige versie is 2024-04-01.

Antwoorden

Name	Type	Description
200 OK	PartnerTransferDetailsListResult	Lijst met overdrachten die zijn geïnitieerd vanuit deze factuursectie.
Other Status Codes	ErrorResponse	Onverwachte fout.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

PartnerTransfersList

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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"
          }
        ]
      }
    }
  ]
}

Definities

Name	Description
createdByType	Het type identiteit waarmee de resource is gemaakt.
DetailedTransferStatus	Gedetailleerde overdrachtsstatus.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
initiatorCustomerType	Het type klant dat de overdrachtsaanvraag heeft verzonden.
PartnerTransferDetails	Details van de overdracht.
PartnerTransferDetailsListResult	De lijst met overdrachten geïnitieerd door de partner.
productTransferStatus	Overdrachtsstatus.
productType	Type van het product dat wordt overgedragen.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
TransferError	Foutdetails voor overdrachtsuitvoering.
transferStatus	Algemene overdrachtsstatus.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

DetailedTransferStatus

Object

Gedetailleerde overdrachtsstatus.

Name	Type	Description
errorDetails	TransferError	Foutdetails voor overdrachtsuitvoering.
productId	string	De id van het product dat wordt overgedragen.
productName	string	De naam van het product dat wordt overgedragen.
productType	productType	Type product dat wordt overgedragen.
skuDescription	string	De SKU van het product dat wordt overgedragen.
transferStatus	productTransferStatus	Overdrachtsstatus.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

initiatorCustomerType

Inventarisatie

Het type klant dat de overdrachtsaanvraag heeft verzonden.

Waarde	Description
EA
Partner

PartnerTransferDetails

Object

Details van de overdracht.

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties.canceledBy	string	De e-mail-id van de gebruiker die de overdrachtsaanvraag heeft geannuleerd.
properties.detailedTransferStatus	DetailedTransferStatus[]	Gedetailleerde overdrachtsstatus.
properties.expirationTime	string (date-time)	Het tijdstip waarop de overdrachtsaanvraag verloopt.
properties.initiatorCustomerType	initiatorCustomerType	Het type klant dat de overdrachtsaanvraag heeft verzonden.
properties.initiatorEmailId	string	De e-mail-id van de gebruiker die de overdrachtsaanvraag heeft verzonden.
properties.recipientEmailId	string	De e-mail-id van de gebruiker aan wie de overdrachtsaanvraag is verzonden.
properties.resellerId	string	Optionele MPN-id van de reseller voor overdrachtsaanvragen die worden verzonden vanuit een factureringsrekening van een Microsoft Partner-overeenkomst.
properties.resellerName	string	Optionele naam van de reseller voor overdrachtsaanvragen die worden verzonden vanuit de factureringsrekening van de Microsoft Partner-overeenkomst.
properties.transferStatus	transferStatus	Algemene overdrachtsstatus.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
tags	object	Woordenlijst met metagegevens die zijn gekoppeld aan de resource. Deze kan niet worden ingevuld voor alle resourcetypen. Maximale lengte van sleutel/waarde die wordt ondersteund door 256 tekens. Sleutels/waarde mogen geen lege waarde of null zijn. Sleutels kunnen geen <> % & \ bevatten? /
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PartnerTransferDetailsListResult

Object

De lijst met overdrachten geïnitieerd door de partner.

Name	Type	Description
nextLink	string	De koppeling (URL) naar de volgende pagina met resultaten.
value	PartnerTransferDetails[]	De lijst met overdrachten geïnitieerd door de partner.

productTransferStatus

Inventarisatie

Overdrachtsstatus.

Waarde	Description
Completed
Failed
InProgress
NotStarted

productType

Inventarisatie

Type van het product dat wordt overgedragen.

Waarde	Description
AzureReservation
AzureSubscription
Department
SAAS
SavingsPlan

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

TransferError

Object

Foutdetails voor overdrachtsuitvoering.

Name	Type	Description
code	string	Foutcode.
message	string	Foutmelding.

transferStatus

Inventarisatie

Algemene overdrachtsstatus.

Waarde	Description
Canceled
Completed
CompletedWithErrors
Declined
Expired
Failed
InProgress
Pending