Runbook - Create Or Update

Riferimento

Servizio:: Automation

Versione API:: 2023-11-01

Creare il runbook identificato dal nome del runbook.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
automationAccountName	path	True	string	Nome dell'account di automazione.
resourceGroupName	path	True	string	Nome di un gruppo di risorse di Azure. Criterio di espressione regolare: `^[-\w\._]+$`
runbookName	path	True	string	Nome del runbook. Criterio di espressione regolare: `^[a-zA-Z][a-zA-Z-_0-9]*$`
subscriptionId	path	True	string	Ottiene le credenziali di sottoscrizione che consentono di identificare in modo univoco la sottoscrizione Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
api-version	query	True	string	Versione api client.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties.runbookType	True	RunbookTypeEnum	Ottiene o imposta il tipo del runbook.
location		string	Ottiene o imposta il percorso della risorsa.
name		string	Ottiene o imposta il nome della risorsa.
properties.description		string	Ottiene o imposta la descrizione del runbook.
properties.draft		RunbookDraft	Ottiene o imposta le proprietà bozza del runbook.
properties.logActivityTrace		integer	Ottiene o imposta le opzioni di traccia a livello di attività del runbook.
properties.logProgress		boolean	Ottiene o imposta l'opzione del log di stato.
properties.logVerbose		boolean	Ottiene o imposta l'opzione di log dettagliata.
properties.publishContentLink		ContentLink	Ottiene o imposta il collegamento al contenuto del runbook pubblicato.
tags		object	Ottiene o imposta i tag associati alla risorsa.

Risposte

Nome	Tipo	Descrizione
200 OK	Runbook	OK
201 Created	Runbook	Data di creazione
Other Status Codes	ErrorResponse	Risposta di errore di automazione che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Create or update runbook and publish it

Create runbook as draft

Create or update runbook and publish it

Esempio di richiesta

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"
  }
}

Risposta di esempio

Codice di stato:: 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"
  }
}

Codice di stato:: 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

Esempio di richiesta

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"
  }
}

Risposta di esempio

Codice di stato:: 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": []
  }
}

Codice di stato:: 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"
  }
}

Definizioni

Nome	Descrizione
ContentHash	Definizione del tipo di proprietà del runbook.
ContentLink	Definizione del collegamento al contenuto.
ErrorResponse	Risposta di errore di un errore dell'operazione
Runbook	Definizione del tipo di runbook.
RunbookCreateOrUpdateParameters	Parametri forniti all'operazione di creazione o aggiornamento del runbook.
RunbookDraft
RunbookParameter	Definizione del tipo di parametro del runbook.
RunbookProvisioningState	Ottiene o imposta lo stato di provisioning del runbook.
RunbookState	Ottiene o imposta lo stato del runbook.
RunbookTypeEnum	Ottiene o imposta il tipo del runbook.

ContentHash

Definizione del tipo di proprietà del runbook.

Nome	Tipo	Descrizione
algorithm	string	Ottiene o imposta l'algoritmo hash del contenuto utilizzato per eseguire l'hashing del contenuto.
value	string	Ottiene o imposta il valore hash previsto del contenuto.

ContentLink

Definizione del collegamento al contenuto.

Nome	Tipo	Descrizione
contentHash	ContentHash	Imposta l'hash.
uri	string	Imposta l'URI del contenuto.
version	string	Imposta la versione del contenuto.

ErrorResponse

Risposta di errore di un errore dell'operazione

Nome	Tipo	Descrizione
code	string	Codice di errore
message	string	Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

Runbook

Definizione del tipo di runbook.

