Microsoft.Compute virtualMachineScaleSets/virtualMachines/runCommands 2023-09-01

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa virtualMachineScaleSets/virtualMachines/runCommands può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-09-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
  }
}

Valori delle proprietà

virtualMachineScaleSets/virtualMachines/runCommands

Nome Descrizione Valore
nome Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in Bicep.		 stringa (obbligatorio)
ubicazione Percorso risorsa stringa (obbligatorio)
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli
genitore In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.		 Nome simbolico per la risorsa di tipo: virtualMachines
proprietà Descrive le proprietà di un comando di esecuzione di una macchina virtuale. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nome Descrizione Valore
asyncExecution Opzionale. Se impostato su true, il provisioning verrà completato non appena viene avviato lo script e non attenderà il completamento dello script. Bool
errorBlobManagedIdentity Identità gestita assegnata dall'utente che ha accesso al BLOB di archiviazione errorBlobUri. Usare un oggetto vuoto in caso di identità assegnata dal sistema. Assicurarsi che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Collaboratore ai dati dei BLOB di archiviazione". In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Specifica il BLOB di archiviazione di Azure in cui verrà caricato il flusso di errori dello script. Usare un URI di firma di accesso condiviso con lettura, aggiunta, creazione, accesso in scrittura O usare l'identità gestita per fornire alla macchina virtuale l'accesso al BLOB. Fare riferimento al parametro errorBlobManagedIdentity. corda
outputBlobManagedIdentity Identità gestita assegnata dall'utente che ha accesso al BLOB di archiviazione outputBlobUri. Usare un oggetto vuoto in caso di identità assegnata dal sistema. Assicurarsi che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Collaboratore ai dati dei BLOB di archiviazione". In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Specifica il BLOB di archiviazione di Azure in cui verrà caricato il flusso di output dello script. Usare un URI di firma di accesso condiviso con lettura, aggiunta, creazione, accesso in scrittura O usare l'identità gestita per fornire alla macchina virtuale l'accesso al BLOB. Fare riferimento al parametro outputBlobManagedIdentity. corda
Parametri Parametri utilizzati dallo script. RunCommandInputParameter[]
protectedParameters Parametri utilizzati dallo script. RunCommandInputParameter[]
runAsPassword Specifica la password dell'account utente nella macchina virtuale durante l'esecuzione del comando di esecuzione. corda
runAsUser Specifica l'account utente nella macchina virtuale durante l'esecuzione del comando di esecuzione. corda
fonte Origine dello script del comando di esecuzione. VirtualMachineRunCommandScriptSource
timeoutInSeconds Timeout in secondi per eseguire il comando di esecuzione. Int
treatFailureAsDeploymentFailure Opzionale. Se impostato su true, qualsiasi errore nello script non riuscirà la distribuzione e ProvisioningState verrà contrassegnato come Non riuscito. Se impostato su false, ProvisioningState riflette solo se il comando di esecuzione è stato eseguito o meno dalla piattaforma delle estensioni, non indicherà se lo script non è riuscito in caso di errori di script. Vedere la visualizzazione dell'istanza del comando di esecuzione in caso di errori di script per visualizzare executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

RunCommandManagedIdentity

Nome Descrizione Valore
clientId ID client (valore GUID) dell'identità gestita assegnata dall'utente. ObjectId non deve essere utilizzato se specificato. corda
objectId ID oggetto (valore GUID) dell'identità gestita assegnata dall'utente. ClientId non deve essere usato se specificato. corda

RunCommandInputParameter

Nome Descrizione Valore
nome Nome del parametro del comando di esecuzione. stringa (obbligatorio)
valore Valore del parametro del comando run. stringa (obbligatorio)

VirtualMachineRunCommandScriptSource

Nome Descrizione Valore
commandId Specifica un commandId di script predefinito predefinito. corda
copione Specifica il contenuto dello script da eseguire nella macchina virtuale. corda
scriptUri Specifica il percorso di download dello script. Può essere un URI di firma di accesso condiviso di un BLOB di archiviazione di Azure con accesso in lettura o URI pubblico. corda
scriptUriManagedIdentity Identità gestita assegnata dall'utente che ha accesso a scriptUri in caso di BLOB di archiviazione di Azure. Usare un oggetto vuoto in caso di identità assegnata dal sistema. Assicurarsi che il BLOB di archiviazione di Azure esista e che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Lettore dati BLOB di archiviazione". In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa virtualMachineScaleSets/virtualMachines/runCommands può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
  "apiVersion": "2023-09-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"
  }
}

