Microsoft.Compute virtualMachines/runCommands 2023-03-01
[アーティクル] 03/07/2024
1 人の共同作成者
フィードバック
この記事の内容
Bicep リソース定義
virtualMachines/runCommands リソースの種類は、次をターゲットとする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ 」を参照してください。
Microsoft.Compute/virtualMachines/runCommands リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Compute/virtualMachines/runCommands@2023-03-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
asyncExecution: bool
errorBlobManagedIdentity: {
clientId: 'string'
objectId: 'string'
}
errorBlobUri: 'string'
outputBlobManagedIdentity: {
clientId: 'string'
objectId: 'string'
}
outputBlobUri: 'string'
parameters: [
{
name: 'string'
value: 'string'
}
]
protectedParameters: [
{
name: 'string'
value: 'string'
}
]
runAsPassword: 'string'
runAsUser: 'string'
source: {
commandId: 'string'
script: 'string'
scriptUri: 'string'
scriptUriManagedIdentity: {
clientId: 'string'
objectId: 'string'
}
}
timeoutInSeconds: int
treatFailureAsDeploymentFailure: bool
}
}
プロパティ値
virtualMachines/runCommands
VirtualMachineRunCommandProperties
名前
説明
値
asyncExecution
省略可能。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトの完了を待機しません。
[bool]
errorBlobManagedIdentity
errorBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てで、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID とコマンドの実行の詳細については、 と を参照してください https://aka.ms/ManagedIdentity
。 https://aka.ms/RunCommandManaged
RunCommandManagedIdentity
errorBlobUri
スクリプト エラー ストリームをアップロードする Azure ストレージ BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 errorBlobManagedIdentity パラメーターを参照してください。
string
outputBlobManagedIdentity
outputBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てで、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID とコマンドの実行の詳細については、 と を参照してください https://aka.ms/ManagedIdentity
。 https://aka.ms/RunCommandManaged
RunCommandManagedIdentity
outputBlobUri
スクリプト出力ストリームをアップロードする Azure ストレージ BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 outputBlobManagedIdentity パラメーターを参照してください。
string
parameters
スクリプトで使用されるパラメーター。
RunCommandInputParameter []
protectedParameters
スクリプトで使用されるパラメーター。
RunCommandInputParameter []
runAsPassword
実行コマンドの実行時に VM のユーザー アカウント パスワードを指定します。
string
runAsUser
run コマンドの実行時に VM 上のユーザー アカウントを指定します。
string
source
run コマンド スクリプトのソース。
VirtualMachineRunCommandScriptSource
timeoutInSeconds
実行コマンドを実行するためのタイムアウト (秒単位)。
INT
treatFailureAsDeploymentFailure
省略可能。 true に設定すると、スクリプト内のエラーはデプロイに失敗し、ProvisioningState は Failed としてマークされます。 false に設定すると、ProvisioningState は、実行コマンドが拡張機能プラットフォームによって実行されたかどうかのみが反映されます。スクリプトが失敗した場合にスクリプトが失敗したかどうかは示されません。 スクリプトエラーが発生した場合は、run コマンドのインスタンス ビューを参照して、executionMessage、output、error を確認します。 https://aka.ms/runcommandmanaged#get-execution-status-and-results
[bool]
RunCommandManagedIdentity
名前
説明
値
clientId
ユーザー割り当てマネージド ID のクライアント ID (GUID 値)。 ObjectId を指定する場合は使用しないでください。
string
objectId
ユーザー割り当てマネージド ID のオブジェクト ID (GUID 値)。 これが指定されている場合は、ClientId を使用しないでください。
string
名前
説明
値
name
run コマンド パラメーター名。
string (必須)
value
run コマンド パラメーターの値。
string (必須)
VirtualMachineRunCommandScriptSource
名前
説明
値
commandId
定義済みの組み込みスクリプトの commandId を指定します。
string
script
VM で実行するスクリプト コンテンツを指定します。
string
scriptUri
スクリプトのダウンロード場所を指定します。 読み取りアクセス権を持つ Azure ストレージ BLOB の SAS URI またはパブリック URI のいずれかを指定できます。
string
scriptUriManagedIdentity
Azure ストレージ BLOB の場合に scriptUri にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 Azure ストレージ BLOB が存在し、マネージド ID に "ストレージ BLOB データ閲覧者" ロールの割り当てで BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID に追加してください。 マネージド ID とコマンドの実行の詳細については、 と を参照してください https://aka.ms/ManagedIdentity
。 https://aka.ms/RunCommandManaged.
RunCommandManagedIdentity
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template
説明
SharePoint サブスクリプション / 2019 / 2016 / 2013 すべて構成済み
このテンプレートは、ADFS とのフェデレーション認証、OAuth 信頼、ユーザー プロファイル サービス、複数のパス ベースおよびホスト名付きサイト コレクションを含む 2 つのゾーンを含む Web アプリケーションなど、手動で実行するのに時間がかかる広範な構成を備えた SharePoint サブスクリプション / 2019 / 2016 / 2013 ファームを作成します。 SharePoint 仮想マシンでは、Chocolatey を使用して、最新バージョンの Notepad++、Visual Studio Code、Azure Data Studio、Fiddler、ULS Viewer、7-Zip をインストールします。
ARM テンプレート リソース定義
virtualMachines/runCommands リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ 」を参照してください。
Microsoft.Compute/virtualMachines/runCommands リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Compute/virtualMachines/runCommands",
"apiVersion": "2023-03-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"asyncExecution": "bool",
"errorBlobManagedIdentity": {
"clientId": "string",
"objectId": "string"
},
"errorBlobUri": "string",
"outputBlobManagedIdentity": {
"clientId": "string",
"objectId": "string"
},
"outputBlobUri": "string",
"parameters": [
{
"name": "string",
"value": "string"
}
],
"protectedParameters": [
{
"name": "string",
"value": "string"
}
],
"runAsPassword": "string",
"runAsUser": "string",
"source": {
"commandId": "string",
"script": "string",
"scriptUri": "string",
"scriptUriManagedIdentity": {
"clientId": "string",
"objectId": "string"
}
},
"timeoutInSeconds": "int",
"treatFailureAsDeploymentFailure": "bool"
}
}
プロパティ値
virtualMachines/runCommands
名前
説明
値
type
リソースの種類
'Microsoft.Compute/virtualMachines/runCommands'
apiVersion
リソース API のバージョン
'2023-03-01'
name
リソース名JSON ARM テンプレート で子リソースの名前と型を設定する方法を参照してください。
string (必須)
location
リソースの場所
string (必須)
tags
リソース タグ
タグ名と値のディクショナリ。 「テンプレートのタグ」を 参照してください
properties
仮想マシンの実行コマンドのプロパティについて説明します。
VirtualMachineRunCommandProperties
VirtualMachineRunCommandProperties
名前
説明
値
asyncExecution
省略可能。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトの完了を待機しません。
[bool]
errorBlobManagedIdentity
errorBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てで、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID に追加してください。 マネージド ID とコマンドの実行の詳細については、 と を参照してください https://aka.ms/ManagedIdentity
。 https://aka.ms/RunCommandManaged
RunCommandManagedIdentity
errorBlobUri
スクリプト エラー ストリームをアップロードする Azure ストレージ BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 errorBlobManagedIdentity パラメーターを参照してください。
string
outputBlobManagedIdentity
outputBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てで、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID とコマンドの実行の詳細については、 と を参照してください https://aka.ms/ManagedIdentity
。 https://aka.ms/RunCommandManaged
RunCommandManagedIdentity
outputBlobUri
スクリプト出力ストリームをアップロードする Azure ストレージ BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 outputBlobManagedIdentity パラメーターを参照してください。
string
parameters
スクリプトで使用されるパラメーター。
RunCommandInputParameter []
protectedParameters
スクリプトで使用されるパラメーター。
RunCommandInputParameter []
runAsPassword
実行コマンドの実行時に VM のユーザー アカウント パスワードを指定します。
string
runAsUser
run コマンドの実行時に VM 上のユーザー アカウントを指定します。
string
source
run コマンド スクリプトのソース。
VirtualMachineRunCommandScriptSource
timeoutInSeconds
実行コマンドを実行するためのタイムアウト (秒単位)。
INT
treatFailureAsDeploymentFailure
省略可能。 true に設定すると、スクリプト内のエラーはデプロイに失敗し、ProvisioningState は Failed としてマークされます。 false に設定すると、ProvisioningState は、実行コマンドが拡張機能プラットフォームによって実行されたかどうかのみが反映されます。スクリプトが失敗した場合にスクリプトが失敗したかどうかは示されません。 スクリプトエラーが発生した場合の run コマンドのインスタンス ビューを参照して、executionMessage、output、error を表示します。 https://aka.ms/runcommandmanaged#get-execution-status-and-results
[bool]
RunCommandManagedIdentity
名前
説明
値
clientId
ユーザー割り当てマネージド ID のクライアント ID (GUID 値)。 これが指定されている場合は、ObjectId を使用しないでください。
string
objectId
ユーザー割り当てマネージド ID のオブジェクト ID (GUID 値)。 これが指定されている場合は、ClientId を使用しないでください。
string
名前
説明
値
name
run コマンド パラメーター名。
string (必須)
value
run コマンド パラメーターの値。
string (必須)
VirtualMachineRunCommandScriptSource
名前
説明
値
commandId
定義済みの組み込みスクリプトの commandId を指定します。
string
script
VM で実行するスクリプト コンテンツを指定します。
string
scriptUri
スクリプトのダウンロード場所を指定します。 読み取りアクセス権を持つ Azure ストレージ BLOB の SAS URI またはパブリック URI のいずれかを指定できます。
string
scriptUriManagedIdentity
Azure Storage BLOB の場合に scriptUri にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 Azure ストレージ BLOB が存在し、マネージド ID に "ストレージ BLOB データ閲覧者" ロールの割り当てで BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID とコマンドの実行の詳細については、 と を参照してください https://aka.ms/ManagedIdentity
。 https://aka.ms/RunCommandManaged.
RunCommandManagedIdentity
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template
説明
SharePoint サブスクリプション / 2019 / 2016 / 2013 すべて構成済み
このテンプレートでは、ADFS とのフェデレーション認証、OAuth 信頼、ユーザー プロファイル サービス、複数のパス ベースおよびホスト名付きサイト コレクションを含む 2 つのゾーンを持つ Web アプリケーションなど、手動で実行するために年齢がかかる広範な構成を備えた SharePoint サブスクリプション / 2019 / 2016 / 2013 ファームを作成します。 SharePoint 仮想マシンでは、Chocolatey を使用して、最新バージョンの Notepad++、Visual Studio Code、Azure Data Studio、Fiddler、ULS Viewer、7-Zip をインストールします。
virtualMachines/runCommands リソースの種類は、次をターゲットとする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ 」を参照してください。
Microsoft.Compute/virtualMachines/runCommands リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/virtualMachines/runCommands@2023-03-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
asyncExecution = bool
errorBlobManagedIdentity = {
clientId = "string"
objectId = "string"
}
errorBlobUri = "string"
outputBlobManagedIdentity = {
clientId = "string"
objectId = "string"
}
outputBlobUri = "string"
parameters = [
{
name = "string"
value = "string"
}
]
protectedParameters = [
{
name = "string"
value = "string"
}
]
runAsPassword = "string"
runAsUser = "string"
source = {
commandId = "string"
script = "string"
scriptUri = "string"
scriptUriManagedIdentity = {
clientId = "string"
objectId = "string"
}
}
timeoutInSeconds = int
treatFailureAsDeploymentFailure = bool
}
})
}
プロパティ値
virtualMachines/runCommands
名前
説明
値
type
リソースの種類
"Microsoft.Compute/virtualMachines/runCommands@2023-03-01"
name
リソース名
string (必須)
location
リソースの場所
string (必須)
parent_id
このリソースの親であるリソースの ID。
種類のリソースの ID: virtualMachines
tags
リソース タグ
タグ名と値のディクショナリ。
properties
仮想マシンの実行コマンドのプロパティについて説明します。
VirtualMachineRunCommandProperties
VirtualMachineRunCommandProperties
名前
説明
値
asyncExecution
省略可能。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトの完了を待機しません。
[bool]
errorBlobManagedIdentity
errorBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てで、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID に追加してください。 マネージド ID とコマンドの実行の詳細については、 と を参照してください https://aka.ms/ManagedIdentity
。 https://aka.ms/RunCommandManaged
RunCommandManagedIdentity
errorBlobUri
スクリプト エラー ストリームをアップロードする Azure ストレージ BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 errorBlobManagedIdentity パラメーターを参照してください。
string
outputBlobManagedIdentity
outputBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てで、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID に追加してください。 マネージド ID とコマンドの実行の詳細については、 と を参照してください https://aka.ms/ManagedIdentity
。 https://aka.ms/RunCommandManaged
RunCommandManagedIdentity
outputBlobUri
スクリプト出力ストリームをアップロードする Azure ストレージ BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 outputBlobManagedIdentity パラメーターを参照してください。
string
parameters
スクリプトで使用されるパラメーター。
RunCommandInputParameter []
protectedParameters
スクリプトで使用されるパラメーター。
RunCommandInputParameter []
runAsPassword
実行コマンドの実行時に VM のユーザー アカウント パスワードを指定します。
string
runAsUser
run コマンドの実行時に VM 上のユーザー アカウントを指定します。
string
source
実行コマンド スクリプトのソース。
VirtualMachineRunCommandScriptSource
timeoutInSeconds
run コマンドを実行するためのタイムアウト (秒単位)。
INT
treatFailureAsDeploymentFailure
省略可能。 true に設定すると、スクリプト内のエラーはデプロイに失敗し、ProvisioningState は Failed としてマークされます。 false に設定すると、ProvisioningState は、実行コマンドが拡張機能プラットフォームによって実行されたかどうかのみが反映され、スクリプトが失敗した場合にスクリプトが失敗したかどうかは示されません。 スクリプトエラーが発生した場合は、run コマンドのインスタンス ビューを参照して、executionMessage、output、error を確認します。 https://aka.ms/runcommandmanaged#get-execution-status-and-results
[bool]
RunCommandManagedIdentity
名前
説明
値
clientId
ユーザー割り当てマネージド ID のクライアント ID (GUID 値)。 ObjectId を指定する場合は使用しないでください。
string
objectId
ユーザー割り当てマネージド ID のオブジェクト ID (GUID 値)。 これが指定されている場合は、ClientId を使用しないでください。
string
名前
説明
値
name
run コマンド パラメーター名。
string (必須)
value
run コマンド パラメーターの値。
string (必須)
VirtualMachineRunCommandScriptSource
名前
説明
値
commandId
定義済みの組み込みスクリプトの commandId を指定します。
string
script
VM で実行するスクリプト コンテンツを指定します。
string
scriptUri
スクリプトのダウンロード場所を指定します。 読み取りアクセス権を持つ Azure ストレージ BLOB の SAS URI またはパブリック URI のいずれかを指定できます。
string
scriptUriManagedIdentity
Azure ストレージ BLOB の場合に scriptUri にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 Azure ストレージ BLOB が存在し、マネージド ID に "ストレージ BLOB データ閲覧者" ロールの割り当てで BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID に追加してください。 マネージド ID とコマンドの実行の詳細については、 と を参照してください https://aka.ms/ManagedIdentity
。 https://aka.ms/RunCommandManaged.
RunCommandManagedIdentity