Runbook - Update

Odwołanie

Usługa:: Automation

Wersja interfejsu API:: 2023-11-01

Zaktualizuj element Runbook zidentyfikowany przez nazwę elementu Runbook.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
automationAccountName	path	True	string	Nazwa konta usługi Automation.
resourceGroupName	path	True	string	Nazwa grupy zasobów platformy Azure. Wzorzec wyrażenia regularnego: `^[-\w\._]+$`
runbookName	path	True	string	Nazwa elementu runbook. Wzorzec wyrażenia regularnego: `^[a-zA-Z][a-zA-Z-_0-9]*$`
subscriptionId	path	True	string	Pobiera poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
location	string	Pobiera lub ustawia lokalizację zasobu.
name	string	Pobiera lub ustawia nazwę zasobu.
properties.description	string	Pobiera lub ustawia opis elementu Runbook.
properties.logActivityTrace	integer	Pobiera lub ustawia opcje śledzenia na poziomie działania elementu Runbook.
properties.logProgress	boolean	Pobiera lub ustawia opcję dziennika postępu.
properties.logVerbose	boolean	Pobiera lub ustawia opcję pełnego dziennika.
tags	object	Pobiera lub ustawia tagi dołączone do zasobu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Runbook	OK
Other Status Codes	ErrorResponse	Odpowiedź na błąd automatyzacji opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Update runbook

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Definicje

Nazwa	Opis
ContentHash	Definicja typu właściwości elementu Runbook.
ContentLink	Definicja linku zawartości.
ErrorResponse	Odpowiedź na błąd niepowodzenia operacji
Runbook	Definicja typu elementu Runbook.
RunbookDraft
RunbookParameter	Definicja typu parametru elementu Runbook.
RunbookProvisioningState	Pobiera lub ustawia stan aprowizacji elementu Runbook.
RunbookState	Pobiera lub ustawia stan elementu Runbook.
RunbookTypeEnum	Pobiera lub ustawia typ elementu Runbook.
RunbookUpdateParameters	Parametry dostarczone do operacji elementu Runbook aktualizacji.

ContentHash

Definicja typu właściwości elementu Runbook.

Nazwa	Typ	Opis
algorithm	string	Pobiera lub ustawia algorytm wyznaczania wartości skrótu zawartości używany do wyznaczania wartości skrótu zawartości.
value	string	Pobiera lub ustawia oczekiwaną wartość skrótu zawartości.

ContentLink

Definicja linku zawartości.

Nazwa	Typ	Opis
contentHash	ContentHash	Ustawia skrót.
uri	string	Ustawia identyfikator URI zawartości.
version	string	Ustawia wersję zawartości.

ErrorResponse

Odpowiedź na błąd niepowodzenia operacji

Nazwa	Typ	Opis
code	string	Kod błędu
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

Runbook

Definicja typu elementu Runbook.

Nazwa	Typ	Opis
etag	string	Pobiera lub ustawia element etag zasobu.
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu
location	string	Region świadczenia usługi Azure, w którym znajduje się zasób
name	string	Nazwa zasobu
properties.creationTime	string	Pobiera lub ustawia czas tworzenia.
properties.description	string	Pobiera lub ustawia opis.
properties.draft	RunbookDraft	Pobiera lub ustawia właściwości roboczego elementu Runbook.
properties.jobCount	integer	Pobiera lub ustawia liczbę zadań elementu Runbook.
properties.lastModifiedBy	string	Pobiera lub ustawia ostatnią modyfikację przez.
properties.lastModifiedTime	string	Pobiera lub ustawia czas ostatniej modyfikacji.
properties.logActivityTrace	integer	Pobiera lub ustawia opcję rejestrowania śladu aktywności elementu Runbook.
properties.logProgress	boolean	Pobiera lub ustawia opcję dziennika postępu.
properties.logVerbose	boolean	Pobiera lub ustawia opcję pełnego dziennika.
properties.outputTypes	string[]	Pobiera lub ustawia typy danych wyjściowych elementu Runbook.
properties.parameters	<string, RunbookParameter>	Pobiera lub ustawia parametry elementu Runbook.
properties.provisioningState	RunbookProvisioningState	Pobiera lub ustawia stan aprowizacji elementu Runbook.
properties.publishContentLink	ContentLink	Pobiera lub ustawia opublikowany link zawartości elementu Runbook.
properties.runbookType	RunbookTypeEnum	Pobiera lub ustawia typ elementu Runbook.
properties.state	RunbookState	Pobiera lub ustawia stan elementu Runbook.
tags	object	Tagi zasobów.
type	string	Typ zasobu.

RunbookDraft

Nazwa	Typ	Opis
creationTime	string	Pobiera lub ustawia czas tworzenia wersji roboczej elementu Runbook.
draftContentLink	ContentLink	Pobiera lub ustawia link zawartości roboczej elementu Runbook.
inEdit	boolean	Pobiera lub ustawia, czy element Runbook jest w trybie edycji.
lastModifiedTime	string	Pobiera lub ustawia czas ostatniej modyfikacji wersji roboczej elementu Runbook.
outputTypes	string[]	Pobiera lub ustawia typy danych wyjściowych elementu Runbook.
parameters	<string, RunbookParameter>	Pobiera lub ustawia parametry robocze elementu Runbook.

RunbookParameter

Definicja typu parametru elementu Runbook.

Nazwa	Typ	Opis
defaultValue	string	Pobiera lub ustawia wartość domyślną parametru.
isMandatory	boolean	Pobiera lub ustawia wartość logiczną, aby wskazać, czy parametr jest obowiązkowy, czy nie.
position	integer	Pobierz lub ustawia położenie parametru.
type	string	Pobiera lub ustawia typ parametru.

RunbookProvisioningState

Pobiera lub ustawia stan aprowizacji elementu Runbook.

Nazwa	Typ	Opis
Succeeded	string

RunbookState

Pobiera lub ustawia stan elementu Runbook.

Nazwa	Typ	Opis
Edit	string
New	string
Published	string

RunbookTypeEnum

Pobiera lub ustawia typ elementu Runbook.

Nazwa	Typ	Opis
Graph	string
GraphPowerShell	string
GraphPowerShellWorkflow	string
PowerShell	string
PowerShell72	string
PowerShellWorkflow	string
Python2	string
Python3	string
Script	string

RunbookUpdateParameters

Parametry dostarczone do operacji elementu Runbook aktualizacji.

Nazwa	Typ	Opis
location	string	Pobiera lub ustawia lokalizację zasobu.
name	string	Pobiera lub ustawia nazwę zasobu.
properties.description	string	Pobiera lub ustawia opis elementu Runbook.
properties.logActivityTrace	integer	Pobiera lub ustawia opcje śledzenia na poziomie działania elementu Runbook.
properties.logProgress	boolean	Pobiera lub ustawia opcję dziennika postępu.
properties.logVerbose	boolean	Pobiera lub ustawia opcję pełnego dziennika.
tags	object	Pobiera lub ustawia tagi dołączone do zasobu.

Udostępnij za pośrednictwem