Payment Methods - Get By Billing Profile

Dienst:

Billing

API-Version:

2024-04-01

Ruft eine Zahlungsmethode ab, die mit einem Abrechnungsprofil verknüpft ist. Der Vorgang wird nur für Abrechnungskonten mit dem Vertragstyp Microsoft-Kundenvertrag unterstützt.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
billingAccountName	path	True	string	Die ID, die ein Abrechnungskonto eindeutig identifiziert.
billingProfileName	path	True	string	Die ID, die ein Abrechnungsprofil eindeutig identifiziert.
paymentMethodName	path	True	string	Die ID, die eine Zahlungsmethode eindeutig identifiziert.
api-version	query	True	string	Die Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2024-04-01.

Antworten

Name	Typ	Beschreibung
200 OK	PaymentMethodLink	OKAY. Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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

PaymentMethodsGetByBillingProfile

Beispielanforderung

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31/billingProfiles/ABC1-A1CD-AB1-BP1/paymentMethodLinks/ABCDABCDABC0?api-version=2024-04-01

Java

/**
 * Samples for PaymentMethods GetByBillingProfile.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * paymentMethodsGetByBillingProfile.json
     */
    /**
     * Sample code: PaymentMethodsGetByBillingProfile.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void paymentMethodsGetByBillingProfile(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.paymentMethods().getByBillingProfileWithResponse(
            "00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31", "ABC1-A1CD-AB1-BP1",
            "ABCDABCDABC0", 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_get_by_billing_profile.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.get_by_billing_profile(
        billing_account_name="00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31",
        billing_profile_name="ABC1-A1CD-AB1-BP1",
        payment_method_name="ABCDABCDABC0",
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsGetByBillingProfile.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/paymentMethodsGetByBillingProfile.json
func ExamplePaymentMethodsClient_GetByBillingProfile() {
	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.NewPaymentMethodsClient().GetByBillingProfile(ctx, "00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31", "ABC1-A1CD-AB1-BP1", "ABCDABCDABC0", 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.PaymentMethodLink = armbilling.PaymentMethodLink{
	// 	Name: to.Ptr("ABCDABCDABC0"),
	// 	Type: to.Ptr("Microsoft.Billing/billingAccounts/billingProfiles/paymentMethodLinks"),
	// 	ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31/billingProfiles/ABC1-A1CD-AB1-BP1/paymentMethodLinks/ABCDABCDABC0"),
	// 	Properties: &armbilling.PaymentMethodLinkProperties{
	// 		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_visa_rect.png"),
	// 			},
	// 			{
	// 				MimeType: to.Ptr("image/svg+xml"),
	// 				URL: to.Ptr("https://contoso.com/staticresourceservice/images/v4/logo_visa.svg"),
	// 		}},
	// 		PaymentMethodID: to.Ptr("/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0"),
	// 		PaymentMethodType: to.Ptr("mc"),
	// 		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 Gets a payment method linked with a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
 *
 * @summary Gets a payment method linked with a billing profile. 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/paymentMethodsGetByBillingProfile.json
 */
