Runbook - List By Automation Account

Reference

Služba:: Automation

Verze rozhraní API:: 2023-11-01

Načte seznam runbooků.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
automationAccountName	path	True	string	Název účtu Automation.
resourceGroupName	path	True	string	Název skupiny prostředků Azure Vzor regulárního výrazu: `^[-\w\._]+$`
subscriptionId	path	True	string	Získá přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	RunbookListResult	OK
Other Status Codes	ErrorResponse	Odpověď na chybu automatizace popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

List runbooks by automation account

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
      }
    }
  ]
}

Definice

Name	Description
ContentHash	Definice typu vlastnosti runbooku
ContentLink	Definice odkazu na obsah
ErrorResponse	Chybová odpověď při selhání operace
Runbook	Definice typu runbooku
RunbookDraft
RunbookListResult	Model odpovědi pro operaci seznamu runbooků.
RunbookParameter	Definice typu parametru runbooku
RunbookProvisioningState	Získá nebo nastaví stav zřizování runbooku.
RunbookState	Získá nebo nastaví stav runbooku.
RunbookTypeEnum	Získá nebo nastaví typ runbooku.

ContentHash

Definice typu vlastnosti runbooku

Name	Typ	Description
algorithm	string	Získá nebo nastaví algoritmus hash obsahu použitý k hash obsahu.
value	string	Získá nebo nastaví očekávanou hodnotu hash obsahu.

ContentLink

Definice odkazu na obsah

Name	Typ	Description
contentHash	ContentHash	Nastaví hodnotu hash.
uri	string	Nastaví identifikátor URI obsahu.
version	string	Nastaví verzi obsahu.

ErrorResponse

Chybová odpověď při selhání operace

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

Runbook

Definice typu runbooku

Name	Typ	Description
etag	string	Získá nebo nastaví etag prostředku.
id	string	Plně kvalifikované ID prostředku pro prostředek
location	string	Oblast Azure, ve které se prostředek nachází
name	string	Název prostředku
properties.creationTime	string	Získá nebo nastaví čas vytvoření.
properties.description	string	Získá nebo nastaví popis.
properties.draft	RunbookDraft	Získá nebo nastaví koncept vlastností runbooku.
properties.jobCount	integer	Získá nebo nastaví počet úloh runbooku.
properties.lastModifiedBy	string	Získá nebo nastaví naposledy změněný.
properties.lastModifiedTime	string	Získá nebo nastaví čas poslední změny.
properties.logActivityTrace	integer	Získá nebo nastaví možnost protokolování trasování aktivity runbooku.
properties.logProgress	boolean	Získá nebo nastaví možnost protokolu průběhu.
properties.logVerbose	boolean	Získá nebo nastaví možnost podrobného protokolu.
properties.outputTypes	string[]	Získá nebo nastaví výstupní typy runbooku.
properties.parameters	<string, RunbookParameter>	Získá nebo nastaví parametry runbooku.
properties.provisioningState	RunbookProvisioningState	Získá nebo nastaví stav zřizování runbooku.
properties.publishContentLink	ContentLink	Získá nebo nastaví odkaz na obsah publikované sady Runbook.
properties.runbookType	RunbookTypeEnum	Získá nebo nastaví typ runbooku.
properties.state	RunbookState	Získá nebo nastaví stav runbooku.
tags	object	Značky prostředků.
type	string	Typ prostředku.

RunbookDraft

Name	Typ	Description
creationTime	string	Získá nebo nastaví čas vytvoření konceptu runbooku.
draftContentLink	ContentLink	Získá nebo nastaví odkaz obsahu konceptu runbooku.
inEdit	boolean	Získá nebo nastaví, zda je runbook v režimu úprav.
lastModifiedTime	string	Získá nebo nastaví čas poslední změny konceptu runbooku.
outputTypes	string[]	Získá nebo nastaví výstupní typy runbooku.
parameters	<string, RunbookParameter>	Získá nebo nastaví parametry konceptu runbooku.

RunbookListResult

Model odpovědi pro operaci seznamu runbooků.

Name	Typ	Description
nextLink	string	Získá nebo nastaví další odkaz.
value	Runbook[]	Získá nebo nastaví seznam runbooků.

RunbookParameter

Definice typu parametru runbooku

Name	Typ	Description
defaultValue	string	Získá nebo nastaví výchozí hodnotu parametru.
isMandatory	boolean	Získá nebo nastaví logickou hodnotu určující, zda je parametr povinný nebo ne.
position	integer	Získání nebo nastavení pozice parametru
type	string	Získá nebo nastaví typ parametru.

RunbookProvisioningState

Získá nebo nastaví stav zřizování runbooku.

Name	Typ	Description
Succeeded	string

RunbookState

Získá nebo nastaví stav runbooku.

Name	Typ	Description
Edit	string
New	string
Published	string

RunbookTypeEnum

Získá nebo nastaví typ runbooku.

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

Sdílet prostřednictvím