Microsoft.Compute virtualMachines/runCommands 2021-11-01

• 最新
• 2024-07-01
• 2024-03-01
• 2023-09-01
• 2023-07-01
• 2023-03-01
• 2022-11-01
• 2022-08-01
• 2022-03-01
• 2021-11-01
• 2021-07-01
• 2021-04-01
• 2021-03-01
• 2020-12-01
• 2020-06-01

Bicep リソース定義

virtualMachines/runCommands リソースの種類は、次をターゲットとする操作と共にデプロイできます。

• リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Compute/virtualMachines/runCommands リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Compute/virtualMachines/runCommands@2021-11-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    asyncExecution: bool
    errorBlobUri: 'string'
    outputBlobUri: 'string'
    parameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    protectedParameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    runAsPassword: 'string'
    runAsUser: 'string'
    source: {
      commandId: 'string'
      script: 'string'
      scriptUri: 'string'
    }
    timeoutInSeconds: int
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

Microsoft.Compute/virtualMachines/runCommands

名前	形容	価値
場所	リソースの場所	string (必須)
名前	リソース名	string (必須)
親	Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 子リソース」を参照してください。	種類のリソースのシンボリック名: virtualMachines
プロパティ	仮想マシンの実行コマンドのプロパティについて説明します。	VirtualMachineRunCommandProperties
タグ	リソース タグ	タグ名と値のディクショナリ。 テンプレート の タグを参照してください

ResourceTags

名前	形容	価値

RunCommandInputParameter

名前	形容	価値
名前	run コマンド のパラメーター名。	string (必須)
価値	run コマンド パラメーターの値。	string (必須)

VirtualMachineRunCommandProperties

名前	形容	価値
asyncExecution	随意。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトが完了するまで待機しません。	bool
errorBlobUri	スクリプト エラー ストリームをアップロードする Azure Storage BLOB を指定します。	糸
outputBlobUri	スクリプト出力ストリームをアップロードする Azure Storage BLOB を指定します。	糸
パラメーター	スクリプトで使用されるパラメーター。	RunCommandInputParameter[]
protectedParameters	スクリプトで使用されるパラメーター。	RunCommandInputParameter[]
runAsPassword	実行コマンドの実行時に VM のユーザー アカウント パスワードを指定します。	糸
runAsUser	実行コマンドの実行時に VM 上のユーザー アカウントを指定します。	糸
源	実行コマンド スクリプトのソース。	VirtualMachineRunCommandScriptSource
timeoutInSeconds	run コマンドを実行するためのタイムアウト (秒単位)。	int

VirtualMachineRunCommandScriptSource

名前	形容	価値
commandId	定義済みの組み込みスクリプトの commandId を指定します。	糸
スクリプト	VM で実行するスクリプトコンテンツを指定します。	糸
scriptUri	スクリプトのダウンロード場所を指定します。	糸

クイック スタートのサンプル

次のクイック スタート サンプルでは、このリソースの種類をデプロイします。

Bicep ファイル	形容
GitLab Omnibus	このテンプレートは、パブリック IP の DNS を利用して、パブリック DNS を使用する仮想マシンへの GitLab Omnibus のデプロイを簡略化します。 Standard_F8s_v2 インスタンス サイズを利用します。これは参照アーキテクチャに合わせ、最大 1,000 ユーザー (20 RPS) をサポートします。 インスタンスは、セキュリティで保護された接続に Let's Encrypt 証明書と共に HTTPS を使用するように事前構成されています。
SharePoint サブスクリプション / 2019 / 2016 完全に構成された	DC、SQL Server 2022、SharePoint サブスクリプションをホストする 1 台から 5 台のサーバーを作成します。これには、信頼された認証、個人用サイトでのユーザー プロファイル、OAuth 信頼 (証明書を使用)、高信頼アドインをホストするための専用 IIS サイトなど、広範な構成が含まれます。最新バージョンの主要ソフトウェア (Fiddler、vscode、np++、7zip、ULS Viewer など) がインストールされています。 SharePoint マシンには、すぐに使用できるようにするための微調整機能が追加されています (リモート管理ツール、Edge と Chrome のカスタム ポリシー、ショートカットなど)。

ARM テンプレート リソース定義

virtualMachines/runCommands リソースの種類は、次をターゲットとする操作と共にデプロイできます。

• リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Compute/virtualMachines/runCommands リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Compute/virtualMachines/runCommands",
  "apiVersion": "2021-11-01",
  "name": "string",
  "location": "string",
  "properties": {
    "asyncExecution": "bool",
    "errorBlobUri": "string",
    "outputBlobUri": "string",
    "parameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "protectedParameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "runAsPassword": "string",
    "runAsUser": "string",
    "source": {
      "commandId": "string",
      "script": "string",
      "scriptUri": "string"
    },
    "timeoutInSeconds": "int"
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

Microsoft.Compute/virtualMachines/runCommands

名前	形容	価値
apiVersion	API のバージョン	'2021-11-01'
場所	リソースの場所	string (必須)
名前	リソース名	string (必須)
プロパティ	仮想マシンの実行コマンドのプロパティについて説明します。	VirtualMachineRunCommandProperties
タグ	リソース タグ	タグ名と値のディクショナリ。 テンプレート の タグを参照してください
種類	リソースの種類	'Microsoft.Compute/virtualMachines/runCommands'

ResourceTags

名前	形容	価値

RunCommandInputParameter

名前	形容	価値
名前	run コマンド のパラメーター名。	string (必須)
価値	run コマンド パラメーターの値。	string (必須)

VirtualMachineRunCommandProperties

名前	形容	価値
asyncExecution	随意。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトが完了するまで待機しません。	bool
errorBlobUri	スクリプト エラー ストリームをアップロードする Azure Storage BLOB を指定します。	糸
outputBlobUri	スクリプト出力ストリームをアップロードする Azure Storage BLOB を指定します。	糸
パラメーター	スクリプトで使用されるパラメーター。	RunCommandInputParameter[]
protectedParameters	スクリプトで使用されるパラメーター。	RunCommandInputParameter[]
runAsPassword	実行コマンドの実行時に VM のユーザー アカウント パスワードを指定します。	糸
runAsUser	実行コマンドの実行時に VM 上のユーザー アカウントを指定します。	糸
源	実行コマンド スクリプトのソース。	VirtualMachineRunCommandScriptSource
timeoutInSeconds	run コマンドを実行するためのタイムアウト (秒単位)。	int

VirtualMachineRunCommandScriptSource

名前	形容	価値
commandId	定義済みの組み込みスクリプトの commandId を指定します。	糸
スクリプト	VM で実行するスクリプトコンテンツを指定します。	糸
scriptUri	スクリプトのダウンロード場所を指定します。	糸

クイック スタート テンプレート

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート	形容
GitLab Omnibus Azure にデプロイする	このテンプレートは、パブリック IP の DNS を利用して、パブリック DNS を使用する仮想マシンへの GitLab Omnibus のデプロイを簡略化します。 Standard_F8s_v2 インスタンス サイズを利用します。これは参照アーキテクチャに合わせ、最大 1,000 ユーザー (20 RPS) をサポートします。 インスタンスは、セキュリティで保護された接続に Let's Encrypt 証明書と共に HTTPS を使用するように事前構成されています。
SharePoint サブスクリプション / 2019 / 2016 完全に構成された Azure にデプロイする	DC、SQL Server 2022、SharePoint サブスクリプションをホストする 1 台から 5 台のサーバーを作成します。これには、信頼された認証、個人用サイトでのユーザー プロファイル、OAuth 信頼 (証明書を使用)、高信頼アドインをホストするための専用 IIS サイトなど、広範な構成が含まれます。最新バージョンの主要ソフトウェア (Fiddler、vscode、np++、7zip、ULS Viewer など) がインストールされています。 SharePoint マシンには、すぐに使用できるようにするための微調整機能が追加されています (リモート管理ツール、Edge と Chrome のカスタム ポリシー、ショートカットなど)。

Terraform (AzAPI プロバイダー) リソース定義

virtualMachines/runCommands リソースの種類は、次をターゲットとする操作と共にデプロイできます。

• リソース グループ

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Compute/virtualMachines/runCommands リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachines/runCommands@2021-11-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      asyncExecution = bool
      errorBlobUri = "string"
      outputBlobUri = "string"
      parameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      protectedParameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      runAsPassword = "string"
      runAsUser = "string"
      source = {
        commandId = "string"
        script = "string"
        scriptUri = "string"
      }
      timeoutInSeconds = int
    }
  })
}

プロパティ値

Microsoft.Compute/virtualMachines/runCommands

名前	形容	価値
場所	リソースの場所	string (必須)
名前	リソース名	string (必須)
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: virtualMachines
プロパティ	仮想マシンの実行コマンドのプロパティについて説明します。	VirtualMachineRunCommandProperties
タグ	リソース タグ	タグ名と値のディクショナリ。
種類	リソースの種類	"Microsoft.Compute/virtualMachines/runCommands@2021-11-01"

ResourceTags

名前	形容	価値

RunCommandInputParameter

名前	形容	価値
名前	run コマンド のパラメーター名。	string (必須)
価値	run コマンド パラメーターの値。	string (必須)

VirtualMachineRunCommandProperties

名前	形容	価値
asyncExecution	随意。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトが完了するまで待機しません。	bool
errorBlobUri	スクリプト エラー ストリームをアップロードする Azure Storage BLOB を指定します。	糸
outputBlobUri	スクリプト出力ストリームをアップロードする Azure Storage BLOB を指定します。	糸
パラメーター	スクリプトで使用されるパラメーター。	RunCommandInputParameter[]
protectedParameters	スクリプトで使用されるパラメーター。	RunCommandInputParameter[]
runAsPassword	実行コマンドの実行時に VM のユーザー アカウント パスワードを指定します。	糸
runAsUser	実行コマンドの実行時に VM 上のユーザー アカウントを指定します。	糸
源	実行コマンド スクリプトのソース。	VirtualMachineRunCommandScriptSource
timeoutInSeconds	run コマンドを実行するためのタイムアウト (秒単位)。	int

VirtualMachineRunCommandScriptSource

名前	形容	価値
commandId	定義済みの組み込みスクリプトの commandId を指定します。	糸
スクリプト	VM で実行するスクリプトコンテンツを指定します。	糸
scriptUri	スクリプトのダウンロード場所を指定します。	糸