Pobieranie podsumowania użycia dla subskrypcji klienta
Dotyczy: Centrum partnerskie | Centrum partnerskie dla Microsoft Cloud for US Government
Możesz użyć zasobu SubscriptionUsageSummary , aby uzyskać podsumowanie użycia subskrypcji dla klienta. Ten zasób reprezentuje podsumowanie użycia subskrypcji określonej usługi lub zasobu platformy Azure w bieżącym okresie rozliczeniowym.
Wymagania wstępne
Poświadczenia zgodnie z opisem w temacie Uwierzytelnianie w Centrum partnerskim. Ten scenariusz obsługuje uwierzytelnianie tylko przy użyciu poświadczeń użytkownika i aplikacji.
Identyfikator klienta (
customer-tenant-id
). Jeśli nie znasz identyfikatora klienta, możesz wyszukać go w Centrum partnerskim , wybierając obszar roboczy Klienci , a następnie klienta z listy klienta, a następnie pozycję Konto. Na stronie Konto klienta poszukaj identyfikatora Microsoft w sekcji Informacje o koncie klienta . Identyfikator Microsoft jest taki sam jak identyfikator klienta (customer-tenant-id
).Identyfikator subskrypcji
C#
Aby uzyskać podsumowanie użycia subskrypcji dla subskrypcji klienta:
Użyj kolekcji IAggregatePartner.Customers, aby wywołać metodę ById().
Następnie wywołaj właściwość Subscriptions i właściwość UsageSummary . Zakończ, wywołując metody Get() lub GetAsync().
// IAggregatePartner partnerOperations; // var selectedCustomerId as string; // var selectedSubscriptionId as string; var subscriptionUsageSummary = partnerOperations.Customers.ById(selectedCustomerId).Subscriptions.ById(selectedSubscriptionId).UsageSummary.Get();
Aby zapoznać się z przykładem, zobacz następujące kwestie:
- Przykład: aplikacja testowa konsoli
- Projekt: PartnerSDK.FeatureSamples
- Klasa: GetSubscriptionUsageSummary.cs
Żądanie REST
Składnia żądania
Metoda | Identyfikator URI żądania |
---|---|
GET | {baseURL}/v1/customers/{customer-tenant-id}/subscriptions/{subscription-id}/usagesummary HTTP/1.1 |
Parametry identyfikatora URI
W tej tabeli wymieniono wymagane parametry zapytania, aby uzyskać informacje o użyciu oceniane przez klienta.
Nazwa | Typ | Wymagane | Opis |
---|---|---|---|
customer-tenant-id | Identyfikator guid | Y | Identyfikator GUID odpowiadający klientowi. |
identyfikator subskrypcji | Identyfikator guid | Y | Identyfikator GUID odpowiadający identyfikatorowi subskrypcji. W przypadku planu platformy Azure jest to identyfikator odpowiedniego zasobu subskrypcji Centrum partnerskiego, który reprezentuje plan platformy Azure. W przypadku zasobów subskrypcji planu platformy Azure podaj identyfikator planu jako identyfikator subskrypcji w tej trasie. |
Nagłówki żądań
Aby uzyskać więcej informacji, zobacz Nagłówki REST Centrum partnerskiego.
Treść żądania
Brak.
Przykład żądania
GET https://api.partnercenter.microsoft.com/v1/customers/{customer-tenant-id}/subscriptions/{subscription-id}/usagesummary HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: e128c8e2-4c33-4940-a3e2-2e59b0abdc67
MS-CorrelationId: 47c36033-af5d-4457-80a4-512c1626fac4
Odpowiedź REST
W przypadku powodzenia ta metoda zwraca zasób SubscriptionUsageSummary w treści odpowiedzi.
Kody powodzenia i błędów odpowiedzi
Każda odpowiedź zawiera kod stanu HTTP, który wskazuje powodzenie lub niepowodzenie oraz dodatkowe informacje o debugowaniu. Użyj narzędzia do śledzenia sieci, aby odczytać ten kod, typ błędu i dodatkowe parametry. Aby uzyskać pełną listę, zobacz Kody błędów.
Przykład odpowiedzi dla subskrypcji platformy Microsoft Azure (MS-AZR-0145P)
W tym przykładzie klient kupił ofertę 145P platformy Azure PayG .
W przypadku klientów z subskrypcjami platformy Microsoft Azure (MS-AZR-0145P) nie będzie żadnych zmian w odpowiedzi interfejsu API.
HTTP/1.1 200 OK
Content-Length: 1120
Content-Type: application/json
MS-CorrelationId: 47c36033-af5d-4457-80a4-512c1626fac4
MS-RequestId: e128c8e2-4c33-4940-a3e2-2e59b0abdc67
Date: Tue, 17 Sep 2019 20:31:45 GMT
{
"resourceId": "ABCDEFGH-F347-41B6-B02C-187B1B778A43",
"id": "ABCDEFGH-F347-41B6-B02C-187B1B778A43",
"resourceName": "Microsoft Azure",
"name": "Microsoft Azure",
"billingStartDate": "2019-08-28T00:00:00-07:00",
"billingEndDate": "2019-09-27T00:00:00-07:00",
"totalCost": 22.861172,
"currencyLocale": "fr-FR",
"lastModifiedDate": "2019-09-01T23:04:41.193+00:00",
"links": {
"self": {
"uri": "/customers/<customer-tenant-id>/subscriptions/<subscription-id>/usagesummary",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "SubscriptionUsageSummary"
}
}
Przykład odpowiedzi REST dla planu platformy Azure
W tym przykładzie klient kupił plan platformy Azure.
W przypadku klientów z planami platformy Azure istnieją następujące zmiany odpowiedzi interfejsu API:
- currencyLocale jest zastępowany wartością currencyCode
- UsdTotalCost to nowe pole
HTTP/1.1 200 OK
Content-Length: 1120
Content-Type: application/json
MS-CorrelationId: 47c36033-af5d-4457-80a4-512c1626fac1
MS-RequestId: e128c8e2-4c33-4940-a3e2-2e59b0abdc67
Date: Tue, 17 Sep 2019 20:31:45 GMT
{
"resourceId": "11111111-dca5-6f31-d3a6-dbbfad9be0fc",
"resourceName": "Azure plan",
"billingStartDate": "2019-09-01T00:00:00+00:00",
"billingEndDate": "2019-10-01T00:00:00+00:00",
"totalCost": 28.82860766744404945074,
"currencyCode": "GBP",
"usdTotalCost": 35.23000000000000362337,
"lastModifiedDate": "2019-09-18T17:09:26.16+00:00",
"links": {
"self": {
"uri": "/customers/<customer-tenant-id>/subscriptions/<subscription-id>/usagesummary",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "SubscriptionUsageSummary"
}
}