Runbook - Create Or Update

リファレンス

サービス:: Automation

API バージョン:: 2023-11-01

Runbook 名で識別される Runbook を作成します。

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

URI パラメーター

名前	/	必須	型	説明
automationAccountName	path	True	string	Automation アカウントの名前。
resourceGroupName	path	True	string	Azure リソースグループの名前。正規表現パターン: `^[-\w\._]+$`
runbookName	path	True	string	Runbook 名。正規表現パターン: `^[a-zA-Z][a-zA-Z-_0-9]*$`
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報を取得します。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	必須	型	説明
properties.runbookType	True	RunbookTypeEnum	Runbook の種類を取得または設定します。
location		string	リソースの場所を取得または設定します。
name		string	リソースの名前を取得または設定します。
properties.description		string	Runbook の説明を取得または設定します。
properties.draft		RunbookDraft	下書き Runbook プロパティを取得または設定します。
properties.logActivityTrace		integer	Runbook のアクティビティレベルのトレースオプションを取得または設定します。
properties.logProgress		boolean	進行状況ログオプションを取得または設定します。
properties.logVerbose		boolean	詳細ログオプションを取得または設定します。
properties.publishContentLink		ContentLink	発行された Runbook コンテンツリンクを取得または設定します。
tags		object	リソースに接続されているタグを取得または設定します。

応答

名前	型	説明
200 OK	Runbook	OK
201 Created	Runbook	作成済み
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するオートメーションエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Create or update runbook and publish it

Create runbook as draft

Create or update runbook and publish it

要求のサンプル

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

応答のサンプル

状態コード:: 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"
  }
}

状態コード:: 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

要求のサンプル

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

応答のサンプル

状態コード:: 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": []
  }
}

状態コード:: 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"
  }
}

定義

名前	説明
ContentHash	Runbook プロパティの種類の定義。
ContentLink	コンテンツリンクの定義。
ErrorResponse	操作エラーのエラー応答
Runbook	Runbook の種類の定義。
RunbookCreateOrUpdateParameters	Runbook の作成または更新操作に指定されたパラメーター。
RunbookDraft
RunbookParameter	Runbook パラメーターの種類の定義。
RunbookProvisioningState	Runbook のプロビジョニング状態を取得または設定します。
RunbookState	Runbook の状態を取得または設定します。
RunbookTypeEnum	Runbook の種類を取得または設定します。

ContentHash

Runbook プロパティの種類の定義。

名前	型	説明
algorithm	string	コンテンツのハッシュに使用するコンテンツハッシュアルゴリズムを取得または設定します。
value	string	コンテンツの予想されるハッシュ値を取得または設定します。

ContentLink

コンテンツリンクの定義。

名前	型	説明
contentHash	ContentHash	ハッシュを設定します。
uri	string	コンテンツの URI を設定します。
version	string	コンテンツのバージョンを設定します。

ErrorResponse

操作エラーのエラー応答

名前	型	説明
code	string	エラーコード
message	string	操作が失敗した理由を示すエラーメッセージ。

Runbook

Runbook の種類の定義。

名前	型	説明
etag	string	リソースの etag を取得または設定します。
id	string	リソースの完全修飾リソース ID
location	string	リソースが保存されている Azure リージョン
name	string	リソースの名前
properties.creationTime	string	作成時刻を取得または設定します。
properties.description	string	説明を取得または設定します。
properties.draft	RunbookDraft	下書き Runbook プロパティを取得または設定します。
properties.jobCount	integer	Runbook のジョブ数を取得または設定します。
properties.lastModifiedBy	string	最後に変更されたを取得または設定します。
properties.lastModifiedTime	string	最終変更時刻を取得または設定します。
properties.logActivityTrace	integer	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	リソースの型。

RunbookCreateOrUpdateParameters

Runbook の作成または更新操作に指定されたパラメーター。

名前	型	説明
location	string	リソースの場所を取得または設定します。
name	string	リソースの名前を取得または設定します。
properties.description	string	Runbook の説明を取得または設定します。
properties.draft	RunbookDraft	下書き Runbook プロパティを取得または設定します。
properties.logActivityTrace	integer	Runbook のアクティビティレベルのトレースオプションを取得または設定します。
properties.logProgress	boolean	進行状況ログオプションを取得または設定します。
properties.logVerbose	boolean	詳細ログオプションを取得または設定します。
properties.publishContentLink	ContentLink	発行された Runbook コンテンツリンクを取得または設定します。
properties.runbookType	RunbookTypeEnum	Runbook の種類を取得または設定します。
tags	object	リソースに接続されているタグを取得または設定します。

RunbookDraft

名前	型	説明
creationTime	string	Runbook ドラフトの作成時間を取得または設定します。
draftContentLink	ContentLink	下書き Runbook コンテンツリンクを取得または設定します。
inEdit	boolean	Runbook が編集モードかどうかを取得または設定します。
lastModifiedTime	string	Runbook ドラフトの最終変更時刻を取得または設定します。
outputTypes	string[]	Runbook 出力の種類を取得または設定します。
parameters	<string, RunbookParameter>	Runbook の下書きパラメーターを取得または設定します。

RunbookParameter

Runbook パラメーターの種類の定義。

名前	型	説明
defaultValue	string	パラメーターの既定値を取得または設定します。
isMandatory	boolean	パラメーターが必須かどうかを示すブール値を取得または設定します。
position	integer	パラメーターの位置を取得または設定します。
type	string	パラメーターの型を取得または設定します。

RunbookProvisioningState

Runbook のプロビジョニング状態を取得または設定します。

名前	型	説明
Succeeded	string

RunbookState

Runbook の状態を取得または設定します。

名前	型	説明
Edit	string
New	string
Published	string

RunbookTypeEnum

Runbook の種類を取得または設定します。

名前	型	説明
Graph	string
GraphPowerShell	string
GraphPowerShellWorkflow	string
PowerShell	string
PowerShell72	string
PowerShellWorkflow	string
Python2	string
Python3	string
Script	string

次の方法で共有

Runbook - Create Or Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

Create or update runbook and publish it

要求のサンプル

応答のサンプル

Create runbook as draft

要求のサンプル

応答のサンプル

定義

ContentHash

ContentLink

ErrorResponse

Runbook

RunbookCreateOrUpdateParameters

RunbookDraft

RunbookParameter

RunbookProvisioningState

RunbookState

RunbookTypeEnum

その他のリソース