Udostępnij za pośrednictwem


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

Definicja zasobu Bicep

Typ zasobu virtualMachineScaleSets/virtualMachines/runCommands można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, dodaj następujący zasób Bicep do szablonu.

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

Wartości właściwości

virtualMachineScaleSets/virtualMachines/runCommands

Nazwa Opis Wartość
nazwa Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w Bicep.
ciąg (wymagany)
lokalizacja Lokalizacja zasobu ciąg (wymagany)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
rodzic W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.
Nazwa symboliczna zasobu typu: virtualMachines
Właściwości Opisuje właściwości polecenia uruchamiania maszyny wirtualnej. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nazwa Opis Wartość
asyncExecution Fakultatywny. Jeśli ustawiono wartość true, aprowizacja zostanie ukończona natychmiast po uruchomieniu skryptu i nie będzie czekać na ukończenie skryptu. Bool
errorBlobManagedIdentity Tożsamość zarządzana przypisana przez użytkownika, która ma dostęp do obiektu blob storage errorBlobUri. Użyj pustego obiektu w przypadku tożsamości przypisanej przez system. Upewnij się, że tożsamość zarządzana ma dostęp do kontenera obiektu blob z przypisaniem roli "Współautor danych obiektu blob usługi Storage". W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamości maszyny wirtualnej. Aby uzyskać więcej informacji na temat tożsamości zarządzanej i uruchamiania polecenia, zobacz https://aka.ms/ManagedIdentity i https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień błędów skryptu. Użyj identyfikatora URI sygnatury dostępu współdzielonego z identyfikatorem odczytu, dołączania, tworzenia, zapisu lub używania tożsamości zarządzanej, aby zapewnić maszynie wirtualnej dostęp do obiektu blob. Zapoznaj się z parametrem errorBlobManagedIdentity. struna
outputBlobManagedIdentity Tożsamość zarządzana przypisana przez użytkownika, która ma dostęp do obiektu blob magazynu outputBlobUri. Użyj pustego obiektu w przypadku tożsamości przypisanej przez system. Upewnij się, że tożsamość zarządzana ma dostęp do kontenera obiektu blob z przypisaniem roli "Współautor danych obiektu blob usługi Storage". W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamości maszyny wirtualnej. Aby uzyskać więcej informacji na temat tożsamości zarządzanej i uruchamiania polecenia, zobacz https://aka.ms/ManagedIdentity i https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień wyjściowy skryptu. Użyj identyfikatora URI sygnatury dostępu współdzielonego z identyfikatorem odczytu, dołączania, tworzenia, zapisu lub używania tożsamości zarządzanej, aby zapewnić maszynie wirtualnej dostęp do obiektu blob. Zapoznaj się z parametrem outputBlobManagedIdentity. struna
Parametry Parametry używane przez skrypt. RunCommandInputParameter[]
protectedParameters Parametry używane przez skrypt. RunCommandInputParameter[]
runAsPassword Określa hasło konta użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania. struna
runAsUser Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania. struna
źródło Źródło skryptu polecenia uruchamiania. VirtualMachineRunCommandScriptSource
timeoutInSeconds Limit czasu w sekundach do wykonania polecenia uruchomienia. Int
treatFailureAsDeploymentFailure Fakultatywny. Jeśli ustawiono wartość true, wszystkie błędy w skry skrycie nie powiedzą się, a stan ProvisioningState zostanie oznaczony jako Niepowodzenie. Jeśli ustawiono wartość false, wartość ProvisioningState będzie odzwierciedlać tylko to, czy polecenie uruchomienia zostało uruchomione, czy nie przez platformę rozszerzeń, nie wskazuje, czy skrypt zakończył się niepowodzeniem w przypadku błędów skryptu. Zobacz widok wystąpienia polecenia uruchamiania w przypadku błędów skryptu, aby wyświetlić executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

RunCommandManagedIdentity

Nazwa Opis Wartość
clientId Identyfikator klienta (wartość GUID) tożsamości zarządzanej przypisanej przez użytkownika. Nie należy używać identyfikatora ObjectId, jeśli jest to podane. struna
objectId Identyfikator obiektu (wartość GUID) tożsamości zarządzanej przypisanej przez użytkownika. W przypadku podania tego identyfikatora nie należy używać identyfikatora ClientId. struna

