Sağlayıcı kaynak kullanım API’siProvider resource usage API

Sağlayıcı terimi, hizmet yöneticisi ve tüm temsilci sağlayıcılar için geçerlidir.The term provider applies to the service administrator and to any delegated providers. Azure Stack hub işleçleri ve Temsilcili sağlayıcılar, doğrudan kiracılarının kullanımını görüntülemek için sağlayıcı kullanım API 'sini kullanabilir.Azure Stack Hub operators and delegated providers can use the provider usage API to view the usage of their direct tenants. Örneğin, aşağıdaki diyagramda gösterildiği gibi, P0, P1 ve P2 üzerinde doğrudan kullanım bilgilerini almak için sağlayıcı API 'sini çağırabilir ve P1, P3 ve P4 üzerinde kullanım bilgilerini çağırabilir.For example, as shown in the following diagram, P0 can call the provider API to get direct usage information on P1 and P2, and P1 can call for usage information on P3 and P4.

Sağlayıcı hiyerarşisinin kavramsal modeli

API çağrısı başvurusuAPI call reference

İstekRequest

İstek, istenen abonelikler ve istenen zaman dilimi için tüketim ayrıntılarını alır.The request gets consumption details for the requested subscriptions and for the requested time frame. İstek gövdesi yok.There's no request body.

Bu kullanım API 'si bir sağlayıcı API 'sidir, bu nedenle çağıranın sağlayıcının aboneliğine bir sahip, katkıda bulunan veya okuyucu rolü atanması gerekir.This usage API is a provider API, so the caller must be assigned an Owner, Contributor, or Reader role in the provider's subscription.

YöntemMethod İstek URI'siRequest URI
GETGET 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}

Bağımsız değişkenlerArguments

Bağımsız DeğişkenArgument AçıklamaDescription
armendpoint Azure Stack hub ortamınızın uç noktası Azure Resource Manager.Azure Resource Manager endpoint of your Azure Stack Hub environment. Azure Stack hub kuralı, Azure Resource Manager uç noktasının adının biçimde olması olur https://adminmanagement.{domain-name} .The Azure Stack Hub convention is that the name of the Azure Resource Manager endpoint is in the format https://adminmanagement.{domain-name}. Örneğin, Azure Stack Geliştirme Seti (ASDK) için, etki alanı adı yerel. azurestack. external ise Kaynak Yöneticisi uç noktası olur https://adminmanagement.local.azurestack.external .For example, for the Azure Stack Development Kit (ASDK), if the domain name is local.azurestack.external, then the Resource Manager endpoint is https://adminmanagement.local.azurestack.external.
subId Çağrıyı yapan kullanıcının abonelik KIMLIĞI.Subscription ID of the user who makes the call.
reportedStartTime Sorgunun başlangıç saati.Start time of the query. Değeri DateTime Eşgüdümlü Evrensel Saat (UTC) ve saatin başında olmalıdır; örneğin, 13:00.The value for DateTime should be in Coordinated Universal Time (UTC) and at the beginning of the hour; for example, 13:00. Günlük toplama için bu değeri UTC gece yarısı olarak ayarlayın.For daily aggregation, set this value to UTC midnight. Biçim kaçışdır ISO 8601; Örneğin, 2015-06-16T18%3a53%3a11%2b00%3a00Z iki nokta üst üste atlatın, %3a ve, URI kullanımı için kaçışın %2b .The format is escaped ISO 8601; for example, 2015-06-16T18%3a53%3a11%2b00%3a00Z, where the colon is escaped to %3a and the plus is escaped to %2b so that it's URI-friendly.
reportedEndTime Sorgunun bitiş saati.End time of the query. İçin uygulanan kısıtlamalar reportedStartTime Bu bağımsız değişken için de geçerlidir.The constraints that apply to reportedStartTime also apply to this argument. Değeri reportedEndTime gelecekte veya geçerli tarih olamaz.The value for reportedEndTime can't be either in the future, or the current date. Bu ise, sonuç "işlem tamamlanamadı" olarak ayarlanır.If it is, the result is set to "processing not complete."
aggregationGranularity İki ayrı olası değeri olan isteğe bağlı parametre: günlük ve saatlik.Optional parameter that has two discrete potential values: daily and hourly. Değerler önereceği için, biri günlük ayrıntı düzeyi halinde verileri döndürür ve diğeri saatlik bir çözünürlüğlük olur.As the values suggest, one returns the data in daily granularity, and the other is an hourly resolution. Günlük seçeneği varsayılandır.The daily option is the default.
subscriberId Abonelik KIMLIĞI.Subscription ID. Filtrelenmiş verileri almak için, sağlayıcının doğrudan kiracının abonelik KIMLIĞI gereklidir.To get filtered data, the subscription ID of a direct tenant of the provider is required. Abonelik KIMLIĞI parametresi belirtilmemişse, çağrı tüm sağlayıcının doğrudan kiracılarının kullanım verilerini döndürür.If no subscription ID parameter is specified, the call returns usage data for all the provider's direct tenants.
api-version Bu isteği yapmak için kullanılan protokolün sürümü.Version of the protocol that's used to make this request. Bu değer olarak ayarlanır 2015-06-01-preview .This value is set to 2015-06-01-preview.
continuationToken Son çağrıdan kullanım API sağlayıcısına alınan belirteç.Token retrieved from the last call to the usage API provider. Yanıt 1.000 satırdan fazla olduğunda bu belirteç gereklidir.This token is needed when a response is greater than 1,000 lines. İlerleme için bir yer işareti görevi görür.It acts as a bookmark for the progress. Belirteç yoksa, veri, geçirilen ayrıntı düzeyi temel alınarak günün veya saatin başından alınır.If the token isn't present, the data is retrieved from the beginning of the day or hour, based on the granularity passed in.

