Transfers - Initiate

サービス:

Billing

API バージョン:

2024-04-01

サブスクリプションの課金所有権を譲渡するために、別の課金アカウントのユーザーに要求を送信します。 この操作は、契約の種類が Microsoft 顧客契約の請求先アカウントでのみサポートされます。

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

URI パラメーター

名前	/	必須	型	説明
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})?)$	課金アカウントを一意に識別する ID。
billingProfileName	path	True	string pattern: ^[a-zA-Z\d-_]{1,128}$	課金プロファイルを一意に識別する ID。
invoiceSectionName	path	True	string pattern: ^[a-zA-Z\d-_]{1,128}$	請求書セクションを一意に識別する ID。
transferName	path	True	string pattern: ^[a-z0-9]*$	転送要求を一意に識別する ID。
api-version	query	True	string	クライアント要求で使用する API のバージョン。 現在のバージョンは 2024-04-01 です。

要求本文

名前	型	説明
properties.recipientEmailId	string	転送要求の送信先の受信者の電子メール ID。

応答

名前	型	説明
200 OK	TransferDetails	開始された転送の詳細。
201 Created	TransferDetails	開始された転送の詳細。
Other Status Codes	ErrorResponse	予期しないエラー。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

InitiateTransfer

要求のサンプル

HTTP

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

{
  "properties": {
    "recipientEmailId": "user@contoso.com"
  }
}

Java

import com.azure.resourcemanager.billing.models.InitiateTransferRequest;

/**
 * Samples for Transfers Initiate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transfersInitiate.json
     */
    /**
     * Sample code: InitiateTransfer.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void initiateTransfer(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.transfers().initiateWithResponse(
            "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "xxxx-xxxx-xxx-xxx",
            "yyyy-yyyy-yyy-yyy", "aabb123", new InitiateTransferRequest().withRecipientEmailId("user@contoso.com"),
            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 transfers_initiate.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.transfers.initiate(
        billing_account_name="10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        billing_profile_name="xxxx-xxxx-xxx-xxx",
        invoice_section_name="yyyy-yyyy-yyy-yyy",
        transfer_name="aabb123",
        parameters={"properties": {"recipientEmailId": "user@contoso.com"}},
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transfersInitiate.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/transfersInitiate.json
func ExampleTransfersClient_Initiate() {
	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.NewTransfersClient().Initiate(ctx, "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "xxxx-xxxx-xxx-xxx", "yyyy-yyyy-yyy-yyy", "aabb123", armbilling.InitiateTransferRequest{
		Properties: &armbilling.InitiateTransferProperties{
			RecipientEmailID: to.Ptr("user@contoso.com"),
		},
	}, 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.TransferDetails = armbilling.TransferDetails{
	// 	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/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123"),
	// 	Properties: &armbilling.TransferProperties{
	// 		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.TransferStatusPending),
	// 	},
	// }
}

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 Sends a request to a user in another billing account to transfer billing ownership of their subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
 *
 * @summary Sends a request to a user in another billing account to transfer billing ownership of their subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transfersInitiate.json
 */
