Runbook - Create Or Update

Referens

Tjänst:: Automation

API-version:: 2023-11-01

Skapa runbooken som identifieras med runbook-namnet.

PUT 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å automationskontot.
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 prenumerationer som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Obligatorisk	Typ	Description
properties.runbookType	True	RunbookTypeEnum	Hämtar eller anger runbookens typ.
location		string	Hämtar eller anger platsen för resursen.
name		string	Hämtar eller anger namnet på resursen.
properties.description		string	Hämtar eller anger beskrivningen av runbooken.
properties.draft		RunbookDraft	Hämtar eller anger egenskaperna för utkast till runbook.
properties.logActivityTrace		integer	Hämtar eller anger spårningsalternativen på aktivitetsnivå för runbooken.
properties.logProgress		boolean	Hämtar eller anger förloppsloggalternativ.
properties.logVerbose		boolean	Hämtar eller anger utförligt loggalternativ.
properties.publishContentLink		ContentLink	Hämtar eller anger den publicerade runbook-innehållslänken.
tags		object	Hämtar eller anger de taggar som är kopplade till resursen.

Svar

Name	Typ	Description
200 OK	Runbook	OK
201 Created	Runbook	Skapad
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

Create or update runbook and publish it

Create runbook as draft

Create or update runbook and publish it

Exempelbegäran

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

Exempelsvar

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

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": "\"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

Exempelbegäran

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

Exempelsvar

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

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

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.
RunbookCreateOrUpdateParameters	Parametrarna som anges för åtgärden skapa eller uppdatera runbook.
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 runbookens typ.

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 resursens etag.
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 egenskaperna för utkast till runbook.
properties.jobCount	integer	Hämtar eller anger antalet jobb för runbooken.
properties.lastModifiedBy	string	Hämtar eller anger den senast ändrade av.
properties.lastModifiedTime	string	Hämtar eller anger den senast ändrade tiden.
properties.logActivityTrace	integer	Hämtar eller anger alternativet för att logga aktivitetsspårning av 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 runbookens typ.
properties.state	RunbookState	Hämtar eller anger runbookens tillstånd.
tags	object	Resurstaggar.
type	string	Resurstypen.

RunbookCreateOrUpdateParameters

Parametrarna som anges för åtgärden skapa eller uppdatera runbook.

Name	Typ	Description
location	string	Hämtar eller anger platsen för resursen.
name	string	Hämtar eller anger namnet på resursen.
properties.description	string	Hämtar eller anger beskrivningen av runbooken.
properties.draft	RunbookDraft	Hämtar eller anger egenskaperna för utkast till runbook.
properties.logActivityTrace	integer	Hämtar eller anger spårningsalternativen på aktivitetsnivå för runbooken.
properties.logProgress	boolean	Hämtar eller anger förloppsloggalternativ.
properties.logVerbose	boolean	Hämtar eller anger utförligt loggalternativ.
properties.publishContentLink	ContentLink	Hämtar eller anger den publicerade runbook-innehållslänken.
properties.runbookType	RunbookTypeEnum	Hämtar eller anger runbookens typ.
tags	object	Hämtar eller anger de taggar som är kopplade till resursen.

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 ange 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 runbookens typ.

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

Dela via

Runbook - Create Or Update

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Create or update runbook and publish it

Exempelbegäran

Exempelsvar

Create runbook as draft

Exempelbegäran

Exempelsvar

Definitioner

ContentHash

ContentLink

ErrorResponse

Runbook

RunbookCreateOrUpdateParameters

RunbookDraft

RunbookParameter

RunbookProvisioningState

RunbookState

RunbookTypeEnum

Ytterligare resurser