Runbook - Update

Riferimento

Servizio:: Automation

Versione API:: 2023-11-01

Aggiornare il runbook identificato dal nome del runbook.

PATCH 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 dell'API client.

Corpo della richiesta

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.logActivityTrace	integer	Ottiene o imposta le opzioni di traccia a livello di attività del runbook.
properties.logProgress	boolean	Ottiene o imposta l'opzione log di stato.
properties.logVerbose	boolean	Ottiene o imposta l'opzione log dettagliata.
tags	object	Ottiene o imposta i tag associati alla risorsa.

Risposte

Nome	Tipo	Descrizione
200 OK	Runbook	OK
Other Status Codes	ErrorResponse	Risposta di errore di automazione che descrive perché 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

Update runbook

Esempio di richiesta

HTTP

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

{
  "properties": {
    "description": "Updated Description of the Runbook",
    "logVerbose": false,
    "logProgress": true,
    "logActivityTrace": 1
  }
}

Risposta di esempio

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": "\"636265044994500000\"",
  "properties": {
    "description": "Updated Description of the Runbook",
    "logVerbose": false,
    "logProgress": true,
    "logActivityTrace": 1,
    "runbookType": "PowerShellWorkflow",
    "parameters": {},
    "state": "Published",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "outputTypes": [],
    "creationTime": "2017-03-30T21:01:33.777+00:00",
    "lastModifiedBy": "myEmaild@microsoft.com",
    "lastModifiedTime": "2017-03-30T21:01:39.45+00:00"
  }
}

Definizioni

Nome	Descrizione
ContentHash	Definizione del tipo di proprietà runbook.
ContentLink	Definizione del collegamento al contenuto.
ErrorResponse	Risposta di errore di un errore dell'operazione
Runbook	Definizione del tipo di runbook.
RunbookDraft
RunbookParameter	Definizione del tipo di parametro 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.
RunbookUpdateParameters	I parametri forniti all'operazione di aggiornamento del runbook.

ContentHash

Definizione del tipo di proprietà runbook.

Nome	Tipo	Descrizione
algorithm	string	Ottiene o imposta l'algoritmo hash del contenuto usato per hashare il 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 perché 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 si trova 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à del runbook bozza.
properties.jobCount	integer	Ottiene o imposta il numero di processi del runbook.
properties.lastModifiedBy	string	Ottiene o imposta l'ultimo modificato da.
properties.lastModifiedTime	string	Ottiene o imposta l'ultima ora modificata.
properties.logActivityTrace	integer	Ottiene o imposta l'opzione per registrare la traccia dell'attività del runbook.
properties.logProgress	boolean	Ottiene o imposta l'opzione log di stato.
properties.logVerbose	boolean	Ottiene o imposta l'opzione 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 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 di risorse.
type	string	Tipo di risorsa.

RunbookDraft

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

RunbookParameter

Definizione del tipo di parametro 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	Ottenere o impostare 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

RunbookUpdateParameters

I parametri forniti all'operazione di 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.logActivityTrace	integer	Ottiene o imposta le opzioni di traccia a livello di attività del runbook.
properties.logProgress	boolean	Ottiene o imposta l'opzione log di stato.
properties.logVerbose	boolean	Ottiene o imposta l'opzione log dettagliata.
tags	object	Ottiene o imposta i tag associati alla risorsa.

Condividi tramite