Recipient Transfers - Accept

Dienst:

Billing

API-Version:

2024-04-01

Akzeptiert eine Übertragungsanforderung.

POST https://management.azure.com/providers/Microsoft.Billing/transfers/{transferName}/accept?api-version=2024-04-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
transferName	path	True	string	Die ID, die eine Übertragungsanforderung eindeutig identifiziert. RegEx-Muster: ^[a-z0-9]*$
api-version	query	True	string	Die Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2024-04-01.

Anforderungstext

Name	Typ	Beschreibung
properties.productDetails	ProductDetails[]	Fordern Sie Parameter an, um die Übertragung zu akzeptieren.

Antworten

Name	Typ	Beschreibung
200 OK	RecipientTransferDetails	Details der akzeptierten Übertragung.
Other Status Codes	ErrorResponse	Unerwarteter Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

AcceptTransfer

Beispielanforderung

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/transfers/aabb123/accept?api-version=2024-04-01

{
  "properties": {
    "productDetails": [
      {
        "productType": "AzureSubscription",
        "productId": "subscriptionId"
      },
      {
        "productType": "AzureReservation",
        "productId": "reservedInstanceId"
      }
    ]
  }
}

Java

import com.azure.resourcemanager.billing.models.AcceptTransferRequest;
import com.azure.resourcemanager.billing.models.ProductDetails;
import com.azure.resourcemanager.billing.models.ProductType;
import java.util.Arrays;

/**
 * Samples for RecipientTransfers Accept.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersAccept.json
     */
    /**
     * Sample code: AcceptTransfer.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void acceptTransfer(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.recipientTransfers().acceptWithResponse("aabb123",
            new AcceptTransferRequest().withProductDetails(Arrays.asList(
                new ProductDetails().withProductType(ProductType.AZURE_SUBSCRIPTION).withProductId("subscriptionId"),
                new ProductDetails().withProductType(ProductType.AZURE_RESERVATION)
                    .withProductId("reservedInstanceId"))),
            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 recipient_transfers_accept.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.recipient_transfers.accept(
        transfer_name="aabb123",
        parameters={
            "properties": {
                "productDetails": [
                    {"productId": "subscriptionId", "productType": "AzureSubscription"},
                    {"productId": "reservedInstanceId", "productType": "AzureReservation"},
                ]
            }
        },
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersAccept.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/azcore/to"
	"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/recipientTransfersAccept.json
func ExampleRecipientTransfersClient_Accept() {
	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)
	}
	res, err := clientFactory.NewRecipientTransfersClient().Accept(ctx, "aabb123", armbilling.AcceptTransferRequest{
		Properties: &armbilling.AcceptTransferProperties{
			ProductDetails: []*armbilling.ProductDetails{
				{
					ProductID:   to.Ptr("subscriptionId"),
					ProductType: to.Ptr(armbilling.ProductTypeAzureSubscription),
				},
				{
					ProductID:   to.Ptr("reservedInstanceId"),
					ProductType: to.Ptr(armbilling.ProductTypeAzureReservation),
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RecipientTransferDetails = armbilling.RecipientTransferDetails{
	// 	Name: to.Ptr("aabb123"),
	// 	Type: to.Ptr("Microsoft.Billing/transfers"),
	// 	ID: to.Ptr("/providers/Microsoft.Billing/transfers/aabb123"),
	// 	Properties: &armbilling.RecipientTransferProperties{
	// 		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}()),
	// 		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 Accepts a transfer request.
 *
 * @summary Accepts a transfer request.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersAccept.json
 */
async function acceptTransfer() {
  const transferName = "aabb123";
  const parameters = {
    productDetails: [
      { productId: "subscriptionId", productType: "AzureSubscription" },
      { productId: "reservedInstanceId", productType: "AzureReservation" },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.recipientTransfers.accept(transferName, parameters);
  console.log(result);
}

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/recipientTransfersAccept.json
// this example is just showing the usage of "RecipientTransfers_Accept" 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 RecipientTransferDetailResource created on azure
// for more information of creating RecipientTransferDetailResource, please refer to the document of RecipientTransferDetailResource
string transferName = "aabb123";
ResourceIdentifier recipientTransferDetailResourceId = RecipientTransferDetailResource.CreateResourceIdentifier(transferName);
RecipientTransferDetailResource recipientTransferDetail = client.GetRecipientTransferDetailResource(recipientTransferDetailResourceId);

// invoke the operation
AcceptTransferContent content = new AcceptTransferContent()
{
    ProductDetails =
    {
    new BillingProductDetails()
    {
    ProductType = BillingProductType.AzureSubscription,
    ProductId = "subscriptionId",
    },new BillingProductDetails()
    {
    ProductType = BillingProductType.AzureReservation,
    ProductId = "reservedInstanceId",
    }
    },
};
RecipientTransferDetailResource result = await recipientTransferDetail.AcceptAsync(content);

// the variable result 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
RecipientTransferDetailData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/providers/Microsoft.Billing/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",
    "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"
      }
    ]
  }
}