async function paymentMethodsGetByBillingProfile() {
  const billingAccountName =
    "00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31";
  const billingProfileName = "ABC1-A1CD-AB1-BP1";
  const paymentMethodName = "ABCDABCDABC0";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.paymentMethods.getByBillingProfile(
    billingAccountName,
    billingProfileName,
    paymentMethodName,
  );
  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;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsGetByBillingProfile.json
// this example is just showing the usage of "PaymentMethods_GetByBillingProfile" 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 BillingProfileResource created on azure
// for more information of creating BillingProfileResource, please refer to the document of BillingProfileResource
string billingAccountName = "00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31";
string billingProfileName = "ABC1-A1CD-AB1-BP1";
ResourceIdentifier billingProfileResourceId = BillingProfileResource.CreateResourceIdentifier(billingAccountName, billingProfileName);
BillingProfileResource billingProfile = client.GetBillingProfileResource(billingProfileResourceId);

// get the collection of this BillingPaymentMethodLinkResource
BillingPaymentMethodLinkCollection collection = billingProfile.GetBillingPaymentMethodLinks();

// invoke the operation
string paymentMethodName = "ABCDABCDABC0";
NullableResponse<BillingPaymentMethodLinkResource> response = await collection.GetIfExistsAsync(paymentMethodName);
BillingPaymentMethodLinkResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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
    BillingPaymentMethodLinkData 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/billingAccounts/00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31/billingProfiles/ABC1-A1CD-AB1-BP1/paymentMethodLinks/ABCDABCDABC0",
  "name": "ABCDABCDABC0",
  "type": "Microsoft.Billing/billingAccounts/billingProfiles/paymentMethodLinks",
  "properties": {
    "paymentMethodId": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0",
    "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_visa_rect.png"
      },
      {
        "mimeType": "image/svg+xml",
        "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa.svg"
      }
    ],
    "status": "active"
  }
}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
paymentMethodFamily	Die Familie der Zahlungsmethode.
PaymentMethodLink	Eine Zahlungsmethoden-Verknüpfung.
PaymentMethodLogo	Logo der Zahlungsmethode.
PaymentMethodProperties	Die Eigenschaften einer Zahlungsmethode.
paymentMethodStatus	Status der Zahlungsmethode.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

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

ErrorDetail

Objekt

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

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

paymentMethodFamily

Enumeration

Die Familie der Zahlungsmethode.

Wert	Beschreibung
CheckWire
CreditCard
Credits
DirectDebit
EWallet
None
Other
TaskOrder

PaymentMethodLink

Objekt

Eine Zahlungsmethoden-Verknüpfung.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.accountHolderName	string	Der Kontoinhabername für die Zahlungsmethode. Dies wird nur für Zahlungsmethoden mit Family CreditCard unterstützt.
properties.displayName	string	Der Anzeigename der Zahlungsmethode.
properties.expiration	string	Der Ablaufmonat und das Jahr der Zahlungsmethode. Dies wird nur für Zahlungsmethoden mit Family CreditCard unterstützt.
properties.family	paymentMethodFamily	Die Familie der Zahlungsmethode.
properties.lastFourDigits	string	Letzte vier Ziffern der Zahlungsmethode.
properties.logos	PaymentMethodLogo[]	Die Liste der Logos für die Zahlungsmethode.
properties.paymentMethod	PaymentMethodProperties	Projektion einer Zahlungsmethode. Wird in diesen oder zukünftigen Versionen nicht zurückgegeben.
properties.paymentMethodId	string	ID der Zahlungsmethode. Beispiel: /providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0
properties.paymentMethodType	string	Die Art der Zahlungsmethode.
properties.status	paymentMethodStatus	Status der Zahlungsmethode.
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"

PaymentMethodLogo

Objekt

Logo der Zahlungsmethode.

Name	Typ	Beschreibung
mimeType	string	MIME-Typ des Logos.
url	string	Öffentliche URL des Bilds des Logos.

PaymentMethodProperties

Objekt

Die Eigenschaften einer Zahlungsmethode.

Name	Typ	Beschreibung
accountHolderName	string	Der Kontoinhabername für die Zahlungsmethode. Dies wird nur für Zahlungsmethoden mit Family CreditCard unterstützt.
displayName	string	Der Anzeigename der Zahlungsmethode.
expiration	string	Der Ablaufmonat und das Jahr der Zahlungsmethode. Dies wird nur für Zahlungsmethoden mit Family CreditCard unterstützt.
family	paymentMethodFamily	Die Familie der Zahlungsmethode.
id	string	ID der Zahlungsmethode.
lastFourDigits	string	Letzte vier Ziffern der Zahlungsmethode.
logos	PaymentMethodLogo[]	Die Liste der Logos für die Zahlungsmethode.
paymentMethodType	string	Die Art der Zahlungsmethode.
status	paymentMethodStatus	Status der Zahlungsmethode.

paymentMethodStatus

Enumeration

Status der Zahlungsmethode.

Wert	Beschreibung
active
inactive

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	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 (date-time)	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.