Megosztás a következőn keresztül:


Runbook - List By Automation Account

Runbookok listájának lekérése.

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

URI-paraméterek

Name In Kötelező Típus Description
automationAccountName
path True

string

Az Automation-fiók neve.

resourceGroupName
path True

string

Egy Azure-erőforráscsoport neve.

Reguláris kifejezési minta: ^[-\w\._]+$

subscriptionId
path True

string

Lekéri az előfizetés hitelesítő adatait, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.

api-version
query True

string

Client API-verzió.

Válaszok

Name Típus Description
200 OK

RunbookListResult

OK

Other Status Codes

ErrorResponse

Automatizálási hibaválasz, amely leírja, hogy miért hiúsult meg a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation felhasználói fiók megszemélyesítése

Példák

List runbooks by automation account

Mintakérelem

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

Mintaválasz

{
  "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"
      }
    }
  ]
}

Definíciók

Name Description
ContentHash

A runbook tulajdonságtípusának definíciója.

ContentLink

A tartalomhivatkozás definíciója.

ErrorResponse

Művelethiba hibaválasza

Runbook

A runbook típusának meghatározása.

RunbookDraft
RunbookListResult

A lista runbook-művelet válaszmodellje.

RunbookParameter

A runbook paramétertípusának definíciója.

RunbookProvisioningState

Lekéri vagy beállítja a runbook kiépítési állapotát.

RunbookState

Lekéri vagy beállítja a runbook állapotát.

RunbookTypeEnum

Lekéri vagy beállítja a runbook típusát.

ContentHash

A runbook tulajdonságtípusának definíciója.

Name Típus Description
algorithm

string

Lekéri vagy beállítja a tartalom kivonatolási algoritmusát.

value

string

Lekéri vagy beállítja a tartalom várt kivonatértékét.

A tartalomhivatkozás definíciója.

Name Típus Description
contentHash

ContentHash

Beállítja a kivonatot.

uri

string

Beállítja a tartalom URI-ját.

version

string

Beállítja a tartalom verzióját.

ErrorResponse

Művelethiba hibaválasza

Name Típus Description
code

string

Hibakód

message

string

Hibaüzenet, amely jelzi, hogy a művelet miért hiúsult meg.

Runbook

A runbook típusának meghatározása.

Name Típus Description
etag

string

Lekéri vagy beállítja az erőforrás etagját.

id

string

Az erőforrás teljes erőforrás-azonosítója

location

string

Az Azure-régió, ahol az erőforrás él

name

string

Az erőforrás neve

properties.creationTime

string

Lekéri vagy beállítja a létrehozási időt.

properties.description

string

Lekéri vagy beállítja a leírást.

properties.draft

RunbookDraft

Lekéri vagy beállítja a runbook piszkozattulajdonságokat.

properties.jobCount

integer

Lekéri vagy beállítja a runbook feladatszámát.

properties.lastModifiedBy

string

Lekéri vagy beállítja az utolsó módosítást.

properties.lastModifiedTime

string

Lekéri vagy beállítja az utolsó módosítás időpontját.

properties.logActivityTrace

integer

Lekéri vagy beállítja a runbook tevékenységkövetésének naplózási lehetőségét.

properties.logProgress

boolean

Lekéri vagy beállítja a folyamatnapló beállítását.

properties.logVerbose

boolean

Részletes naplóbeállítás lekérése vagy beállítása.

properties.outputTypes

string[]

Lekéri vagy beállítja a runbook kimeneti típusait.

properties.parameters

<string,  RunbookParameter>

Lekéri vagy beállítja a runbook paramétereit.

properties.provisioningState

RunbookProvisioningState

Lekéri vagy beállítja a runbook kiépítési állapotát.

properties.publishContentLink

ContentLink

Lekéri vagy beállítja a közzétett runbook tartalomhivatkozását.

properties.runbookType

RunbookTypeEnum

Lekéri vagy beállítja a runbook típusát.

properties.state

RunbookState

Lekéri vagy beállítja a runbook állapotát.

tags

object

Erőforráscímkék.

type

string

Az erőforrás típusa.

RunbookDraft

Name Típus Description
creationTime

string

Lekéri vagy beállítja a runbook piszkozatának létrehozási idejét.

draftContentLink

ContentLink

Lekéri vagy beállítja a runbook-tartalom piszkozathivatkozását.

inEdit

boolean

Lekérdezi vagy beállítja, hogy a runbook szerkesztési módban van-e.

lastModifiedTime

string

Lekéri vagy beállítja a runbook piszkozatának utolsó módosítási időpontját.

outputTypes

string[]

Lekéri vagy beállítja a runbook kimeneti típusait.

parameters

<string,  RunbookParameter>

Lekéri vagy beállítja a runbook piszkozatparamétereit.

RunbookListResult

A lista runbook-művelet válaszmodellje.

Name Típus Description
nextLink

string

Lekéri vagy beállítja a következő hivatkozást.

value

Runbook[]

Lekéri vagy beállítja a runbookok listáját.

RunbookParameter

A runbook paramétertípusának definíciója.

Name Típus Description
defaultValue

string

Lekéri vagy beállítja a paraméter alapértelmezett értékét.

isMandatory

boolean

Logikai értéket kap vagy állít be, amely jelzi, hogy a paraméter kötelező-e vagy sem.

position

integer

A paraméter pozíciójának lekérése vagy beállítása.

type

string

Lekéri vagy beállítja a paraméter típusát.

RunbookProvisioningState

Lekéri vagy beállítja a runbook kiépítési állapotát.

Name Típus Description
Succeeded

string

RunbookState

Lekéri vagy beállítja a runbook állapotát.

Name Típus Description
Edit

string

New

string

Published

string

RunbookTypeEnum

Lekéri vagy beállítja a runbook típusát.

Name Típus Description
Graph

string

GraphPowerShell

string

GraphPowerShellWorkflow

string

PowerShell

string

PowerShell72

string

PowerShellWorkflow

string

Python2

string

Python3

string

Script

string