Runbook - Update

Tjänst:

Automation

API-version:

2023-11-01

Uppdatera runbooken som identifieras med runbook-namnet.

PATCH 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 minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Namnet på en Azure-resursgrupp.
runbookName	path	True	string pattern: ^[a-zA-Z][a-zA-Z-_0-9]*$	Runbook-namnet.
subscriptionId	path	True	string	Hämtar prenumerationsautentiseringsuppgifter 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	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.logActivityTrace	integer (int32)	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.
tags	object	Hämtar eller anger taggarna som är kopplade till resursen.

Svar

Name	Typ	Description
200 OK	Runbook	OKEJ
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

Update runbook

Exempelbegäran

HTTP

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

{
  "properties": {
    "description": "Updated Description of the Runbook",
    "logVerbose": false,
    "logProgress": true,
    "logActivityTrace": 1
  }
}

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": "\"636265044994500000\"",
  "properties": {
    "description": "Updated Description of the Runbook",
    "logVerbose": false,
    "logProgress": true,
    "logActivityTrace": 1,
    "runbookType": "PowerShellWorkflow",
    "parameters": {},
    "state": "Published",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "outputTypes": [],
    "creationTime": "2017-03-30T21:01:33.777+00:00",
    "lastModifiedBy": "myEmaild@microsoft.com",
    "lastModifiedTime": "2017-03-30T21:01:39.45+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 runbookens typ.
RunbookUpdateParameters	Parametrarna som har angetts för uppdateringens runbook-åtgärd.

ContentHash

Objekt

Definition av runbook-egenskapstypen.

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

ContentLink

Objekt

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

Objekt

Felsvar på ett åtgärdsfel

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

Runbook

Objekt

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 (date-time)	Hämtar eller anger skapandetiden.
properties.description	string	Hämtar eller anger beskrivningen.
properties.draft	RunbookDraft	Hämtar eller anger utkastskörningsegenskaperna.
properties.jobCount	integer (int32)	Hämtar eller anger antalet jobb för runbooken.
properties.lastModifiedBy	string	Hämtar eller anger den senast ändrade av.
properties.lastModifiedTime	string (date-time)	Hämtar eller anger den senaste ändrade tiden.
properties.logActivityTrace	integer (int32)	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.

RunbookDraft

Objekt

Name	Typ	Description
creationTime	string (date-time)	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 (date-time)	Hämtar eller anger den senaste ändrade tiden för runbook-utkastet.
outputTypes	string[]	Hämtar eller anger runbook-utdatatyperna.
parameters	<string,  RunbookParameter>	Hämtar eller anger runbook-utkastparametrarna.

RunbookParameter

Objekt

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 (int32)	Hämta eller anger parameterns position.
type	string	Hämtar eller anger parametertypen.

RunbookProvisioningState

Uppräkning

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

Värde	Description
Succeeded

RunbookState

Uppräkning

Hämtar eller anger runbookens tillstånd.

Värde	Description
Edit
New
Published

RunbookTypeEnum

Uppräkning

Hämtar eller anger runbookens typ.

Värde	Description
Graph
GraphPowerShell
GraphPowerShellWorkflow
PowerShell
PowerShell72
PowerShellWorkflow
Python2
Python3
Script

RunbookUpdateParameters

Objekt

Parametrarna som har angetts för uppdateringens runbook-åtgärd.

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.logActivityTrace	integer (int32)	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.
tags	object	Hämtar eller anger taggarna som är kopplade till resursen.