Récupérer un module complémentaire (module complémentaire locataire)
S’applique à : Windows Azure Pack
Récupère un module complémentaire.
Requête
Remplacez <ServiceMgmt par> votre adresse de point de terminaison de l’API Gestion des services. Remplacez <AddonId> par l’identificateur de module complémentaire du module complémentaire.
Méthode |
URI de demande |
Version HTTP |
|---|---|---|
GET |
<https:// ServiceMgmt> :30005/addons/<AddonId> |
HTTP/1.1 |
Paramètres URI
Aucun.
En-têtes de requête
Le tableau suivant décrit les en-têtes de demande obligatoires ou facultatifs.
En-tête de requête |
Description |
|---|---|
Autorisation : Porteur |
Obligatoire. Jeton du porteur d’autorisation. |
x-ms-principal-id |
Obligatoire. Identificateur du principal. |
x-ms-client-request-id |
facultatif. Identificateur de la demande cliente. |
x-ms-client-session-id |
facultatif. Identificateur de session client. |
x-ms-principal-liveid |
facultatif. Identificateur live principal. |
Corps de la demande
Le tableau suivant décrit les éléments du corps de la demande.
Nom de l'élément |
Description |
|---|---|
includePrice |
facultatif. Le prix inclus du module complémentaire. |
region |
facultatif. Région du module complémentaire. |
subscriptionId |
facultatif. Identificateur de l’abonnement. |
username |
facultatif. Nom d’utilisateur du module complémentaire. |
Il existe 4 options d’appel. Si une autre combinaison d’options est utilisée, l’opération n’aura pas de corps de requête.
Option |
Condition requise |
|---|---|
AddonID dans l’URI appelant uniquement |
Aucun corps de requête. |
includeprice, region, username & SubscriptionId. |
Nom d’utilisateur et subscriptionId fournis. |
Includeprice, région & nom d’utilisateur |
Nom d’utilisateur fourni. |
includeprice, region et subscriptionId |
SubscriptionId fourni. |
response
La réponse inclut un code d'état HTTP, un ensemble d'en-têtes de réponse et un corps de réponse.
Code d’état
Une opération réussie envoie le code d'état 200 (OK).
Pour plus d’informations sur les codes status, consultez Codes d’état et d’erreur (Gestion des services Windows Azure Pack).
En-têtes de réponse
La réponse à cette opération inclut des en-têtes HTTP standard. Tous les en-têtes standard sont conformes à la spécification du protocole HTTP/1.1.
Corps de la réponse
Le tableau suivant décrit les éléments clés du corps de la réponse :
Nom de l'élément |
Description |
|---|---|
PlanAddOn |
Module complémentaire qui a été récupéré. Pour plus d’informations, consultez PlanAddon (objet Administrator). |
Exemple
L’exemple de code suivant montre une demande get add-on .
GET https://<computer>:30004/addons/MyTeshixk1xiz HTTP/1.1
Authorization: Bearer
x-ms-client-request-id: 5f7abeba-03fd-41ab-92f1-1ef4ee5507f3-2013-07-09 22:02:35Z
x-ms-client-session-id: 4d317dde-d7c1-495e-a819-9802dc021e2f
x-ms-principal-id: <computer>\Administrator
Accept-Language: en-US
x-ms-principal-liveid: <computer>\Administrator
Host: <computer>:30004
L’exemple de code suivant montre une réponse Get Add-on .
{
"Id": "MyTeshixk1xiz",
"DisplayName": "My Test Addon",
"State": 0,
"ConfigState": 1,
"QuotaSyncState": 0,
"LastErrorMessage": null,
"Advertisements": [
{
"LanguageCode": "en-us",
"DisplayName": "My Test Addon",
"Description": null
}
],
"ServiceQuotas": [
{
"ServiceName": "sqlservers",
"ServiceInstanceId": "85D94D4A-6ADF-47A6-BAEF-A01975742308",
"ServiceDisplayName": "SQL Servers",
"ServiceInstanceDisplayName": "SQL Servers",
"ConfigState": 1,
"QuotaSyncState": 0,
"Settings": [
{
"Key": "Editions",
"Value": "[{\"groupName\":\"Default\",\"resourceCount\":\"1\",\"resourceSize\":\"10\",\"offerEditionId\":\"1373402022182\"}]"
}
]
}
],
"SubscriptionCount": 0,
"AssociatedPlans": [
],
"MaxOccurrencesPerPlan": 1,
"Price": null
}