Nome	Tipo	Descrizione
etag	string	Ottiene o imposta l'etag della risorsa.
id	string	ID risorsa completo per la risorsa
location	string	Area di Azure in cui risiede la risorsa
name	string	nome della risorsa.
properties.creationTime	string	Ottiene o imposta l'ora di creazione.
properties.description	string	Ottiene o imposta la descrizione.
properties.draft	RunbookDraft	Ottiene o imposta le proprietà bozza del runbook.
properties.jobCount	integer	Ottiene o imposta il numero di processi del runbook.
properties.lastModifiedBy	string	Ottiene o imposta l'ultima modifica da.
properties.lastModifiedTime	string	Ottiene o imposta l'ora dell'ultima modifica.
properties.logActivityTrace	integer	Ottiene o imposta l'opzione per registrare la traccia delle attività del runbook.
properties.logProgress	boolean	Ottiene o imposta l'opzione del log di stato.
properties.logVerbose	boolean	Ottiene o imposta l'opzione di log dettagliata.
properties.outputTypes	string[]	Ottiene o imposta i tipi di output del runbook.
properties.parameters	<string, RunbookParameter>	Ottiene o imposta i parametri del runbook.
properties.provisioningState	RunbookProvisioningState	Ottiene o imposta lo stato di provisioning del runbook.
properties.publishContentLink	ContentLink	Ottiene o imposta il collegamento al contenuto del runbook pubblicato.
properties.runbookType	RunbookTypeEnum	Ottiene o imposta il tipo del runbook.
properties.state	RunbookState	Ottiene o imposta lo stato del runbook.
tags	object	Tag delle risorse.
type	string	Tipo di risorsa.

RunbookCreateOrUpdateParameters

Parametri forniti all'operazione di creazione o aggiornamento del runbook.

Nome	Tipo	Descrizione
location	string	Ottiene o imposta il percorso della risorsa.
name	string	Ottiene o imposta il nome della risorsa.
properties.description	string	Ottiene o imposta la descrizione del runbook.
properties.draft	RunbookDraft	Ottiene o imposta le proprietà bozza del runbook.
properties.logActivityTrace	integer	Ottiene o imposta le opzioni di traccia a livello di attività del runbook.
properties.logProgress	boolean	Ottiene o imposta l'opzione del log di stato.
properties.logVerbose	boolean	Ottiene o imposta l'opzione di log dettagliata.
properties.publishContentLink	ContentLink	Ottiene o imposta il collegamento al contenuto del runbook pubblicato.
properties.runbookType	RunbookTypeEnum	Ottiene o imposta il tipo del runbook.
tags	object	Ottiene o imposta i tag associati alla risorsa.

RunbookDraft

Nome	Tipo	Descrizione
creationTime	string	Ottiene o imposta l'ora di creazione della bozza del runbook.
draftContentLink	ContentLink	Ottiene o imposta il collegamento al contenuto del runbook bozza.
inEdit	boolean	Ottiene o imposta un valore che indica se il runbook è in modalità di modifica.
lastModifiedTime	string	Ottiene o imposta l'ora dell'ultima modifica della bozza del runbook.
outputTypes	string[]	Ottiene o imposta i tipi di output del runbook.
parameters	<string, RunbookParameter>	Ottiene o imposta i parametri bozza del runbook.

RunbookParameter

Definizione del tipo di parametro del runbook.

Nome	Tipo	Descrizione
defaultValue	string	Ottiene o imposta il valore predefinito del parametro.
isMandatory	boolean	Ottiene o imposta un valore booleano per indicare se il parametro è obbligatorio o meno.
position	integer	Ottiene o imposta la posizione del parametro.
type	string	Ottiene o imposta il tipo del parametro.

RunbookProvisioningState

Ottiene o imposta lo stato di provisioning del runbook.

Nome	Tipo	Descrizione
Succeeded	string

RunbookState

Ottiene o imposta lo stato del runbook.

Nome	Tipo	Descrizione
Edit	string
New	string
Published	string

RunbookTypeEnum

Ottiene o imposta il tipo del runbook.

Nome	Tipo	Descrizione
Graph	string
GraphPowerShell	string
GraphPowerShellWorkflow	string
PowerShell	string
PowerShell72	string
PowerShellWorkflow	string
Python2	string
Python3	string
Script	string

Condividi tramite

Runbook - Create Or Update

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

Create or update runbook and publish it

Esempio di richiesta

Risposta di esempio

Create runbook as draft

Esempio di richiesta

Risposta di esempio

Definizioni

ContentHash

ContentLink

ErrorResponse

Runbook

RunbookCreateOrUpdateParameters

RunbookDraft

RunbookParameter

RunbookProvisioningState

RunbookState

RunbookTypeEnum

Risorse aggiuntive