Runbook - Create Or Update

Référence

Service:: Automation

Version d'API:: 2023-11-01

Créez le runbook identifié par le nom du runbook.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}?api-version=2023-11-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
automationAccountName	path	True	string	Nom du compte Automation.
resourceGroupName	path	True	string	Nom d’un groupe de ressources Azure. Modèle d’expression régulière: `^[-\w\._]+$`
runbookName	path	True	string	Nom du runbook. Modèle d’expression régulière: `^[a-zA-Z][a-zA-Z-_0-9]*$`
subscriptionId	path	True	string	Obtient les informations d'identification d'abonnement qui identifient l'abonnement Microsoft Azure de manière unique. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Obligatoire	Type	Description
properties.runbookType	True	RunbookTypeEnum	Obtient ou définit le type du runbook.
location		string	Obtient ou définit l'emplacement de la ressource.
name		string	Obtient ou définit le nom de la ressource.
properties.description		string	Obtient ou définit la description du runbook.
properties.draft		RunbookDraft	Obtient ou définit les propriétés du runbook brouillon.
properties.logActivityTrace		integer	Obtient ou définit les options de suivi au niveau de l’activité du runbook.
properties.logProgress		boolean	Obtient ou définit l’option du journal de progression.
properties.logVerbose		boolean	Obtient ou définit l’option de journal détaillé.
properties.publishContentLink		ContentLink	Obtient ou définit le lien de contenu du runbook publié.
tags		object	Obtient ou définit les balises associés à la ressource.

Réponses

Nom	Type	Description
200 OK	Runbook	Ok
201 Created	Runbook	Date de création
Other Status Codes	ErrorResponse	Réponse d’erreur Automation décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Create or update runbook and publish it

Create runbook as draft

Create or update runbook and publish it

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial?api-version=2023-11-01

{
  "properties": {
    "logVerbose": false,
    "logProgress": true,
    "runbookType": "PowerShellWorkflow",
    "publishContentLink": {
      "uri": "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1",
      "contentHash": {
        "algorithm": "SHA256",
        "value": "115775B8FF2BE672D8A946BD0B489918C724DDE15A440373CA54461D53010A80"
      }
    },
    "description": "Description of the Runbook",
    "logActivityTrace": 1
  },
  "name": "Get-AzureVMTutorial",
  "location": "East US 2",
  "tags": {
    "tag01": "value01",
    "tag02": "value02"
  }
}

Exemple de réponse

Code d’état:: 201

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial",
  "name": "Get-AzureVMTutorial",
  "type": "Microsoft.Automation/AutomationAccounts/Runbooks",
  "location": "East US 2",
  "tags": {
    "tag01": "value01",
    "tag02": "value02"
  },
  "etag": "\"636263318837230000\"",
  "properties": {
    "description": "Description of the Runbook",
    "logVerbose": false,
    "logProgress": true,
    "logActivityTrace": 1,
    "runbookType": "PowerShellWorkflow",
    "parameters": {},
    "state": "Published",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "outputTypes": [],
    "creationTime": "2017-03-28T21:04:43.66+00:00",
    "lastModifiedBy": "myEmaild@microsoft.com",
    "lastModifiedTime": "2017-03-28T21:04:43.723+00:00"
  }
}

Code d’état:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial",
  "name": "Get-AzureVMTutorial",
  "type": "Microsoft.Automation/AutomationAccounts/Runbooks",
  "location": "East US 2",
  "tags": {
    "tag01": "value01",
    "tag02": "value02"
  },
  "etag": "\"636263318866000000\"",
  "properties": {
    "description": "Description of the Runbook",
    "logVerbose": true,
    "logProgress": true,
    "logActivityTrace": 1,
    "runbookType": "PowerShellWorkflow",
    "parameters": {},
    "state": "Published",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "outputTypes": [],
    "creationTime": "2017-03-28T21:04:43.66+00:00",
    "lastModifiedBy": "myEmaild@microsoft.com",
    "lastModifiedTime": "2017-03-28T21:04:46.6+00:00"
  }
}

