Customers - Get

Dienst:

Billing

API-Version:

2024-04-01

Ruft einen Kunden anhand seiner ID ab. Der Vorgang wird nur für Abrechnungskonten mit dem Vertragstyp Microsoft Partner Agreement unterstützt.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
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})?)$	Die ID, die ein Abrechnungskonto eindeutig identifiziert.
billingProfileName	path	True	string pattern: ^[a-zA-Z\d-_]{1,128}$	Die ID, die ein Abrechnungsprofil eindeutig identifiziert.
customerName	path	True	string pattern: ^[a-zA-Z\d-_]{1,128}$	Die ID, die einen Kunden 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	Customer	Der Kunde eines Partners.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

CustomersGet

Beispielanforderung

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111?api-version=2024-04-01

Java

/**
 * Samples for Customers Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersGet.json
     */
    /**
     * Sample code: CustomersGet.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void customersGet(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.customers().getWithResponse(
            "00000000-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 customers_get.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.customers.get(
        billing_account_name="00000000-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",
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersGet.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/customersGet.json
func ExampleCustomersClient_Get() {
	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.NewCustomersClient().Get(ctx, "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "xxxx-xxxx-xxx-xxx", "11111111-1111-1111-1111-111111111111", 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.Customer = armbilling.Customer{
	// 	Name: to.Ptr("11111111-1111-1111-1111-111111111111"),
	// 	Type: to.Ptr("Microsoft.Billing/billingAccounts/billingProfiles/customers"),
	// 	ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111"),
	// 	Properties: &armbilling.CustomerProperties{
	// 		BillingProfileDisplayName: to.Ptr("Contoso Operations Billing"),
	// 		BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx"),
	// 		DisplayName: to.Ptr("customer1"),
	// 		EnabledAzurePlans: []*armbilling.AzurePlan{
	// 			{
	// 				SKUDescription: to.Ptr("Microsoft Azure Plan for DevTest"),
	// 				SKUID: to.Ptr("0002"),
	// 		}},
	// 		Resellers: []*armbilling.Reseller{
	// 			{
	// 				Description: to.Ptr("Reseller1"),
	// 				ResellerID: to.Ptr("89e87bdf-a2a2-4687-925f-4c18b27bccfd"),
	// 			},
	// 			{
	// 				Description: to.Ptr("Reseller2"),
	// 				ResellerID: to.Ptr("3b65b5a8-bd4f-4084-90e9-e1bd667a2b19"),
	// 		}},
	// 		Status: to.Ptr(armbilling.CustomerStatusActive),
	// 		SystemID: to.Ptr("yyyy-yyyy-yyy-yyy"),
	// 		Tags: map[string]*string{
	// 			"costCategory": to.Ptr("Support"),
	// 			"pcCode": to.Ptr("A123456"),
	// 		},
	// 	},
	// }
}

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 customer by its ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
 *
 * @summary Gets a customer by its ID. 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/customersGet.json
 */
async function customersGet() {
  const billingAccountName =
    "00000000-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 result = await client.customers.get(billingAccountName, billingProfileName, customerName);
  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/customersGet.json
// this example is just showing the usage of "Customers_Get" 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 = "00000000-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);

// invoke the operation
BillingProfileCustomerResource result = await billingProfileCustomer.GetAsync();

// 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
BillingCustomerData 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-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111",
  "name": "11111111-1111-1111-1111-111111111111",
  "properties": {
    "billingProfileDisplayName": "Contoso Operations Billing",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx",
    "displayName": "customer1",
    "systemId": "yyyy-yyyy-yyy-yyy",
    "status": "Active",
    "enabledAzurePlans": [
      {
        "skuId": "0002",
        "skuDescription": "Microsoft Azure Plan for DevTest"
      }
    ],
    "resellers": [
      {
        "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd",
        "description": "Reseller1"
      },
      {
        "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19",
        "description": "Reseller2"
      }
    ],
    "tags": {
      "pcCode": "A123456",
      "costCategory": "Support"
    }
  },
  "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers"
}

Definitionen

Name	Beschreibung
AzurePlan	Details zum Azure-Plan.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
Customer	Der Kunde eines Partners.
CustomerProperties	Der Kunde eines Partners.
CustomerStatus	Gibt den Status eines Kunden an. Dies ist eine bevorstehende Eigenschaft, die in Zukunft aufgefüllt wird.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
Reseller	Details des Händlers.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

AzurePlan

Objekt

Details zum Azure-Plan.

Name	Typ	Beschreibung
productId	string	Die ID, die ein Produkt eindeutig identifiziert.
skuDescription	string	Die Sku-Beschreibung.
skuId	string	Die ID, die eine Sku eindeutig identifiziert.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

Customer

Objekt

Der Kunde eines Partners.

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	CustomerProperties	Der Kunde eines Partners.
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"

CustomerProperties

Objekt

Der Kunde eines Partners.

Name	Typ	Beschreibung
billingProfileDisplayName	string	Der Name des Abrechnungsprofils.
billingProfileId	string	Die vollqualifizierte ID, die ein Abrechnungsprofil eindeutig identifiziert.
displayName	string	Der Name des Kunden.
enabledAzurePlans	AzurePlan[]	Azure-Pläne für den Kunden aktiviert.
resellers	Reseller[]	Die Liste der Wiederverkäufer, für die ein Azure-Plan für den Kunden aktiviert ist.
status	CustomerStatus	Gibt den Status eines Kunden an. Dies ist eine bevorstehende Eigenschaft, die in Zukunft aufgefüllt wird.
systemId	string	Das System hat einen eindeutigen Bezeichner für einen Kunden generiert.
tags	object	Wörterbuch der Metadaten, die der Ressource zugeordnet sind. 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? /

CustomerStatus

Enumeration

Gibt den Status eines Kunden an. Dies ist eine bevorstehende Eigenschaft, die in Zukunft aufgefüllt wird.

Wert	Beschreibung
Active
Deleted
Disabled
Other
Pending
UnderReview
Warned

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.

Reseller

Objekt

Details des Händlers.

Name	Typ	Beschreibung
description	string	Der Name des Händlers.
resellerId	string	Die MPN-ID des Händlers.

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.