Runbook - List By Automation Account

Servizio:: Automation

Versione API:: 2023-11-01

Recuperare un elenco di runbook.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks?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 minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nome di un gruppo di risorse di Azure.
subscriptionId	path	True	string	Ottiene le credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
api-version	query	True	string	Versione dell'API client.

Risposte

Nome	Tipo	Descrizione
200 OK	RunbookListResult	OK
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

List runbooks by automation account

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/ASR-AddPublicIp",
      "location": "East US 2",
      "name": "ASR-AddPublicIp",
      "type": "Microsoft.Automation/AutomationAccounts/Runbooks",
      "properties": {
        "runbookType": "PowerShell",
        "state": "Published",
        "logVerbose": true,
        "logProgress": true,
        "logActivityTrace": 1,
        "creationTime": "2017-03-28T21:32:25.78+00:00",
        "lastModifiedTime": "2017-03-28T21:32:25.81+00:00"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/AutoExport",
      "location": "East US 2",
      "name": "AutoExport",
      "type": "Microsoft.Automation/AutomationAccounts/Runbooks",
      "properties": {
        "runbookType": "PowerShell",
        "state": "Published",
        "logVerbose": true,
        "logProgress": true,
        "logActivityTrace": 1,
        "creationTime": "2017-03-28T21:32:27.327+00:00",
        "lastModifiedTime": "2017-03-28T21:32:27.327+00:00"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial",
      "location": "East US 2",
      "name": "Get-AzureVMTutorial",
      "type": "Microsoft.Automation/AutomationAccounts/Runbooks",
      "properties": {
        "runbookType": "PowerShellWorkflow",
        "state": "Published",
        "logVerbose": false,
        "logProgress": true,
        "logActivityTrace": 1,
        "creationTime": "2017-03-28T21:32:23.75+00:00",
        "lastModifiedTime": "2017-03-28T21:32:23.75+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.
RunbookDraft
RunbookListResult	Modello di risposta per l'operazione di elenco runbook.
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

Object

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

Object

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

Object

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

Object

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 (date-time)	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 (int32)	Ottiene o imposta il numero di processi del runbook.
properties.lastModifiedBy	string	Ottiene o imposta l'ultima modifica apportata da.
properties.lastModifiedTime	string (date-time)	Ottiene o imposta l'ora dell'ultima modifica.
properties.logActivityTrace	integer (int32)	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 di risorsa.
type	string	Tipo della risorsa.

RunbookDraft

Object

Nome	Tipo	Descrizione
creationTime	string (date-time)	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 (date-time)	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 della bozza del runbook.

RunbookListResult

Object

Modello di risposta per l'operazione di elenco runbook.

Nome	Tipo	Descrizione
nextLink	string	Ottiene o imposta il collegamento successivo.
value	Runbook[]	Ottiene o imposta un elenco di runbook.

RunbookParameter

Object

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 (int32)	Ottiene o imposta la posizione del parametro.
type	string	Ottiene o imposta il tipo del parametro.

RunbookProvisioningState

Enumerazione

Ottiene o imposta lo stato di provisioning del runbook.

Valore	Descrizione
Succeeded

RunbookState

Enumerazione

Ottiene o imposta lo stato del runbook.

Valore	Descrizione
Edit
New
Published

RunbookTypeEnum

Enumerazione

Ottiene o imposta il tipo del runbook.

Valore	Descrizione
Graph
GraphPowerShell
GraphPowerShellWorkflow
PowerShell
PowerShell72
PowerShellWorkflow
Python2
Python3
Script

Condividi tramite

Runbook - List By Automation Account

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

List runbooks by automation account

Esempio di richiesta

Risposta di esempio

Definizioni

ContentHash

ContentLink

ErrorResponse

Runbook

RunbookDraft

RunbookListResult

RunbookParameter

RunbookProvisioningState

RunbookState

RunbookTypeEnum