Definitionen

Name	Beschreibung
AcceptTransferRequest	Fordern Sie Parameter an, um die Übertragung zu akzeptieren.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DetailedTransferStatus	Detaillierter Übertragungsstatus.
eligibleProductType	Art der Abonnements, die übertragen werden können.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
initiatorCustomerType	Der Typ des Kunden, der die Übertragungsanforderung gesendet hat.
ProductDetails	Details zum übertragenen Produkt.
productTransferStatus	Übertragungsstatus.
productType	Art des Produkts, das übertragen wird.
RecipientTransferDetails	Details der Übertragung.
supportedAccountType	Liste der unterstützten Kontotypen.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
TransferError	Fehlerdetails für die Übertragung der Ausführung.
transferStatus	Gesamtübertragungsstatus.

AcceptTransferRequest

Fordern Sie Parameter an, um die Übertragung zu akzeptieren.

Name	Typ	Beschreibung
properties.productDetails	ProductDetails[]	Fordern Sie Parameter an, um die Übertragung zu akzeptieren.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

DetailedTransferStatus

Detaillierter Übertragungsstatus.

Name	Typ	Beschreibung
errorDetails	TransferError	Fehlerdetails für die Übertragung der Ausführung.
productId	string	Die ID des Produkts, das übertragen wird.
productName	string	Der Name des produkts, das übertragen wird.
productType	productType	Art des Produkts, das übertragen wird.
skuDescription	string	Die SKU des produkts, das übertragen wird.
transferStatus	productTransferStatus	Übertragungsstatus.

eligibleProductType

Art der Abonnements, die übertragen werden können.

Name	Typ	Beschreibung
AzureReservation	string
DevTestAzureSubscription	string
StandardAzureSubscription	string

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

initiatorCustomerType

Der Typ des Kunden, der die Übertragungsanforderung gesendet hat.

Name	Typ	Beschreibung
EA	string
Partner	string

ProductDetails

Details zum übertragenen Produkt.

Name	Typ	Beschreibung
productId	string	Die ID des Produkts, das übertragen wird.
productType	productType	Art des Produkts, das übertragen wird.

productTransferStatus

Übertragungsstatus.

Name	Typ	Beschreibung
Completed	string
Failed	string
InProgress	string
NotStarted	string

productType

Art des Produkts, das übertragen wird.

Name	Typ	Beschreibung
AzureReservation	string
AzureSubscription	string
Department	string
SAAS	string
SavingsPlan	string

RecipientTransferDetails

Details der Übertragung.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.allowedProductType	eligibleProductType[]	Art der Abonnements, die übertragen werden können.
properties.canceledBy	string	Die E-Mail-ID des Benutzers, der die Übertragungsanforderung abgebrochen hat.
properties.customerTenantId	string	Die Kundenmandanten-ID.
properties.detailedTransferStatus	DetailedTransferStatus[]	Detaillierter Übertragungsstatus.
properties.expirationTime	string	Der Zeitpunkt, zu dem die Übertragungsanforderung abläuft.
properties.initiatorCustomerType	initiatorCustomerType	Der Typ des Kunden, der die Übertragungsanforderung gesendet hat.
properties.initiatorEmailId	string	Die E-Mail-ID des Benutzers, der die Übertragungsanforderung gesendet hat.
properties.recipientEmailId	string	Die E-Mail-ID des Benutzers, an den die Übertragungsanforderung gesendet wurde.
properties.resellerId	string	Optionale MPN-ID des Händlers für Überweisungsanfragen, die von einem Abrechnungskonto für Microsoft Partner Agreement gesendet werden.
properties.resellerName	string	Optionaler Name des Wiederverkäufers für Überweisungsanfragen, die vom Abrechnungskonto des Microsoft Partner Agreement gesendet werden.
properties.supportedAccounts	supportedAccountType[]	Liste der unterstützten Kontotypen.
properties.transferStatus	transferStatus	Gesamtübertragungsstatus.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object	Wörterbuch der Metadaten, die der Ressource zugeordnet sind. Möglicherweise wird sie nicht für alle Ressourcentypen aufgefüllt. Maximale Schlüssel-/Wertlänge unterstützt von 256 Zeichen. Schlüssel/Wert dürfen keinen leeren Wert oder null sein. Schlüssel können nicht <> % & \ enthalten? /
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

supportedAccountType

Liste der unterstützten Kontotypen.

Name	Typ	Beschreibung
Enterprise	string
Individual	string
None	string
Partner	string

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

TransferError

Fehlerdetails für die Übertragung der Ausführung.

Name	Typ	Beschreibung
code	string	Fehlercode.
message	string	Fehlermeldung.

transferStatus

Gesamtübertragungsstatus.

Name	Typ	Beschreibung
Canceled	string
Completed	string
CompletedWithErrors	string
Declined	string
Expired	string
Failed	string
InProgress	string
Pending	string