YanıtResponse

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"

}
},

. . .

Yanıt ayrıntılarıResponse details

Bağımsız DeğişkenArgument AçıklamaDescription
id Kullanım toplamanın benzersiz KIMLIĞI.Unique ID of the usage aggregate.
name Kullanım toplamanın adı.Name of the usage aggregate.
type Kaynak tanımı.Resource definition.
subscriptionId Azure Stack hub kullanıcısının abonelik tanımlayıcısı.Subscription identifier of the Azure Stack Hub user.
usageStartTime Bu kullanım toplamasının ait olduğu kullanım demetini 'nin UTC başlangıç saati.UTC start time of the usage bucket to which this usage aggregate belongs.
usageEndTime Bu kullanım toplamasının ait olduğu kullanım demetini 'nin UTC bitiş saati.UTC end time of the usage bucket to which this usage aggregate belongs.
instanceData Örnek ayrıntılarının anahtar-değer çiftleri (yeni bir biçimde):Key-value pairs of instance details (in a new format):
resourceUri: Kaynak gruplarını ve örnek adını içeren tam nitelikli kaynak KIMLIĞI.resourceUri: Fully qualified resource ID, which includes the resource groups and the instance name.
location: Bu hizmetin çalıştırıldığı bölge.location: Region in which this service was run.
tags: Kullanıcı tarafından belirtilen kaynak etiketleri.tags: Resource tags that are specified by the user.
additionalInfo: Tüketilen kaynakla ilgili daha fazla ayrıntı; Örneğin, işletim sistemi sürümü veya görüntü türü.additionalInfo: More details about the resource that was consumed; for example, the OS version or image type.
quantity Bu zaman çerçevesinde gerçekleşen kaynak tüketimi miktarı.Amount of resource consumption that occurred in this time frame.
meterId Tüketilen kaynağın benzersiz KIMLIĞI (Ayrıca denir ResourceID ).Unique ID for the resource that was consumed (also called ResourceID).

Kullanım bilgilerini alRetrieve usage information

PowerShellPowerShell

Kullanım verilerini oluşturmak için, çalıştıran ve sistemi etkin bir şekilde kullanan kaynaklarınız olmalıdır; Örneğin, etkin bir sanal makine (VM) veya bazı verileri içeren bir depolama hesabıdır.To generate the usage data, you should have resources that are running and actively using the system; for example, an active virtual machine (VM), or a storage account containing some data. Azure Stack hub marketi 'nde çalışan bir kaynağınız olup olmadığından emin değilseniz, bir VM dağıtın ve çalıştığından emin olmak için VM izleme dikey penceresini doğrulayın.If you're not sure whether you have any resources running in the Azure Stack Hub Marketplace, deploy a VM, and verify the VM monitoring blade to make sure it's running. Kullanım verilerini görüntülemek için aşağıdaki PowerShell cmdlet 'lerini kullanın:Use the following PowerShell cmdlets to view the usage data:

  1. Azure Stack hub 'ı Için PowerShell 'ı yükler.Install PowerShell for Azure Stack Hub.

  2. Azure Stack hub kullanıcısını veya Azure Stack hub Işleci PowerShell ortamını yapılandırın.Configure the Azure Stack Hub user or the Azure Stack Hub operator PowerShell environment.

  3. Kullanım verilerini almak için Get-AzsSubscriberUsage PowerShell cmdlet 'ini çağırın:To retrieve the usage data, call the Get-AzsSubscriberUsage PowerShell cmdlet:

    Get-AzsSubscriberUsage -ReportedStartTime "2017-09-06T00:00:00Z" -ReportedEndTime "2017-09-07T00:00:00Z"
    

REST APIREST API

Silinen abonelikler için kullanım bilgilerini Microsoft. Commerce. admin hizmetini çağırarak toplayabilirsiniz.You can collect usage information for deleted subscriptions by calling the Microsoft.Commerce.Admin service.

Etkin kullanıcılar için silinen tüm Kiracı kullanımını döndürReturn all tenant usage for deleted for active users

YöntemMethod İstek URI'siRequest URI
GETGET https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&api-version=2015-06-01-preview

Silinen veya etkin kiracı için kullanım dönüşüReturn usage for deleted or active tenant

YöntemMethod İstek URI'siRequest URI
GETGET 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

Sonraki adımlarNext steps