RunCommandInputParameter

Nazwa Opis Wartość
nazwa Nazwa parametru polecenia uruchamiania. ciąg (wymagany)
wartość Wartość parametru polecenia uruchomienia. ciąg (wymagany)

VirtualMachineRunCommandScriptSource

Nazwa Opis Wartość
commandId Określa identyfikator polecenia wstępnie zdefiniowanego wbudowanego skryptu. struna
skrypt Określa zawartość skryptu do wykonania na maszynie wirtualnej. struna
scriptUri Określa lokalizację pobierania skryptu. Może to być identyfikator URI sygnatury dostępu współdzielonego obiektu blob usługi Azure Storage z dostępem do odczytu lub publicznym identyfikatorem URI. struna
scriptUriManagedIdentity Tożsamość zarządzana przypisana przez użytkownika, która ma dostęp do identyfikatora scriptUri w przypadku obiektu blob usługi Azure Storage. Użyj pustego obiektu w przypadku tożsamości przypisanej przez system. Upewnij się, że obiekt blob usługi Azure Storage istnieje, a tożsamość zarządzana uzyskała dostęp do kontenera obiektu blob z przypisaniem roli "Czytelnik danych obiektu blob usługi Storage". W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamości maszyny wirtualnej. Aby uzyskać więcej informacji na temat tożsamości zarządzanej i uruchamiania polecenia, zobacz https://aka.ms/ManagedIdentity i https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

Definicja zasobu szablonu usługi ARM

Typ zasobu virtualMachineScaleSets/virtualMachines/runCommands można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, dodaj następujący kod JSON do szablonu.

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

Wartości właściwości

virtualMachineScaleSets/virtualMachines/runCommands

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands"
apiVersion Wersja interfejsu API zasobów '2023-07-01'
nazwa Nazwa zasobu

Zobacz, jak ustawiać nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM JSON.
ciąg (wymagany)
lokalizacja Lokalizacja zasobu ciąg (wymagany)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
Właściwości Opisuje właściwości polecenia uruchamiania maszyny wirtualnej. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nazwa Opis Wartość
asyncExecution Fakultatywny. Jeśli ustawiono wartość true, aprowizacja zostanie ukończona natychmiast po uruchomieniu skryptu i nie będzie czekać na ukończenie skryptu. Bool
errorBlobManagedIdentity Tożsamość zarządzana przypisana przez użytkownika, która ma dostęp do obiektu blob storage errorBlobUri. Użyj pustego obiektu w przypadku tożsamości przypisanej przez system. Upewnij się, że tożsamość zarządzana ma dostęp do kontenera obiektu blob z przypisaniem roli "Współautor danych obiektu blob usługi Storage". W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamości maszyny wirtualnej. Aby uzyskać więcej informacji na temat tożsamości zarządzanej i uruchamiania polecenia, zobacz https://aka.ms/ManagedIdentity i https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień błędów skryptu. Użyj identyfikatora URI sygnatury dostępu współdzielonego z identyfikatorem odczytu, dołączania, tworzenia, zapisu lub używania tożsamości zarządzanej, aby zapewnić maszynie wirtualnej dostęp do obiektu blob. Zapoznaj się z parametrem errorBlobManagedIdentity. struna
outputBlobManagedIdentity Tożsamość zarządzana przypisana przez użytkownika, która ma dostęp do obiektu blob magazynu outputBlobUri. Użyj pustego obiektu w przypadku tożsamości przypisanej przez system. Upewnij się, że tożsamość zarządzana ma dostęp do kontenera obiektu blob z przypisaniem roli "Współautor danych obiektu blob usługi Storage". W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamości maszyny wirtualnej. Aby uzyskać więcej informacji na temat tożsamości zarządzanej i uruchamiania polecenia, zobacz https://aka.ms/ManagedIdentity i https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień wyjściowy skryptu. Użyj identyfikatora URI sygnatury dostępu współdzielonego z identyfikatorem odczytu, dołączania, tworzenia, zapisu lub używania tożsamości zarządzanej, aby zapewnić maszynie wirtualnej dostęp do obiektu blob. Zapoznaj się z parametrem outputBlobManagedIdentity. struna
Parametry Parametry używane przez skrypt. RunCommandInputParameter[]
protectedParameters Parametry używane przez skrypt. RunCommandInputParameter[]
runAsPassword Określa hasło konta użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania. struna
runAsUser Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania. struna
źródło Źródło skryptu polecenia uruchamiania. VirtualMachineRunCommandScriptSource
timeoutInSeconds Limit czasu w sekundach do wykonania polecenia uruchomienia. Int
treatFailureAsDeploymentFailure Fakultatywny. Jeśli ustawiono wartość true, wszystkie błędy w skry skrycie nie powiedzą się, a stan ProvisioningState zostanie oznaczony jako Niepowodzenie. Jeśli ustawiono wartość false, wartość ProvisioningState będzie odzwierciedlać tylko to, czy polecenie uruchomienia zostało uruchomione, czy nie przez platformę rozszerzeń, nie wskazuje, czy skrypt zakończył się niepowodzeniem w przypadku błędów skryptu. Zobacz widok wystąpienia polecenia uruchamiania w przypadku błędów skryptu, aby wyświetlić executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

