Runbook - Get

Referenz

Dienst:: Automation

API-Version:: 2023-11-01

Rufen Sie das runbook ab, das durch den Runbooknamen identifiziert wurde.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
automationAccountName	path	True	string	Der Name des Automation-Kontos.
resourceGroupName	path	True	string	Name einer Azure-Ressourcengruppe. RegEx-Muster: `^[-\w\._]+$`
runbookName	path	True	string	Der Runbookname. RegEx-Muster: `^[a-zA-Z][a-zA-Z-_0-9]*$`
subscriptionId	path	True	string	Ruft die Abonnementanmeldeinformationen ab, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	Runbook	OK
Other Status Codes	ErrorResponse	Automatisierungsfehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Get runbook

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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": "\"636263335437500000\"",
  "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:32:23.75+00:00",
    "lastModifiedBy": "myEmaild@microsoft.com",
    "lastModifiedTime": "2017-03-28T21:32:23.75+00:00"
  }
}

Definitionen

Name	Beschreibung
ContentHash	Definition des Runbook-Eigenschaftstyps.
ContentLink	Definition des Inhaltslinks.
ErrorResponse	Fehlerantwort eines Vorgangsfehlers
Runbook	Definition des Runbooktyps.
RunbookDraft
RunbookParameter	Definition des Runbook-Parametertyps.
RunbookProvisioningState	Ruft den Bereitstellungsstatus des Runbooks ab oder legt diese fest.
RunbookState	Ruft den Zustand des Runbooks ab oder legt diese fest.
RunbookTypeEnum	Ruft den Typ des Runbooks ab oder legt diese fest.

ContentHash

Definition des Runbook-Eigenschaftstyps.

Name	Typ	Beschreibung
algorithm	string	Ruft den Inhaltshashalgorithmus ab, der zum Hashen des Inhalts verwendet wird, oder legt diesen fest.
value	string	Ruft den erwarteten Hashwert des Inhalts ab oder legt diese fest.

ContentLink

Definition des Inhaltslinks.

Name	Typ	Beschreibung
contentHash	ContentHash	Legt den Hash fest.
uri	string	Legt den URI des Inhalts fest.
version	string	Legt die Version des Inhalts fest.

ErrorResponse

Fehlerantwort eines Vorgangsfehlers

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

Runbook

Definition des Runbooktyps.

Name	Typ	Beschreibung
etag	string	Ruft das Etag der Ressource ab oder legt es fest.
id	string	Vollqualifizierte Ressourcen-ID für die Ressource
location	string	Die Azure-Region, in der sich die Ressource befindet
name	string	Der Name der Ressource
properties.creationTime	string	Ruft die Erstellungszeit ab oder legt sie fest.
properties.description	string	Ruft die Beschreibung ab oder legt sie fest.
properties.draft	RunbookDraft	Ruft die Runbook-Eigenschaften des Entwurfs ab oder legt sie fest.
properties.jobCount	integer	Ruft die Auftragsanzahl des Runbooks ab oder legt diese fest.
properties.lastModifiedBy	string	Ruft die zuletzt geänderte von ab oder legt sie fest.
properties.lastModifiedTime	string	Ruft den Zeitpunkt der letzten Änderung ab oder legt sie fest.
properties.logActivityTrace	integer	Ruft die Option zum Protokollieren der Aktivitätsablaufverfolgung des Runbooks ab oder legt diese fest.
properties.logProgress	boolean	Ruft die Statusprotokolloption ab oder legt sie fest.
properties.logVerbose	boolean	Ruft die ausführliche Protokolloption ab oder legt sie fest.
properties.outputTypes	string[]	Ruft die Runbook-Ausgabetypen ab oder legt sie fest.
properties.parameters	<string, RunbookParameter>	Ruft die Runbookparameter ab oder legt sie fest.
properties.provisioningState	RunbookProvisioningState	Ruft den Bereitstellungsstatus des Runbooks ab oder legt diese fest.
properties.publishContentLink	ContentLink	Ruft den link zum veröffentlichten Runbookinhalt ab oder legt diese fest.
properties.runbookType	RunbookTypeEnum	Ruft den Typ des Runbooks ab oder legt diese fest.
properties.state	RunbookState	Ruft den Zustand des Runbooks ab oder legt diese fest.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource.

RunbookDraft

Name	Typ	Beschreibung
creationTime	string	Ruft die Erstellungszeit des Runbookentwurfs ab oder legt diese fest.
draftContentLink	ContentLink	Ruft den Entwurfs-Runbookinhaltslink ab oder legt diese fest.
inEdit	boolean	Ruft ab, ob sich das Runbook im Bearbeitungsmodus befindet, oder legt es fest.
lastModifiedTime	string	Ruft den Zeitpunkt der letzten Änderung des Runbookentwurfs ab oder legt diese fest.
outputTypes	string[]	Ruft die Runbook-Ausgabetypen ab oder legt sie fest.
parameters	<string, RunbookParameter>	Ruft die Runbookentwurfsparameter ab oder legt sie fest.

RunbookParameter

Definition des Runbook-Parametertyps.

Name	Typ	Beschreibung
defaultValue	string	Ruft den Standardwert des Parameters ab oder legt diese fest.
isMandatory	boolean	Ruft einen booleschen Wert ab, der angibt, ob der Parameter obligatorisch ist oder nicht, oder legt diesen fest.
position	integer	Ruft die Position des Parameters ab oder legt sie fest.
type	string	Ruft den Typ des Parameters ab oder legt ihn fest.

RunbookProvisioningState

Ruft den Bereitstellungsstatus des Runbooks ab oder legt diese fest.

Name	Typ	Beschreibung
Succeeded	string

RunbookState

Ruft den Zustand des Runbooks ab oder legt diese fest.

Name	Typ	Beschreibung
Edit	string
New	string
Published	string

RunbookTypeEnum

Ruft den Typ des Runbooks ab oder legt diese fest.

Name	Typ	Beschreibung
Graph	string
GraphPowerShell	string
GraphPowerShellWorkflow	string
PowerShell	string
PowerShell72	string
PowerShellWorkflow	string
Python2	string
Python3	string
Script	string

Freigeben über