Valori delle proprietà

virtualMachineScaleSets/virtualMachines/runCommands

Nome Descrizione Valore
digitare Tipo di risorsa 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands'
apiVersion Versione dell'API della risorsa '2023-09-01'
nome Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in modelli DI Resource Manager JSON.		 stringa (obbligatorio)
ubicazione Percorso risorsa stringa (obbligatorio)
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli
proprietà Descrive le proprietà di un comando di esecuzione di una macchina virtuale. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nome Descrizione Valore
asyncExecution Opzionale. Se impostato su true, il provisioning verrà completato non appena viene avviato lo script e non attenderà il completamento dello script. Bool
errorBlobManagedIdentity Identità gestita assegnata dall'utente che ha accesso al BLOB di archiviazione errorBlobUri. Usare un oggetto vuoto in caso di identità assegnata dal sistema. Assicurarsi che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Collaboratore ai dati dei BLOB di archiviazione". In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Specifica il BLOB di archiviazione di Azure in cui verrà caricato il flusso di errori dello script. Usare un URI di firma di accesso condiviso con lettura, aggiunta, creazione, accesso in scrittura O usare l'identità gestita per fornire alla macchina virtuale l'accesso al BLOB. Fare riferimento al parametro errorBlobManagedIdentity. corda
outputBlobManagedIdentity Identità gestita assegnata dall'utente che ha accesso al BLOB di archiviazione outputBlobUri. Usare un oggetto vuoto in caso di identità assegnata dal sistema. Assicurarsi che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Collaboratore ai dati dei BLOB di archiviazione". In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Specifica il BLOB di archiviazione di Azure in cui verrà caricato il flusso di output dello script. Usare un URI di firma di accesso condiviso con lettura, aggiunta, creazione, accesso in scrittura O usare l'identità gestita per fornire alla macchina virtuale l'accesso al BLOB. Fare riferimento al parametro outputBlobManagedIdentity. corda
Parametri Parametri utilizzati dallo script. RunCommandInputParameter[]
protectedParameters Parametri utilizzati dallo script. RunCommandInputParameter[]
runAsPassword Specifica la password dell'account utente nella macchina virtuale durante l'esecuzione del comando di esecuzione. corda
runAsUser Specifica l'account utente nella macchina virtuale durante l'esecuzione del comando di esecuzione. corda
fonte Origine dello script del comando di esecuzione. VirtualMachineRunCommandScriptSource
timeoutInSeconds Timeout in secondi per eseguire il comando di esecuzione. Int
treatFailureAsDeploymentFailure Opzionale. Se impostato su true, qualsiasi errore nello script non riuscirà la distribuzione e ProvisioningState verrà contrassegnato come Non riuscito. Se impostato su false, ProvisioningState riflette solo se il comando di esecuzione è stato eseguito o meno dalla piattaforma delle estensioni, non indicherà se lo script non è riuscito in caso di errori di script. Vedere la visualizzazione dell'istanza del comando di esecuzione in caso di errori di script per visualizzare executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

RunCommandManagedIdentity

Nome Descrizione Valore
clientId ID client (valore GUID) dell'identità gestita assegnata dall'utente. ObjectId non deve essere utilizzato se specificato. corda
objectId ID oggetto (valore GUID) dell'identità gestita assegnata dall'utente. ClientId non deve essere usato se specificato. corda

RunCommandInputParameter

Nome Descrizione Valore
nome Nome del parametro del comando di esecuzione. stringa (obbligatorio)
valore Valore del parametro del comando run. stringa (obbligatorio)

VirtualMachineRunCommandScriptSource

Nome Descrizione Valore
commandId Specifica un commandId di script predefinito predefinito. corda
copione Specifica il contenuto dello script da eseguire nella macchina virtuale. corda
scriptUri Specifica il percorso di download dello script. Può essere un URI di firma di accesso condiviso di un BLOB di archiviazione di Azure con accesso in lettura o URI pubblico. corda
scriptUriManagedIdentity Identità gestita assegnata dall'utente che ha accesso a scriptUri in caso di BLOB di archiviazione di Azure. Usare un oggetto vuoto in caso di identità assegnata dal sistema. Assicurarsi che il BLOB di archiviazione di Azure esista e che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Lettore dati BLOB di archiviazione". In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa virtualMachineScaleSets/virtualMachines/runCommands può essere distribuito con operazioni destinate a:

  • gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-09-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
    }
  })
}

