Payment Methods - List By User

服務:

Billing

API 版本:

2024-04-01

列出呼叫者所擁有的付款方式。

GET https://management.azure.com/providers/Microsoft.Billing/paymentMethods?api-version=2024-04-01

URI 參數

名稱	位於	必要	類型	Description
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。 目前的版本是 2024-04-01。

回應

名稱	類型	Description
200 OK	PaymentMethodsListResult	還行。 要求已成功。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ListPaymentMethodOwnedByUser

範例要求

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/paymentMethods?api-version=2024-04-01

Java

/**
 * Samples for PaymentMethods ListByUser.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsListByUser.json
     */
    /**
     * Sample code: ListPaymentMethodOwnedByUser.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void listPaymentMethodOwnedByUser(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.paymentMethods().listByUser(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 payment_methods_list_by_user.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.payment_methods.list_by_user()
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsListByUser.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/paymentMethodsListByUser.json
func ExamplePaymentMethodsClient_NewListByUserPager() {
	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.NewPaymentMethodsClient().NewListByUserPager(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.PaymentMethodsListResult = armbilling.PaymentMethodsListResult{
		// 	Value: []*armbilling.PaymentMethod{
		// 		{
		// 			Name: to.Ptr("ABCDABCDABC0"),
		// 			Type: to.Ptr("Microsoft.Billing/paymentMethods"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0"),
		// 			Properties: &armbilling.PaymentMethodProperties{
		// 				AccountHolderName: to.Ptr("abc"),
		// 				DisplayName: to.Ptr("Master Card"),
		// 				Expiration: to.Ptr("1/2035"),
		// 				Family: to.Ptr(armbilling.PaymentMethodFamilyCreditCard),
		// 				LastFourDigits: to.Ptr("1270"),
		// 				Logos: []*armbilling.PaymentMethodLogo{
		// 					{
		// 						MimeType: to.Ptr("image/png"),
		// 						URL: to.Ptr("https://contoso.com/staticresourceservice/images/v4/logo_mc_rect.png"),
		// 					},
		// 					{
		// 						MimeType: to.Ptr("image/svg+xml"),
		// 						URL: to.Ptr("https://contoso.com/staticresourceservice/images/v4/logo_mc.svg"),
		// 				}},
		// 				PaymentMethodType: to.Ptr("mc"),
		// 				Status: to.Ptr(armbilling.PaymentMethodStatusActive),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("ABCDABCDABC1"),
		// 			Type: to.Ptr("Microsoft.Billing/paymentMethods"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC1"),
		// 			Properties: &armbilling.PaymentMethodProperties{
		// 				AccountHolderName: to.Ptr("abc"),
		// 				DisplayName: to.Ptr("Visa"),
		// 				Expiration: to.Ptr("1/2025"),
		// 				Family: to.Ptr(armbilling.PaymentMethodFamilyCreditCard),
		// 				LastFourDigits: to.Ptr("7373"),
		// 				Logos: []*armbilling.PaymentMethodLogo{
		// 					{
		// 						MimeType: to.Ptr("image/png"),
		// 						URL: to.Ptr("https://contoso.com/staticresourceservice/images/v4/logo_visa_rect.png"),
		// 					},
		// 					{
		// 						MimeType: to.Ptr("image/svg+xml"),
		// 						URL: to.Ptr("https://contoso.com/staticresourceservice/images/v4/logo_visa.svg"),
		// 				}},
		// 				PaymentMethodType: to.Ptr("visa"),
		// 				Status: to.Ptr(armbilling.PaymentMethodStatusActive),
		// 			},
		// 	}},
		// }
	}
}

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 payment methods owned by the caller.
 *
 * @summary Lists the payment methods owned by the caller.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsListByUser.json
 */
async function listPaymentMethodOwnedByUser() {
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.paymentMethods.listByUser()) {
    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.Resources;
using Azure.ResourceManager.Billing;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsListByUser.json
// this example is just showing the usage of "PaymentMethods_ListByUser" 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);

TenantResource tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// get the collection of this BillingPaymentMethodResource
BillingPaymentMethodCollection collection = tenantResource.GetBillingPaymentMethods();

// invoke the operation and iterate over the result
await foreach (BillingPaymentMethodResource 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
    BillingPaymentMethodData 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

範例回覆

狀態碼:

200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0",
      "name": "ABCDABCDABC0",
      "type": "Microsoft.Billing/paymentMethods",
      "properties": {
        "accountHolderName": "abc",
        "expiration": "1/2035",
        "lastFourDigits": "1270",
        "family": "CreditCard",
        "paymentMethodType": "mc",
        "displayName": "Master Card",
        "logos": [
          {
            "mimeType": "image/png",
            "url": "https://contoso.com/staticresourceservice/images/v4/logo_mc_rect.png"
          },
          {
            "mimeType": "image/svg+xml",
            "url": "https://contoso.com/staticresourceservice/images/v4/logo_mc.svg"
          }
        ],
        "status": "active"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC1",
      "name": "ABCDABCDABC1",
      "type": "Microsoft.Billing/paymentMethods",
      "properties": {
        "accountHolderName": "abc",
        "expiration": "1/2025",
        "lastFourDigits": "7373",
        "family": "CreditCard",
        "paymentMethodType": "visa",
        "displayName": "Visa",
        "logos": [
          {
            "mimeType": "image/png",
            "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa_rect.png"
          },
          {
            "mimeType": "image/svg+xml",
            "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa.svg"
          }
        ],
        "status": "active"
      }
    }
  ]
}

定義

名稱	Description
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
PaymentMethod	付款方式。
paymentMethodFamily	付款方式系列。
PaymentMethodLogo	付款方式的標誌。
PaymentMethodsListResult	付款方式清單。
paymentMethodStatus	付款條件的狀態。
systemData	與建立和上次修改資源相關的元數據。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

PaymentMethod

Object

付款方式。

名稱	類型	Description
id	string (arm-id)	資源的完整資源標識碼。 例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	資源的名稱
properties.accountHolderName	string	付款方式的帳戶持有人名稱。 只有家庭信用卡的付款方式才支援此功能。
properties.displayName	string	付款方式的顯示名稱。
properties.expiration	string	付款方式的到期月份和年份。 只有家庭信用卡的付款方式才支援此功能。
properties.family	paymentMethodFamily	付款方式系列。
properties.id	string	付款方式的標識碼。
properties.lastFourDigits	string	付款方式的最後四位數。
properties.logos	PaymentMethodLogo[]	付款方式的標誌清單。
properties.paymentMethodType	string	付款方式的類型。
properties.status	paymentMethodStatus	付款條件的狀態。
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
tags	object	與資源相關聯的元數據字典。 並非所有資源類型都會填入。 支援的索引鍵/值長度上限為 256 個字元。 索引鍵/值不應空白值或 Null。 索引鍵不能包含 <> % & \ ？ /
type	string	資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

paymentMethodFamily

列舉型別

付款方式系列。

值	Description
CheckWire
CreditCard
Credits
DirectDebit
EWallet
None
Other
TaskOrder

PaymentMethodLogo

Object

付款方式的標誌。

名稱	類型	Description
mimeType	string	標誌的MIME類型。
url	string	標誌影像的公用 URL。

PaymentMethodsListResult

Object

付款方式清單。

名稱	類型	Description
nextLink	string	結果下一頁的連結（url）。
value	PaymentMethod[]	付款方式清單。

paymentMethodStatus

列舉型別

付款條件的狀態。

值	Description
active
inactive

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。