API penggunaan sumber daya penyedia
Penyedia istilah berlaku untuk administrator layanan dan penyedia yang didelegasikan. Operator Azure Stack Hub dan penyedia yang didelegasikan dapat menggunakan API penggunaan penyedia untuk melihat penggunaan penyewa langsungnya. Misalnya, seperti yang ditunjukkan pada diagram berikut, P0 dapat memanggil API penyedia untuk mendapatkan informasi penggunaan langsung pada P1 dan P2, dan P1 dapat memanggil informasi penggunaan pada P3 dan P4.
Referensi panggilan API
Minta
Permintaan mendapatkan detail konsumsi untuk langganan yang diminta dan untuk jangka waktu yang diminta. Tidak ada isi permintaan.
API penggunaan ini adalah API penyedia, sehingga penelepon harus diberi peran Pemilik, Kontributor, atau Pembaca dalam langganan penyedia.
| Metode | URI Permintaan |
|---|---|
| GET | https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&aggregationGranularity={granularity}&subscriberId={sub1.1}&api-version=2015-06-01-preview&continuationToken={token-value} |
Argumen
| Argumen | Deskripsi |
|---|---|
armendpoint |
Titik akhir Azure Resource Manager dari lingkungan Azure Stack Hub Anda. Konvensi Azure Stack Hub adalah bahwa nama titik akhir Azure Resource Manager dalam format https://adminmanagement.{domain-name}. Misalnya, untuk Azure Stack Development Kit (ASDK), jika nama domain adalah local.azurestack.external, maka titik akhir Resource Manager adalah https://adminmanagement.local.azurestack.external. |
subId |
ID Langganan pengguna yang melakukan panggilan. |
reportedStartTime |
Waktu mulai kueri. Nilai untuk DateTime harus dalam Waktu Universal Terkoordinasi (UTC) dan di awal jam; misalnya pukul 13.00. Untuk agregasi harian, atur nilai ini ke UTC tengah malam. Formatnya diberi tanda escape ISO 8601; misalnya, 2015-06-16T18%3a53%3a11%2b00%3a00Z, dengan titik dua diberi tanda escape ke %3a dan tanda plus diberi tanda escape ke %2b sehingga ramah-URI. |
reportedEndTime |
Waktu akhir kueri. Batasan yang berlaku untuk reportedStartTime juga berlaku untuk argumen ini. Nilai untuk reportedEndTime tidak boleh di masa mendatang, atau tanggal saat ini. Jika ya, hasilnya akan diatur ke "pemrosesan tidak selesai." |
aggregationGranularity |
Parameter opsional yang memiliki dua nilai potensial berbeda: harian dan per jam. Seperti yang disarankan oleh nilai, satu menampilkan data dalam granuralitas harian, dan yang lainnya adalah resolusi per jam. Opsi harian merupakan opsi default. |
subscriberId |
ID Langganan. Untuk mendapatkan data yang difilter, ID langganan penyewa langsung dari penyedia diperlukan. Jika tidak ada parameter ID langganan yang ditentukan, panggilan akan menampilkan data penggunaan untuk semua penyewa langsung penyedia. |
api-version |
Versi protokol yang digunakan untuk membuat permintaan ini. Nilai ini diatur menjadi 2015-06-01-preview. |
continuationToken |
Token diambil dari panggilan terakhir ke penyedia API penggunaan. Token ini diperlukan ketika respons lebih dari 1.000 baris. Hal ini bertindak sebagai marka buku untuk kemajuan. Jika token tidak ada, data diambil dari awal hari atau jam, berdasarkan granuralitas yang diteruskan. |
Respons
GET
/subscriptions/sub1/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime=reportedStartTime=2014-05-01T00%3a00%3a00%2b00%3a00&reportedEndTime=2015-06-01T00%3a00%3a00%2b00%3a00&aggregationGranularity=Daily&subscriberId=sub1.1&api-version=1.0
{
"value": [
{
"id":
"/subscriptions/sub1.1/providers/Microsoft.Commerce.Admin/UsageAggregate/sub1.1-
meterID1",
"name": "sub1.1-meterID1",
"type": "Microsoft.Commerce.Admin/UsageAggregate",
"properties": {
"subscriptionId":"sub1.1",
"usageStartTime": "2015-03-03T00:00:00+00:00",
"usageEndTime": "2015-03-04T00:00:00+00:00",
"instanceData":"{\"Microsoft.Resources\":{\"resourceUri\":\"resourceUri1\",\"location\":\"Alaska\",\"tags\":null,\"additionalInfo\":null}}",
"quantity":2.4000000000,
"meterId":"meterID1"
}
},
. . .
Detail tanggapan
| Argumen | Deskripsi |
|---|---|
id |
ID unik dari agregat penggunaan. |
name |
Nama agregat penggunaan. |
type |
Definisi sumber daya. |
subscriptionId |
Pengidentifikasi langganan pengguna Azure Stack Hub. |
usageStartTime |
Waktu mulai UTC dari wadah penggunaan tempat agregat penggunaan ini berada. |
usageEndTime |
Waktu berakhir UTC dari wadah penggunaan tempat agregat penggunaan ini berada. |
instanceData |
Pasangan kunci nilai detail instans (dalam format baru):resourceUri: ID sumber daya yang sepenuhnya memenuhi syarat, yang menyertakan grup sumber daya dan nama instans. location: Wilayah tempat layanan ini dijalankan. tags: Tag sumber daya yang ditentukan oleh pengguna. additionalInfo: Detail selengkapnya tentang sumber daya yang digunakan; misalnya, versi OS atau jenis gambar. |
quantity |
Jumlah konsumsi sumber daya yang terjadi dalam jangka waktu ini. |
meterId |
ID unik untuk sumber daya yang digunakan (juga disebut ResourceID). |
Mengambil informasi penggunaan
PowerShell
Untuk menghasilkan data penggunaan, Anda harus memiliki sumber daya yang berjalan dan secara aktif menggunakan sistem; misalnya, mesin virtual (VM) aktif, atau akun penyimpanan yang berisi beberapa data. Jika tidak yakin apakah Anda memiliki sumber daya yang berjalan di Marketplace Azure Stack Hub, sebarkan VM dan verifikasi bilah pemantauan VM untuk memastikannya berjalan. Gunakan cmdlet PowerShell berikut untuk melihat data penggunaan:
Konfigurasikan pengguna Azure Stack Hub atau lingkungan PowerShell operator Azure Stack Hub.
Untuk mengambil data penggunaan, panggil cmdlet PowerShell Get-AzsSubscriberUsage:
Get-AzsSubscriberUsage -ReportedStartTime "2017-09-06T00:00:00Z" -ReportedEndTime "2017-09-07T00:00:00Z"
REST API
Anda dapat mengumpulkan informasi penggunaan untuk langganan yang dihapus dengan menghubungi layanan Microsoft.Commerce.Admin.
Mengembalikan semua penggunaan penyewa untuk dihapus bagi pengguna aktif
| Metode | URI Permintaan |
|---|---|
| GET | https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&api-version=2015-06-01-preview |
Mengembalikan penggunaan untuk penyewa yang dihapus atau aktif
| Metode | URI Permintaan |
|---|---|
| GET | https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&subscriberId={subscriber-id}&api-version=2015-06-01-preview |