Freigeben über


Customers - List By Billing Profile

Listet die Kunden auf, die einem Abrechnungsprofil in Rechnung gestellt werden. 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?api-version=2024-04-01
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers?api-version=2024-04-01&expand={expand}&filter={filter}&orderBy={orderBy}&top={top}&skip={skip}&count={count}&search={search}

URI-Parameter

Name In Erforderlich Typ Beschreibung
billingAccountName
path True

string

Die ID, die ein Abrechnungskonto eindeutig identifiziert.

RegEx-Muster: ^([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})?)$

billingProfileName
path True

string

Die ID, die ein Abrechnungsprofil eindeutig identifiziert.

RegEx-Muster: ^[a-zA-Z\d-_]{1,128}$

api-version
query True

string

Die Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2024-04-01.

count
query

boolean

Mit der Abfrageoption "Anzahl" können Clients eine Anzahl der übereinstimmenden Ressourcen anfordern, die in der Antwort enthalten sind.

expand
query

string

Kann verwendet werden, um enabledAzurePlans und Reseller zu erweitern

filter
query

string

Mit der Filterabfrageoption können Clients eine Sammlung von Ressourcen filtern, die von einer Anforderungs-URL adressiert werden.

orderBy
query

string

Mit der Option "Orderby-Abfrage" können Clients Ressourcen in einer bestimmten Reihenfolge anfordern.

search
query

string

Mit der Suchabfrageoption können Clients Elemente innerhalb einer Sammlung anfordern, die einem Freitext-Suchausdruck entsprechen. Die Suche wird nur für Zeichenfolgenfelder unterstützt.

skip
query

integer

int64

Die Option "Abfrage überspringen" fordert die Anzahl der Elemente in der abgefragten Auflistung an, die übersprungen und nicht in das Ergebnis einbezogen werden sollen.

top
query

integer

int64

Die oberste Abfrageoption fordert die Anzahl der Elemente in der abgefragten Auflistung an, in das Ergebnis eingeschlossen zu werden. Der maximal unterstützte Wert für top ist 50.

Antworten

Name Typ Beschreibung
200 OK

CustomerListResult

Eine Liste der Kunden.

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

CustomersListByBillingProfile

Beispielanforderung

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

Beispiel für eine Antwort

{
  "value": [
    {
      "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",
        "tags": {
          "pcCode": "A123456",
          "costCategory": "Support"
        }
      },
      "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/22222222-2222-2222-2222-222222222222",
      "name": "22222222-2222-2222-2222-222222222222",
      "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": "customer2",
        "systemId": "zzzz-zzzz-zzz-zzz",
        "status": "Active"
      },
      "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.

CustomerListResult

Ein Container für eine Liste von Ressourcen

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

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

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

Customer

Der Kunde eines Partners.

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

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"

CustomerListResult

Ein Container für eine Liste von Ressourcen

Name Typ Beschreibung
nextLink

string

Der Link (URL) zur nächsten Seite der Ergebnisse.

value

Customer[]

Die Liste der Ressourcen.

CustomerProperties

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

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

Name Typ Beschreibung
Active

string

Deleted

string

Disabled

string

Other

string

Pending

string

UnderReview

string

Warned

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.

Reseller

Details des Händlers.

Name Typ Beschreibung
description

string

Der Name des Händlers.

resellerId

string

Die MPN-ID des Händlers.

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.