RunCommandManagedIdentity

Nazwa Opis Wartość
clientId Identyfikator klienta (wartość GUID) tożsamości zarządzanej przypisanej przez użytkownika. Nie należy używać identyfikatora ObjectId, jeśli jest to podane. struna
objectId Identyfikator obiektu (wartość GUID) tożsamości zarządzanej przypisanej przez użytkownika. W przypadku podania tego identyfikatora nie należy używać identyfikatora ClientId. struna

RunCommandInputParameter

Nazwa Opis Wartość
nazwa Nazwa parametru polecenia uruchamiania. ciąg (wymagany)
wartość Wartość parametru polecenia uruchomienia. ciąg (wymagany)

VirtualMachineRunCommandScriptSource

Nazwa Opis Wartość
commandId Określa identyfikator polecenia wstępnie zdefiniowanego wbudowanego skryptu. struna
skrypt Określa zawartość skryptu do wykonania na maszynie wirtualnej. struna
scriptUri Określa lokalizację pobierania skryptu. Może to być identyfikator URI sygnatury dostępu współdzielonego obiektu blob usługi Azure Storage z dostępem do odczytu lub publicznym identyfikatorem URI. struna
scriptUriManagedIdentity Tożsamość zarządzana przypisana przez użytkownika, która ma dostęp do identyfikatora scriptUri w przypadku obiektu blob usługi Azure Storage. Użyj pustego obiektu w przypadku tożsamości przypisanej przez system. Upewnij się, że obiekt blob usługi Azure Storage istnieje, a tożsamość zarządzana uzyskała dostęp do kontenera obiektu blob z przypisaniem roli "Czytelnik danych obiektu blob usługi Storage". W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamości maszyny wirtualnej. Aby uzyskać więcej informacji na temat tożsamości zarządzanej i uruchamiania polecenia, zobacz https://aka.ms/ManagedIdentity i https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu virtualMachineScaleSets/virtualMachines/runCommands można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, dodaj następujący program Terraform do szablonu.

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

Wartości właściwości

