Runbook - Update

서비스:: Automation

API 버전:: 2023-11-01

Runbook 이름으로 식별되는 Runbook을 업데이트합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
automationAccountName	path	True	string	자동화 계정의 이름입니다.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Azure 리소스 그룹의 이름입니다.
runbookName	path	True	string pattern: ^[a-zA-Z][a-zA-Z-_0-9]*$	Runbook 이름입니다.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명을 가져옵니다. 구독 ID는 모든 서비스 호출에 대한 URI의 일부를 형성합니다.
api-version	query	True	string	클라이언트 API 버전입니다.

요청 본문

Name	형식	Description
location	string	리소스의 위치를 가져오거나 설정합니다.
name	string	리소스의 이름을 가져오거나 설정합니다.
properties.description	string	Runbook에 대한 설명을 가져오거나 설정합니다.
properties.logActivityTrace	integer (int32)	Runbook의 활동 수준 추적 옵션을 가져오거나 설정합니다.
properties.logProgress	boolean	진행률 로그 옵션을 가져오거나 설정합니다.
properties.logVerbose	boolean	자세한 정보 표시 로그 옵션을 가져오거나 설정합니다.
tags	object	리소스에 연결된 태그를 가져오거나 설정합니다.

응답

Name	형식	Description
200 OK	Runbook	그래
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 자동화 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Update runbook

샘플 요청

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

샘플 응답

상태 코드:: 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"
  }
}

정의

Name	Description
ContentHash	Runbook 속성 형식의 정의입니다.
ContentLink	콘텐츠 링크의 정의입니다.
ErrorResponse	작업 실패의 오류 응답
Runbook	Runbook 형식의 정의입니다.
RunbookDraft
RunbookParameter	Runbook 매개 변수 형식의 정의입니다.
RunbookProvisioningState	Runbook의 프로비저닝 상태를 가져오거나 설정합니다.
RunbookState	Runbook의 상태를 가져오거나 설정합니다.
RunbookTypeEnum	Runbook의 형식을 가져오거나 설정합니다.
RunbookUpdateParameters	Runbook 업데이트 작업에 제공된 매개 변수입니다.

ContentHash

Object

Runbook 속성 형식의 정의입니다.

Name	형식	Description
algorithm	string	콘텐츠를 해시하는 데 사용되는 콘텐츠 해시 알고리즘을 가져오거나 설정합니다.
value	string	콘텐츠의 예상 해시 값을 가져오거나 설정합니다.

ContentLink

Object

콘텐츠 링크의 정의입니다.

Name	형식	Description
contentHash	ContentHash	해시를 설정합니다.
uri	string	콘텐츠의 URI를 설정합니다.
version	string	콘텐츠의 버전을 설정합니다.

ErrorResponse

Object

작업 실패의 오류 응답

Name	형식	Description
code	string	오류 코드
message	string	작업이 실패한 이유를 나타내는 오류 메시지입니다.

Runbook

Object

Runbook 형식의 정의입니다.

Name	형식	Description
etag	string	리소스의 etag를 가져오거나 설정합니다.
id	string	리소스에 대한 정규화된 리소스 ID
location	string	리소스가 있는 Azure 지역
name	string	리소스의 이름
properties.creationTime	string (date-time)	생성 시간을 가져오거나 설정합니다.
properties.description	string	설명을 가져오거나 설정합니다.
properties.draft	RunbookDraft	초안 Runbook 속성을 가져오거나 설정합니다.
properties.jobCount	integer (int32)	Runbook의 작업 수를 가져오거나 설정합니다.
properties.lastModifiedBy	string	마지막으로 수정한 값을 가져오거나 설정합니다.
properties.lastModifiedTime	string (date-time)	마지막으로 수정한 시간을 가져오거나 설정합니다.
properties.logActivityTrace	integer (int32)	Runbook의 활동 추적을 기록하는 옵션을 가져오거나 설정합니다.
properties.logProgress	boolean	진행률 로그 옵션을 가져오거나 설정합니다.
properties.logVerbose	boolean	자세한 정보 표시 로그 옵션을 가져오거나 설정합니다.
properties.outputTypes	string[]	Runbook 출력 형식을 가져오거나 설정합니다.
properties.parameters	<string, RunbookParameter>	Runbook 매개 변수를 가져오거나 설정합니다.
properties.provisioningState	RunbookProvisioningState	Runbook의 프로비저닝 상태를 가져오거나 설정합니다.
properties.publishContentLink	ContentLink	게시된 Runbook 콘텐츠 링크를 가져오거나 설정합니다.
properties.runbookType	RunbookTypeEnum	Runbook의 형식을 가져오거나 설정합니다.
properties.state	RunbookState	Runbook의 상태를 가져오거나 설정합니다.
tags	object	리소스 태그.
type	string	리소스의 형식입니다.

RunbookDraft

Object

Name	형식	Description
creationTime	string (date-time)	Runbook 초안의 생성 시간을 가져오거나 설정합니다.
draftContentLink	ContentLink	초안 Runbook 콘텐츠 링크를 가져오거나 설정합니다.
inEdit	boolean	Runbook이 편집 모드에 있는지 여부를 가져오거나 설정합니다.
lastModifiedTime	string (date-time)	Runbook 초안의 마지막으로 수정된 시간을 가져오거나 설정합니다.
outputTypes	string[]	Runbook 출력 형식을 가져오거나 설정합니다.
parameters	<string, RunbookParameter>	Runbook 초안 매개 변수를 가져오거나 설정합니다.

RunbookParameter

Object

Runbook 매개 변수 형식의 정의입니다.

Name	형식	Description
defaultValue	string	매개 변수의 기본값을 가져오거나 설정합니다.
isMandatory	boolean	매개 변수가 필수인지 여부를 나타내는 부울 값을 가져오거나 설정합니다.
position	integer (int32)	매개 변수의 위치를 가져오기 또는 설정합니다.
type	string	매개 변수의 형식을 가져오거나 설정합니다.

RunbookProvisioningState

열거형

Runbook의 프로비저닝 상태를 가져오거나 설정합니다.

값	Description
Succeeded

RunbookState

열거형

Runbook의 상태를 가져오거나 설정합니다.

값	Description
Edit
New
Published

RunbookTypeEnum

열거형

Runbook의 형식을 가져오거나 설정합니다.

값	Description
Graph
GraphPowerShell
GraphPowerShellWorkflow
PowerShell
PowerShell72
PowerShellWorkflow
Python2
Python3
Script

RunbookUpdateParameters

Object

Runbook 업데이트 작업에 제공된 매개 변수입니다.

Name	형식	Description
location	string	리소스의 위치를 가져오거나 설정합니다.
name	string	리소스의 이름을 가져오거나 설정합니다.
properties.description	string	Runbook에 대한 설명을 가져오거나 설정합니다.
properties.logActivityTrace	integer (int32)	Runbook의 활동 수준 추적 옵션을 가져오거나 설정합니다.
properties.logProgress	boolean	진행률 로그 옵션을 가져오거나 설정합니다.
properties.logVerbose	boolean	자세한 정보 표시 로그 옵션을 가져오거나 설정합니다.
tags	object	리소스에 연결된 태그를 가져오거나 설정합니다.

다음을 통해 공유

Runbook - Update

URI 매개 변수

요청 본문

응답

보안

azure_auth

범위

예제

Update runbook

샘플 요청

샘플 응답

정의

ContentHash

ContentLink

ErrorResponse

Runbook

RunbookDraft

RunbookParameter

RunbookProvisioningState

RunbookState

RunbookTypeEnum

RunbookUpdateParameters