Obtenir des informations sur un runbook publié
Le Get information about a published runbook opération retourne des informations sur une procédure opérationnelle qui est publiée.
Demande
Pour spécifier la requête, remplacez < id d'abonnement > par votre ID d'abonnement < cloud-service-name > avec le nom du service cloud à utiliser pour la demande, < automation-account-name > avec le nom du compte à utiliser pour effectuer la demande et < nom du runbook > par le nom de la procédure opérationnelle pour obtenir des informations sur automation. Incluez les paramètres d'URI nécessaires.
Méthode |
URI de demande |
|---|---|
GET |
https://management.core.windows.net/<subscriptionId>/cloudServices/<cloud-service-name>/resources/automation/~/automationAccounts/<automation-account-name>/runbooks/<runbook-name>?api-version=2014-12-08 |
Paramètres URI
Paramètre |
Description |
|---|---|
api-version |
Obligatoire. Doit avoir la valeur 2014-12-08. |
En-têtes de demande
L'en-tête de demande dans le tableau suivant est nécessaire.
En-tête de demande |
Description |
|---|---|
x-ms-version |
Spécifie la version de l'opération. La valeur 2013-06-01 ou une version ultérieure. |
Corps de la demande
Aucune
Réponse
Code d'état
Une opération réussie renvoie la valeur 200 (OK). Pour plus d'informations sur les codes d'erreur courants, consultez définitions de Code d'état HTTP/1.1.
En-têtes de réponse
En-tête de demande |
Description |
|---|---|
x-ms-request-id |
Identificateur unique de l'opération en cours. |
Corps de la réponse
{ "id":"\/subscriptions\/2310a662-9154-4254-a8e1-34286f3bf56a\/cloudservices\/CLSV2_Litware\/resources\/~\/automationAccounts\/LitwareDataCenter\/runbooks\/Write-HelloWorld", "location":"East US", "type":"Microsoft.Automation\/AutomationAccount\/Runbook", "name":"Write-HelloWorld", "tags":{ "Testing":"show value", "Source":"TechNet Script Center" }, "etag":"\"635657036880300000\"", "properties":{ "runbookType":"Script", "description":"Hello world", "logProgress":false, "logVerbose":false, "creationTime":"2015-04-26T05:45:42.457+00:00", "lastModifiedTime":"2015-04-27T03:54:48.03+00:00", "state":"Published", "jobCount":0, "parameters":{ "Name":{ "type":"System.String", "isMandatory":false, "position":0, "defaultValue":"\"World\"" } }, "serviceManagementTags":null } }
Élément |
Description |
|---|---|
id |
URI pour cette entité, à l'exclusion du nom d'hôte/schéma et de la version d'API. Non codé URL. La plateforme utilise ce champ comme identifiant pour des références à d'autres objets. |
location |
Emplacement géographique de ressource. |
name |
Nom du runbook. |
type |
Type de la ressource (par exemple, Microsoft.Automation/AutomationAccount/Runbook) |
name |
Nom du runbook. |
tags |
Liste de paires clé-valeur décrivant la ressource. Ces balises permettent d'afficher et de regrouper cette ressource (sur plusieurs groupes de ressources). Vous pouvez configurer au maximum 10 balises par ressource. Chaque balise doit avoir une clé de maximum 128 caractères et une valeur de maximum 256 caractères. |
etag |
Valeur utilisée pour le contrôle de simultanéité. |
properties/runbookType |
Le seul type pris en charge est « script ». |
properties/description |
Description fournie pour le runbook. |
properties/logVerbose |
Indique s'il faut enregistrer la progression du runbook. La valeur par défaut est false. |
properties/logProgress |
Indique s'il faut journaliser de façon détaillée le runbook. La valeur par défaut est false. |
properties/creationTime |
Date et heure de création du runbook. |
properties/creationTime |
Date et heure de que dernière modification de la procédure opérationnelle. |
properties/state |
État du runbook. Les valeurs possibles sont : créer, modifier, publié. |
properties/jobCount |
Le nombre de tâches exécutées pour ce runbook. |
properties/parameters |
Liste d'objets parameter qui représentent les paramètres de runbook. Les paramètres sont extraits dans le cadre du processus de création du runbook. Les objets parameter ont un nom et les propriétés suivantes.
|
properties/serviceManagementTags |
Valeurs de forme libre disponibles pour le runbook. |