Runbook - Create Or Update

Reference

Služba:: Automation

Verze rozhraní API:: 2023-11-01

Vytvořte runbook identifikovaný názvem runbooku.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}?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 minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Název skupiny prostředků Azure
runbookName	path	True	string pattern: ^[a-zA-Z][a-zA-Z-_0-9]*$	Název runbooku.
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 tvoří součást identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.runbookType	True	RunbookTypeEnum	Získá nebo nastaví typ runbooku.
location		string	Získá nebo nastaví umístění prostředku.
name		string	Získá nebo nastaví název prostředku.
properties.description		string	Získá nebo nastaví popis runbooku.
properties.draft		RunbookDraft	Získá nebo nastaví vlastnosti konceptu runbooku.
properties.logActivityTrace		integer (int32)	Získá nebo nastaví možnosti trasování na úrovni 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.publishContentLink		ContentLink	Získá nebo nastaví publikovaný odkaz na obsah runbooku.
tags		object	Získá nebo nastaví značky připojené k prostředku.

Odpovědi

Name	Typ	Description
200 OK	Runbook	OK
201 Created	Runbook	Vytvořil
Other Status Codes	ErrorResponse	Odpověď na chybu automatizace popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

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

Create or update runbook and publish it

Create runbook as draft

Create or update runbook and publish it

Ukázkový požadavek

HTTP

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

{
  "properties": {
    "logVerbose": false,
    "logProgress": true,
    "runbookType": "PowerShellWorkflow",
    "publishContentLink": {
      "uri": "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1",
      "contentHash": {
        "algorithm": "SHA256",
        "value": "115775B8FF2BE672D8A946BD0B489918C724DDE15A440373CA54461D53010A80"
      }
    },
    "description": "Description of the Runbook",
    "logActivityTrace": 1
  },
  "name": "Get-AzureVMTutorial",
  "location": "East US 2",
  "tags": {
    "tag01": "value01",
    "tag02": "value02"
  }
}

Ukázková odpověď

Stavový kód:: 201

{
  "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": "\"636263318837230000\"",
  "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:04:43.66+00:00",
    "lastModifiedBy": "myEmaild@microsoft.com",
    "lastModifiedTime": "2017-03-28T21:04:43.723+00:00"
  }
}

Stavový kód:: 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": "\"636263318866000000\"",
  "properties": {
    "description": "Description of the Runbook",
    "logVerbose": true,
    "logProgress": true,
    "logActivityTrace": 1,
    "runbookType": "PowerShellWorkflow",
    "parameters": {},
    "state": "Published",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "outputTypes": [],
    "creationTime": "2017-03-28T21:04:43.66+00:00",
    "lastModifiedBy": "myEmaild@microsoft.com",
    "lastModifiedTime": "2017-03-28T21:04:46.6+00:00"
  }
}

Create runbook as draft

Ukázkový požadavek

HTTP

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

{
  "properties": {
    "logVerbose": false,
    "logProgress": false,
    "runbookType": "PowerShellWorkflow",
    "description": "Description of the Runbook",
    "draft": {}
  },
  "name": "Get-AzureVMTutorial",
  "location": "East US 2",
  "tags": {
    "tag01": "value01",
    "tag02": "value02"
  }
}

Ukázková odpověď

Stavový kód:: 201

{
  "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": "\"636263318837230000\"",
  "properties": {
    "description": "Description of the Runbook",
    "logVerbose": false,
    "logProgress": false,
    "logActivityTrace": 0,
    "runbookType": "Script",
    "parameters": {},
    "state": "New",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "creationTime": "2018-02-09T03:25:59.097+00:00",
    "lastModifiedTime": "2018-02-09T03:25:59.097+00:00",
    "outputTypes": []
  }
}

Stavový kód:: 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": "\"636263318866000000\"",
  "properties": {
    "description": "Description of the Runbook",
    "logVerbose": false,
    "logProgress": false,
    "logActivityTrace": 0,
    "runbookType": "Script",
    "parameters": {},
    "state": "New",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "creationTime": "2018-02-09T03:25:59.097+00:00",
    "lastModifiedTime": "2018-02-09T03:25:59.097+00:00"
  }
}

Definice

Name	Description
ContentHash	Definice typu vlastnosti runbooku
ContentLink	Definice odkazu na obsah
ErrorResponse	Chybová odpověď selhání operace
Runbook	Definice typu runbooku
RunbookCreateOrUpdateParameters	Parametry zadané pro operaci vytvoření nebo aktualizace runbooku.
RunbookDraft
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

Objekt

Definice typu vlastnosti runbooku

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

ContentLink

Objekt

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

Objekt

Chybová odpověď selhání operace

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

Runbook

Objekt

Definice typu runbooku

Name	Typ	Description
etag	string	Získá nebo nastaví značku 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 (date-time)	Získá nebo nastaví čas vytvoření.
properties.description	string	Získá nebo nastaví popis.
properties.draft	RunbookDraft	Získá nebo nastaví vlastnosti konceptu runbooku.
properties.jobCount	integer (int32)	Získá nebo nastaví počet úloh runbooku.
properties.lastModifiedBy	string	Získá nebo nastaví naposledy změněno.
properties.lastModifiedTime	string (date-time)	Získá nebo nastaví čas poslední změny.
properties.logActivityTrace	integer (int32)	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í publikovaný odkaz na obsah runbooku.
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.

RunbookCreateOrUpdateParameters

Objekt

Parametry zadané pro operaci vytvoření nebo aktualizace runbooku.

Name	Typ	Description
location	string	Získá nebo nastaví umístění prostředku.
name	string	Získá nebo nastaví název prostředku.
properties.description	string	Získá nebo nastaví popis runbooku.
properties.draft	RunbookDraft	Získá nebo nastaví vlastnosti konceptu runbooku.
properties.logActivityTrace	integer (int32)	Získá nebo nastaví možnosti trasování na úrovni 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.publishContentLink	ContentLink	Získá nebo nastaví publikovaný odkaz na obsah runbooku.
properties.runbookType	RunbookTypeEnum	Získá nebo nastaví typ runbooku.
tags	object	Získá nebo nastaví značky připojené k prostředku.

RunbookDraft

Objekt

Name	Typ	Description
creationTime	string (date-time)	Získá nebo nastaví čas vytvoření konceptu runbooku.
draftContentLink	ContentLink	Získá nebo nastaví odkaz na obsah konceptu runbooku.
inEdit	boolean	Získá nebo nastaví, zda runbook je v režimu úprav.
lastModifiedTime	string (date-time)	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.

RunbookParameter

Objekt

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 označující, zda je parametr povinný, nebo ne.
position	integer (int32)	Získá nebo nastaví pozici parametru.
type	string	Získá nebo nastaví typ parametru.

RunbookProvisioningState

Výčet

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

Hodnota	Description
Succeeded

RunbookState

Výčet

Získá nebo nastaví stav runbooku.

Hodnota	Description
Edit
New
Published

RunbookTypeEnum

Výčet

Získá nebo nastaví typ runbooku.

Hodnota	Description
Graph
GraphPowerShell
GraphPowerShellWorkflow
PowerShell
PowerShell72
PowerShellWorkflow
Python2
Python3
Script

Sdílet prostřednictvím

Runbook - Create Or Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Create or update runbook and publish it

Ukázkový požadavek

Ukázková odpověď

Create runbook as draft

Ukázkový požadavek

Ukázková odpověď

Definice

ContentHash

ContentLink

ErrorResponse

Runbook

RunbookCreateOrUpdateParameters

RunbookDraft

RunbookParameter

RunbookProvisioningState

RunbookState

RunbookTypeEnum

Další materiály