Runbook - Get

Referens

Tjänst:: Automation

API-version:: 2023-11-01

Hämta den runbook som identifieras med runbook-namnet.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
automationAccountName	path	True	string	Namnet på Automation-kontot.
resourceGroupName	path	True	string	Namnet på en Azure-resursgrupp. Reguljärt uttrycksmönster: `^[-\w\._]+$`
runbookName	path	True	string	Runbook-namnet. Reguljärt uttrycksmönster: `^[a-zA-Z][a-zA-Z-_0-9]*$`
subscriptionId	path	True	string	Hämtar autentiseringsuppgifter för prenumerationen som unikt identifierar Microsoft Azure-prenumerationen. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Svar

Name	Typ	Description
200 OK	Runbook	OK
Other Status Codes	ErrorResponse	Automation-felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Get runbook

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
ContentHash	Definition av runbook-egenskapstypen.
ContentLink	Definition av innehållslänken.
ErrorResponse	Felsvar på ett åtgärdsfel
Runbook	Definition av runbook-typen.
RunbookDraft
RunbookParameter	Definition av runbook-parametertypen.
RunbookProvisioningState	Hämtar eller anger etableringstillståndet för runbooken.
RunbookState	Hämtar eller anger runbookens tillstånd.
RunbookTypeEnum	Hämtar eller anger typen av runbook.

ContentHash

Definition av runbook-egenskapstypen.

Name	Typ	Description
algorithm	string	Hämtar eller anger den algoritm för innehållshash som används för att hasha innehållet.
value	string	Hämtar eller anger förväntat hashvärde för innehållet.

ContentLink

Definition av innehållslänken.

Name	Typ	Description
contentHash	ContentHash	Anger hashen.
uri	string	Anger innehållets URI.
version	string	Anger versionen av innehållet.

ErrorResponse

Felsvar på ett åtgärdsfel

Name	Typ	Description
code	string	Felkod
message	string	Felmeddelande som anger varför åtgärden misslyckades.

Runbook

Definition av runbook-typen.

Name	Typ	Description
etag	string	Hämtar eller anger etag för resursen.
id	string	Fullständigt kvalificerat resurs-ID för resursen
location	string	Den Azure-region där resursen finns
name	string	Namnet på resursen
properties.creationTime	string	Hämtar eller anger skapandetiden.
properties.description	string	Hämtar eller anger beskrivningen.
properties.draft	RunbookDraft	Hämtar eller anger utkast av runbook-egenskaper.
properties.jobCount	integer	Hämtar eller anger jobbantalet för runbooken.
properties.lastModifiedBy	string	Hämtar eller anger den senast ändrade av.
properties.lastModifiedTime	string	Hämtar eller anger den senaste ändringstiden.
properties.logActivityTrace	integer	Hämtar eller anger alternativet för att logga aktivitetsspårning för runbooken.
properties.logProgress	boolean	Hämtar eller anger förloppsloggalternativ.
properties.logVerbose	boolean	Hämtar eller anger utförligt loggalternativ.
properties.outputTypes	string[]	Hämtar eller anger runbook-utdatatyperna.
properties.parameters	<string, RunbookParameter>	Hämtar eller anger runbook-parametrarna.
properties.provisioningState	RunbookProvisioningState	Hämtar eller anger etableringstillståndet för runbooken.
properties.publishContentLink	ContentLink	Hämtar eller anger den publicerade runbook-innehållslänken.
properties.runbookType	RunbookTypeEnum	Hämtar eller anger typen av runbook.
properties.state	RunbookState	Hämtar eller anger runbookens tillstånd.
tags	object	Resurstaggar.
type	string	Resurstypen.

RunbookDraft

Name	Typ	Description
creationTime	string	Hämtar eller anger skapandetiden för runbook-utkastet.
draftContentLink	ContentLink	Hämtar eller anger innehållslänken för utkast till runbook.
inEdit	boolean	Hämtar eller anger om Runbook är i redigeringsläge.
lastModifiedTime	string	Hämtar eller anger den senast ändrade tiden för runbook-utkastet.
outputTypes	string[]	Hämtar eller anger runbook-utdatatyperna.
parameters	<string, RunbookParameter>	Hämtar eller anger runbook-utkastparametrarna.

RunbookParameter

Definition av runbook-parametertypen.

Name	Typ	Description
defaultValue	string	Hämtar eller anger standardvärdet för parametern.
isMandatory	boolean	Hämtar eller anger ett booleskt värde för att ange om parametern är obligatorisk eller inte.
position	integer	Hämta eller anger parameterns position.
type	string	Hämtar eller anger parametertypen.

RunbookProvisioningState

Hämtar eller anger etableringstillståndet för runbooken.

Name	Typ	Description
Succeeded	string

RunbookState

Hämtar eller anger runbookens tillstånd.

Name	Typ	Description
Edit	string
New	string
Published	string

RunbookTypeEnum

Hämtar eller anger typen av runbook.

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

Dela via