virtualMachineScaleSets/virtualMachines/runCommands

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-07-01"
nazwa Nazwa zasobu ciąg (wymagany)
lokalizacja Lokalizacja zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: virtualMachines
Tagi Tagi zasobów Słownik nazw tagów i wartości.
Właściwości Opisuje właściwości polecenia uruchamiania maszyny wirtualnej. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nazwa Opis Wartość
asyncExecution Fakultatywny. Jeśli ustawiono wartość true, aprowizacja zostanie ukończona natychmiast po uruchomieniu skryptu i nie będzie czekać na ukończenie skryptu. Bool
errorBlobManagedIdentity Tożsamość zarządzana przypisana przez użytkownika, która ma dostęp do obiektu blob storage errorBlobUri. Użyj pustego obiektu w przypadku tożsamości przypisanej przez system. Upewnij się, że tożsamość zarządzana ma dostęp do kontenera obiektu blob z przypisaniem roli "Współautor danych obiektu blob usługi Storage". W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamości maszyny wirtualnej. Aby uzyskać więcej informacji na temat tożsamości zarządzanej i uruchamiania polecenia, zobacz https://aka.ms/ManagedIdentity i https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień błędów skryptu. Użyj identyfikatora URI sygnatury dostępu współdzielonego z identyfikatorem odczytu, dołączania, tworzenia, zapisu lub używania tożsamości zarządzanej, aby zapewnić maszynie wirtualnej dostęp do obiektu blob. Zapoznaj się z parametrem errorBlobManagedIdentity. struna
outputBlobManagedIdentity Tożsamość zarządzana przypisana przez użytkownika, która ma dostęp do obiektu blob magazynu outputBlobUri. Użyj pustego obiektu w przypadku tożsamości przypisanej przez system. Upewnij się, że tożsamość zarządzana ma dostęp do kontenera obiektu blob z przypisaniem roli "Współautor danych obiektu blob usługi Storage". W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamości maszyny wirtualnej. Aby uzyskać więcej informacji na temat tożsamości zarządzanej i uruchamiania polecenia, zobacz https://aka.ms/ManagedIdentity i https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień wyjściowy skryptu. Użyj identyfikatora URI sygnatury dostępu współdzielonego z identyfikatorem odczytu, dołączania, tworzenia, zapisu lub używania tożsamości zarządzanej, aby zapewnić maszynie wirtualnej dostęp do obiektu blob. Zapoznaj się z parametrem outputBlobManagedIdentity. struna
Parametry Parametry używane przez skrypt. RunCommandInputParameter[]
protectedParameters Parametry używane przez skrypt. RunCommandInputParameter[]
runAsPassword Określa hasło konta użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania. struna
runAsUser Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania. struna
źródło Źródło skryptu polecenia uruchamiania. VirtualMachineRunCommandScriptSource
timeoutInSeconds Limit czasu w sekundach do wykonania polecenia uruchomienia. Int
treatFailureAsDeploymentFailure Fakultatywny. Jeśli ustawiono wartość true, wszystkie błędy w skry skrycie nie powiedzą się, a stan ProvisioningState zostanie oznaczony jako Niepowodzenie. Jeśli ustawiono wartość false, wartość ProvisioningState będzie odzwierciedlać tylko to, czy polecenie uruchomienia zostało uruchomione, czy nie przez platformę rozszerzeń, nie wskazuje, czy skrypt zakończył się niepowodzeniem w przypadku błędów skryptu. Zobacz widok wystąpienia polecenia uruchamiania w przypadku błędów skryptu, aby wyświetlić executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

RunCommandManagedIdentity

Nazwa Opis Wartość
clientId Identyfikator klienta (wartość GUID) tożsamości zarządzanej przypisanej przez użytkownika. Nie należy używać identyfikatora ObjectId, jeśli jest to podane. struna
objectId Identyfikator obiektu (wartość GUID) tożsamości zarządzanej przypisanej przez użytkownika. W przypadku podania tego identyfikatora nie należy używać identyfikatora ClientId. struna

RunCommandInputParameter

Nazwa Opis Wartość
nazwa Nazwa parametru polecenia uruchamiania. ciąg (wymagany)
wartość Wartość parametru polecenia uruchomienia. ciąg (wymagany)

VirtualMachineRunCommandScriptSource

Nazwa Opis Wartość
commandId Określa identyfikator polecenia wstępnie zdefiniowanego wbudowanego skryptu. struna
skrypt Określa zawartość skryptu do wykonania na maszynie wirtualnej. struna
scriptUri Określa lokalizację pobierania skryptu. Może to być identyfikator URI sygnatury dostępu współdzielonego obiektu blob usługi Azure Storage z dostępem do odczytu lub publicznym identyfikatorem URI. struna
scriptUriManagedIdentity Tożsamość zarządzana przypisana przez użytkownika, która ma dostęp do identyfikatora scriptUri w przypadku obiektu blob usługi Azure Storage. Użyj pustego obiektu w przypadku tożsamości przypisanej przez system. Upewnij się, że obiekt blob usługi Azure Storage istnieje, a tożsamość zarządzana uzyskała dostęp do kontenera obiektu blob z przypisaniem roli "Czytelnik danych obiektu blob usługi Storage". W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamości maszyny wirtualnej. Aby uzyskać więcej informacji na temat tożsamości zarządzanej i uruchamiania polecenia, zobacz https://aka.ms/ManagedIdentity i https://aka.ms/RunCommandManaged. RunCommandManagedIdentity