Create runbook as draft

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial?api-version=2023-11-01

{
  "properties": {
    "logVerbose": false,
    "logProgress": false,
    "runbookType": "PowerShellWorkflow",
    "description": "Description of the Runbook",
    "draft": {}
  },
  "name": "Get-AzureVMTutorial",
  "location": "East US 2",
  "tags": {
    "tag01": "value01",
    "tag02": "value02"
  }
}

Exemple de réponse

Code d’état:: 201

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial",
  "name": "Get-AzureVMTutorial",
  "type": "Microsoft.Automation/AutomationAccounts/Runbooks",
  "location": "East US 2",
  "tags": {
    "tag01": "value01",
    "tag02": "value02"
  },
  "etag": "\"636263318837230000\"",
  "properties": {
    "description": "Description of the Runbook",
    "logVerbose": false,
    "logProgress": false,
    "logActivityTrace": 0,
    "runbookType": "Script",
    "parameters": {},
    "state": "New",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "creationTime": "2018-02-09T03:25:59.097+00:00",
    "lastModifiedTime": "2018-02-09T03:25:59.097+00:00",
    "outputTypes": []
  }
}

Code d’état:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial",
  "name": "Get-AzureVMTutorial",
  "type": "Microsoft.Automation/AutomationAccounts/Runbooks",
  "location": "East US 2",
  "tags": {
    "tag01": "value01",
    "tag02": "value02"
  },
  "etag": "\"636263318866000000\"",
  "properties": {
    "description": "Description of the Runbook",
    "logVerbose": false,
    "logProgress": false,
    "logActivityTrace": 0,
    "runbookType": "Script",
    "parameters": {},
    "state": "New",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "creationTime": "2018-02-09T03:25:59.097+00:00",
    "lastModifiedTime": "2018-02-09T03:25:59.097+00:00"
  }
}

Définitions

Nom	Description
ContentHash	Définition du type de propriété runbook.
ContentLink	Définition du lien de contenu.
ErrorResponse	Réponse d’erreur d’un échec d’opération
Runbook	Définition du type de runbook.
RunbookCreateOrUpdateParameters	Paramètres fournis à l’opération de création ou de mise à jour du runbook.
RunbookDraft
RunbookParameter	Définition du type de paramètre de runbook.
RunbookProvisioningState	Obtient ou définit l’état d’approvisionnement du runbook.
RunbookState	Obtient ou définit l’état du runbook.
RunbookTypeEnum	Obtient ou définit le type du runbook.

ContentHash

Définition du type de propriété runbook.

Nom	Type	Description
algorithm	string	Obtient ou définit l’algorithme de hachage de contenu utilisé pour hacher le contenu.
value	string	Obtient ou définit la valeur de hachage attendue du contenu.

ContentLink

Définition du lien de contenu.

Nom	Type	Description
contentHash	ContentHash	Définit le hachage.
uri	string	Définit l’URI du contenu.
version	string	Définit la version du contenu.

ErrorResponse

Réponse d’erreur d’un échec d’opération

Nom	Type	Description
code	string	Code d'erreur
message	string	Message d’erreur indiquant la raison de l’échec de l’opération.

Runbook

Définition du type de runbook.

