API Utilisation des ressources de fournisseur
Le terme fournisseur s’applique à l’administrateur de services et à tous les fournisseurs délégués. Les opérateurs et fournisseurs délégués Azure Stack Hub peuvent se servir de l’API d’utilisation du fournisseur pour voir l’utilisation de leurs locataires directs. Par exemple, comme indiqué dans le diagramme, P0 peut appeler l’API du fournisseur pour obtenir des informations d’utilisation directes sur P1 et P2, et P1 peut demander des informations d’utilisation sur P3 et P4.
Référence de l’appel d’API
Requête
La requête obtient les détails de la consommation pour les abonnements demandés et pour la période demandée. Il n’existe aucun corps de demande.
Cette API d’utilisation étant une API de fournisseur, un rôle Propriétaire, Collaborateur ou Lecteur doit être affecté à l’appelant dans l’abonnement du fournisseur.
| Méthode | URI de demande |
|---|---|
| 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} |
Arguments
| Argument | Description |
|---|---|
armendpoint |
Point de terminaison Azure Resource Manager de votre environnement Azure Stack Hub. Par convention, dans l’infrastructure Azure Stack Hub, le nom du point de terminaison Azure Resource Manager est au format https://adminmanagement.{domain-name}. Par exemple, pour le Kit de développement Azure Stack (ASDK), si le nom de domaine est local.azurestack.external, le point de terminaison Resource Manager est https://adminmanagement.local.azurestack.external. |
subId |
ID d’abonnement de l’utilisateur qui effectue l’appel. |
reportedStartTime |
Heure de début de la requête. La valeur de DateTime doit être exprimée en temps universel coordonné (UTC) et indiquer le début de l’heure ; par exemple, 13:00. Pour l’agrégation quotidienne, définissez cette valeur sur minuit au format UTC. Le format fait l’objet de séquences d’échappement ISO 8601. Par exemple, dans 2015-06-16T18%3a53%3a11%2b00%3a00Z, le signe deux-points est remplacé par la séquence d’échappement %3a et le signe plus est remplacé par la séquence d’échappement %2b pour que la chaîne soit compatible avec le format des URI. |
reportedEndTime |
Heure de fin de la requête. Les contraintes qui s’appliquent à reportedStartTime s’appliquent également à cet argument. La valeur de reportedEndTime ne peut pas être la date actuelle ou une date future. Dans ce cas, le résultat a la valeur « traitement non terminé ». |
aggregationGranularity |
Paramètre facultatif qui peut prendre deux valeurs : daily et hourly. Comme le suggèrent les valeurs, l’une retourne les données avec une granularité journalière, et l’autre est une résolution horaire. L’option daily est la valeur par défaut. |
subscriberId |
l'ID d'abonnement. Pour obtenir des données filtrées, l’ID d’abonnement d’un locataire direct du fournisseur est exigé. Si aucun paramètre d’ID d’abonnement n’est spécifié, l’appel retourne les données d’utilisation pour tous les locataires directs du fournisseur. |
api-version |
Version du protocole utilisé pour effectuer cette requête. Cette valeur est définie sur 2015-06-01-preview. |
continuationToken |
Jeton récupéré à partir du dernier appel au fournisseur d’API d’utilisation. Ce jeton est nécessaire quand une réponse compte plus de 1 000 lignes. Il agit comme un signet pour indiquer la progression. En l’absence du jeton, les données sont récupérées à partir du début de la journée ou de l’heure, en fonction de la précision passée. |
response
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"
}
},
. . .
Détails de la réponse
| Argument | Description |
|---|---|
id |
ID unique de l’agrégat d’utilisation. |
name |
Nom de l’agrégat d’utilisation. |
type |
Définition de la ressource. |
subscriptionId |
Identificateur d’abonnement de l’utilisateur Azure Stack Hub. |
usageStartTime |
Heure de début, au format UTC, du compartiment d’utilisation auquel appartient cet agrégat d’utilisation. |
usageEndTime |
Heure de fin, au format UTC, du compartiment d’utilisation auquel appartient cet agrégat d’utilisation. |
instanceData |
Paires clé-valeur des détails de l’instance (dans un nouveau format) :resourceUri : ID de ressource complet, qui inclut les groupes de ressources et le nom de l'instance. location : région dans laquelle ce service a été exécuté. tags : balises de ressources spécifiées par l'utilisateur. additionalInfo : informations supplémentaires sur la ressource consommée, par exemple, la version du système d’exploitation ou le type d’image. |
quantity |
Quantité de ressources consommées au cours de cette période. |
meterId |
ID unique de la ressource consommée (également appelé ResourceID). |
Récupérer les informations sur l’utilisation
PowerShell
Pour générer les données d’utilisation, vous devez disposer de ressources en cours d’exécution qui utilisent activement le système, par exemple une machine virtuelle active ou un compte de stockage contenant des données. Si vous n’êtes pas certain de disposer de ressources en cours d’exécution sur la Place de marché Azure Stack Hub, déployez une machine virtuelle, puis consultez son panneau de supervision pour vérifier qu’elle est en cours d’exécution. Pour afficher les données d’utilisation, utilisez les cmdlets PowerShell suivantes :
Configurez l’environnement PowerShell Utilisateur d’Azure Stack Hub ou Opérateur d’Azure Stack Hub.
Pour récupérer les données d’utilisation, appelez l’applet de commande PowerShell Get-AzsSubscriberUsage :
Get-AzsSubscriberUsage -ReportedStartTime "2017-09-06T00:00:00Z" -ReportedEndTime "2017-09-07T00:00:00Z"
API REST
Vous pouvez collecter des informations sur l’utilisation des abonnements supprimés en appelant le service Microsoft.Commerce.Admin.
Retourner toute l’utilisation du locataire pour les utilisateurs actifs
| Méthode | URI de demande |
|---|---|
| GET | https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&api-version=2015-06-01-preview |
Retourner l’utilisation pour un locataire supprimé ou actif
| Méthode | URI de demande |
|---|---|
| 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 |