Valori delle proprietà

virtualMachineScaleSets/virtualMachines/runCommands

Nome Descrizione Valore
digitare Tipo di risorsa "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-09-01"
nome Nome della risorsa stringa (obbligatorio)
ubicazione Percorso risorsa stringa (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: virtualMachines
Tag Tag delle risorse Dizionario di nomi e valori di tag.
proprietà Descrive le proprietà di un comando di esecuzione di una macchina virtuale. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nome Descrizione Valore
asyncExecution Opzionale. Se impostato su true, il provisioning verrà completato non appena viene avviato lo script e non attenderà il completamento dello script. Bool
errorBlobManagedIdentity Identità gestita assegnata dall'utente che ha accesso al BLOB di archiviazione errorBlobUri. Usare un oggetto vuoto in caso di identità assegnata dal sistema. Assicurarsi che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Collaboratore ai dati dei BLOB di archiviazione". In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Specifica il BLOB di archiviazione di Azure in cui verrà caricato il flusso di errori dello script. Usare un URI di firma di accesso condiviso con lettura, aggiunta, creazione, accesso in scrittura O usare l'identità gestita per fornire alla macchina virtuale l'accesso al BLOB. Fare riferimento al parametro errorBlobManagedIdentity. corda
outputBlobManagedIdentity Identità gestita assegnata dall'utente che ha accesso al BLOB di archiviazione outputBlobUri. Usare un oggetto vuoto in caso di identità assegnata dal sistema. Assicurarsi che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Collaboratore ai dati dei BLOB di archiviazione". In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Specifica il BLOB di archiviazione di Azure in cui verrà caricato il flusso di output dello script. Usare un URI di firma di accesso condiviso con lettura, aggiunta, creazione, accesso in scrittura O usare l'identità gestita per fornire alla macchina virtuale l'accesso al BLOB. Fare riferimento al parametro outputBlobManagedIdentity. corda
Parametri Parametri utilizzati dallo script. RunCommandInputParameter[]
protectedParameters Parametri utilizzati dallo script. RunCommandInputParameter[]
runAsPassword Specifica la password dell'account utente nella macchina virtuale durante l'esecuzione del comando di esecuzione. corda
runAsUser Specifica l'account utente nella macchina virtuale durante l'esecuzione del comando di esecuzione. corda
fonte Origine dello script del comando di esecuzione. VirtualMachineRunCommandScriptSource
timeoutInSeconds Timeout in secondi per eseguire il comando di esecuzione. Int
treatFailureAsDeploymentFailure Opzionale. Se impostato su true, qualsiasi errore nello script non riuscirà la distribuzione e ProvisioningState verrà contrassegnato come Non riuscito. Se impostato su false, ProvisioningState riflette solo se il comando di esecuzione è stato eseguito o meno dalla piattaforma delle estensioni, non indicherà se lo script non è riuscito in caso di errori di script. Vedere la visualizzazione dell'istanza del comando di esecuzione in caso di errori di script per visualizzare executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

RunCommandManagedIdentity

Nome Descrizione Valore
clientId ID client (valore GUID) dell'identità gestita assegnata dall'utente. ObjectId non deve essere utilizzato se specificato. corda
objectId ID oggetto (valore GUID) dell'identità gestita assegnata dall'utente. ClientId non deve essere usato se specificato. corda

RunCommandInputParameter

Nome Descrizione Valore
nome Nome del parametro del comando di esecuzione. stringa (obbligatorio)
valore Valore del parametro del comando run. stringa (obbligatorio)

VirtualMachineRunCommandScriptSource

Nome Descrizione Valore
commandId Specifica un commandId di script predefinito predefinito. corda
copione Specifica il contenuto dello script da eseguire nella macchina virtuale. corda
scriptUri Specifica il percorso di download dello script. Può essere un URI di firma di accesso condiviso di un BLOB di archiviazione di Azure con accesso in lettura o URI pubblico. corda
scriptUriManagedIdentity Identità gestita assegnata dall'utente che ha accesso a scriptUri in caso di BLOB di archiviazione di Azure. Usare un oggetto vuoto in caso di identità assegnata dal sistema. Assicurarsi che il BLOB di archiviazione di Azure esista e che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Lettore dati BLOB di archiviazione". In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged. RunCommandManagedIdentity