Nom	Type	Description
etag	string	Obtient ou définit l’etag de la ressource.
id	string	ID de ressource complet pour la ressource
location	string	Région Azure où réside la ressource
name	string	nom de la ressource.
properties.creationTime	string	Obtient ou définit l’heure de création.
properties.description	string	Obtient ou définit la description.
properties.draft	RunbookDraft	Obtient ou définit les propriétés du runbook brouillon.
properties.jobCount	integer	Obtient ou définit le nombre de travaux du runbook.
properties.lastModifiedBy	string	Obtient ou définit la dernière modification par.
properties.lastModifiedTime	string	Obtient ou définit l’heure de la dernière modification.
properties.logActivityTrace	integer	Obtient ou définit l’option permettant de journaliser la trace d’activité du runbook.
properties.logProgress	boolean	Obtient ou définit l’option du journal de progression.
properties.logVerbose	boolean	Obtient ou définit l’option de journal détaillé.
properties.outputTypes	string[]	Obtient ou définit les types de sortie de runbook.
properties.parameters	<string, RunbookParameter>	Obtient ou définit les paramètres du runbook.
properties.provisioningState	RunbookProvisioningState	Obtient ou définit l’état d’approvisionnement du runbook.
properties.publishContentLink	ContentLink	Obtient ou définit le lien de contenu du runbook publié.
properties.runbookType	RunbookTypeEnum	Obtient ou définit le type du runbook.
properties.state	RunbookState	Obtient ou définit l’état du runbook.
tags	object	Balises de ressource.
type	string	Type de la ressource.

RunbookCreateOrUpdateParameters

Paramètres fournis à l’opération de création ou de mise à jour du runbook.

Nom	Type	Description
location	string	Obtient ou définit l'emplacement de la ressource.
name	string	Obtient ou définit le nom de la ressource.
properties.description	string	Obtient ou définit la description du runbook.
properties.draft	RunbookDraft	Obtient ou définit les propriétés du runbook brouillon.
properties.logActivityTrace	integer	Obtient ou définit les options de suivi au niveau de l’activité du runbook.
properties.logProgress	boolean	Obtient ou définit l’option du journal de progression.
properties.logVerbose	boolean	Obtient ou définit l’option de journal détaillé.
properties.publishContentLink	ContentLink	Obtient ou définit le lien de contenu du runbook publié.
properties.runbookType	RunbookTypeEnum	Obtient ou définit le type du runbook.
tags	object	Obtient ou définit les balises associés à la ressource.

RunbookDraft

Nom	Type	Description
creationTime	string	Obtient ou définit l’heure de création du brouillon de runbook.
draftContentLink	ContentLink	Obtient ou définit le lien de contenu du runbook brouillon.
inEdit	boolean	Obtient ou définit si le runbook est en mode édition.
lastModifiedTime	string	Obtient ou définit l’heure de la dernière modification du brouillon de runbook.
outputTypes	string[]	Obtient ou définit les types de sortie de runbook.
parameters	<string, RunbookParameter>	Obtient ou définit les paramètres de brouillon de runbook.

RunbookParameter

Définition du type de paramètre de runbook.

Nom	Type	Description
defaultValue	string	Obtient ou définit la valeur par défaut du paramètre.
isMandatory	boolean	Obtient ou définit une valeur booléenne pour indiquer si le paramètre est obligatoire ou non.
position	integer	Obtient ou définit la position du paramètre.
type	string	Obtient ou définit le type du paramètre.

RunbookProvisioningState

Obtient ou définit l’état d’approvisionnement du runbook.

Nom	Type	Description
Succeeded	string

RunbookState

Obtient ou définit l’état du runbook.

Nom	Type	Description
Edit	string
New	string
Published	string

RunbookTypeEnum

Obtient ou définit le type du runbook.

Nom	Type	Description
Graph	string
GraphPowerShell	string
GraphPowerShellWorkflow	string
PowerShell	string
PowerShell72	string
PowerShellWorkflow	string
Python2	string
Python3	string
Script	string

Partager via

Runbook - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

Create or update runbook and publish it

Exemple de requête

Exemple de réponse

Create runbook as draft

Exemple de requête

Exemple de réponse

Définitions

ContentHash

ContentLink

ErrorResponse

Runbook

RunbookCreateOrUpdateParameters

RunbookDraft

RunbookParameter

RunbookProvisioningState

RunbookState

RunbookTypeEnum

Ressources supplémentaires