async function initiateTransfer() {
  const billingAccountName =
    "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
  const billingProfileName = "xxxx-xxxx-xxx-xxx";
  const invoiceSectionName = "yyyy-yyyy-yyy-yyy";
  const transferName = "aabb123";
  const parameters = {
    recipientEmailId: "user@contoso.com",
  };
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.transfers.initiate(
    billingAccountName,
    billingProfileName,
    invoiceSectionName,
    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/transfersInitiate.json
// this example is just showing the usage of "Transfers_Initiate" 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 BillingTransferDetailResource created on azure
// for more information of creating BillingTransferDetailResource, please refer to the document of BillingTransferDetailResource
string billingAccountName = "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
string billingProfileName = "xxxx-xxxx-xxx-xxx";
string invoiceSectionName = "yyyy-yyyy-yyy-yyy";
string transferName = "aabb123";
ResourceIdentifier billingTransferDetailResourceId = BillingTransferDetailResource.CreateResourceIdentifier(billingAccountName, billingProfileName, invoiceSectionName, transferName);
BillingTransferDetailResource billingTransferDetail = client.GetBillingTransferDetailResource(billingTransferDetailResourceId);

// invoke the operation
BillingTransferDetailCreateOrUpdateContent content = new BillingTransferDetailCreateOrUpdateContent
{
    RecipientEmailId = "user@contoso.com",
};
ArmOperation<BillingTransferDetailResource> lro = await billingTransferDetail.UpdateAsync(WaitUntil.Completed, content);
BillingTransferDetailResource result = lro.Value;

// 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
BillingTransferDetailData 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

応答のサンプル

状態コード:

200

{
  "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",
  "name": "aabb123",
  "type": "Microsoft.Billing/transfers",
  "properties": {
    "expirationTime": "2018-11-05T17:32:28Z",
    "transferStatus": "Pending",
    "recipientEmailId": "user@contoso.com",
    "initiatorEmailId": "xyz@contoso.com"
  }
}

状態コード:

201

{
  "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",
  "name": "aabb123",
  "type": "Microsoft.Billing/transfers",
  "properties": {
    "expirationTime": "2018-11-05T17:32:28Z",
    "transferStatus": "Pending",
    "recipientEmailId": "user@contoso.com",
    "initiatorEmailId": "xyz@contoso.com"
  }
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
DetailedTransferStatus	詳細な転送状態。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
InitiateTransferRequest	転送を開始するためのパラメーターを要求します。
productTransferStatus	転送の状態。
productType	転送される製品の種類。
systemData	リソースの作成と最後の変更に関連するメタデータ。
TransferDetails	転送の詳細。
TransferError	転送の実行に関するエラーの詳細。
transferStatus	全体的な転送状態。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

DetailedTransferStatus

Object

詳細な転送状態。

名前	型	説明
errorDetails	TransferError	転送の実行に関するエラーの詳細。
productId	string	転送される製品の ID。
productName	string	転送される製品の名前。
productType	productType	転送される製品の種類。
skuDescription	string	転送される製品の SKU。
transferStatus	productTransferStatus	転送の状態。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

InitiateTransferRequest

Object

転送を開始するためのパラメーターを要求します。

名前	型	説明
properties.recipientEmailId	string	転送要求の送信先の受信者の電子メール ID。

productTransferStatus

列挙

転送の状態。

値	説明
Completed
Failed
InProgress
NotStarted

productType

列挙

転送される製品の種類。

値	説明
AzureReservation
AzureSubscription
Department
SAAS
SavingsPlan

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

TransferDetails

Object

転送の詳細。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.canceledBy	string	転送要求をキャンセルしたユーザーの電子メール ID。
properties.detailedTransferStatus	DetailedTransferStatus[]	詳細な転送状態。
properties.expirationTime	string (date-time)	転送要求の有効期限が切れる時刻。
properties.initiatorEmailId	string	転送要求を送信したユーザーの電子メール ID。
properties.recipientEmailId	string	転送要求が送信されたユーザーの電子メール ID。
properties.transferStatus	transferStatus	全体的な転送状態。
systemData	systemData	createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソースに関連付けられているメタデータのディクショナリ。 リソースの種類によっては設定されない場合があります。 キー/値の最大長は 256 文字でサポートされます。 キー/値は、値を空にしたり、null にしたりしないでください。 キーは <> % &\ を含むできませんか? /
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

TransferError

Object

転送の実行に関するエラーの詳細。

名前	型	説明
code	string	エラー コード。
message	string	エラーメッセージ。

transferStatus

列挙

全体的な転送状態。

値	説明
Canceled
Completed
CompletedWithErrors
Declined
Expired
Failed
InProgress
Pending