Microsoft.Compute virtualMachineScaleSets/virtualMachines/runCommands

  • Artykuł

Definicja zasobu Bicep

Typ zasobu virtualMachineScaleSets/virtualMachines/runCommands można wdrożyć z operacjami docelowymi:

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

Format zasobu

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

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

Wartości właściwości

virtualMachineScaleSets/virtualMachines/runCommands

Nazwa Opis Wartość
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep.		 ciąg (wymagany)
location Lokalizacja zasobu ciąg (wymagany)
tags Tagi zasobów Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
Nadrzędny 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
properties Opisuje właściwości polecenia uruchamiania maszyny wirtualnej. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nazwa Opis Wartość
asyncExecution Opcjonalny. W przypadku ustawienia wartości true aprowizacja zostanie ukończona zaraz 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ść 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 w celu zapewnienia dostępu maszyny wirtualnej do obiektu blob. Zapoznaj się z parametrem errorBlobManagedIdentity. ciąg
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ść 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 w celu zapewnienia dostępu maszyny wirtualnej do obiektu blob. Zapoznaj się z parametrem outputBlobManagedIdentity. ciąg
parameters 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. ciąg
runAsUser Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania. ciąg
source Źródło skryptu polecenia uruchamiania. VirtualMachineRunCommandScriptSource
timeoutInSeconds Limit czasu w sekundach do wykonania polecenia uruchamiania. int
treatFailureAsDeploymentFailure Opcjonalny. W przypadku ustawienia wartości true wszystkie błędy w skry skrycie nie powiedzą się, a właściwość ProvisioningState zostanie oznaczona jako Niepowodzenie. Jeśli ustawiono wartość false, parametr ProvisioningState odzwierciedlałby tylko to, czy polecenie uruchamiania zostało uruchomione, czy nie przez platformę rozszerzeń, nie wskazuje, czy skrypt zakończyłby się niepowodzeniem w przypadku błędów skryptu. Zobacz widok wystąpienia polecenia uruchamiania w przypadku niepowodzeń 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. ciąg
objectId Identyfikator obiektu (wartość GUID) tożsamości zarządzanej przypisanej przez użytkownika. Parametr ClientId nie powinien być używany, jeśli jest to podane. ciąg

RunCommandInputParameter

Nazwa Opis Wartość
name Nazwa parametru polecenia uruchomienia. 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. ciąg
skrypt Określa zawartość skryptu do wykonania na maszynie wirtualnej. ciąg
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. ciąg
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 ma 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ść 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ć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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-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"
  }
}

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-09-01'
name Nazwa zasobu

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

VirtualMachineRunCommandProperties

Nazwa Opis Wartość
asyncExecution Opcjonalny. W przypadku ustawienia wartości true aprowizacja zostanie ukończona zaraz 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ść 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 w celu zapewnienia dostępu maszyny wirtualnej do obiektu blob. Zapoznaj się z parametrem errorBlobManagedIdentity. ciąg
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ść 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 w celu zapewnienia dostępu maszyny wirtualnej do obiektu blob. Zapoznaj się z parametrem outputBlobManagedIdentity. ciąg
parameters 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 run. ciąg
runAsUser Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia run. ciąg
source Źródło skryptu polecenia run. VirtualMachineRunCommandScriptSource
timeoutInSeconds Limit czasu w sekundach do wykonania polecenia uruchomienia. int
treatFailureAsDeploymentFailure Opcjonalny. Jeśli ustawiono wartość true, wszystkie błędy w skry skrycie nie powiedzą się, a parametr ProvisioningState zostanie oznaczony jako Niepowodzenie. Jeśli ustawiono wartość false, provisioningState będzie odzwierciedlać tylko to, czy polecenie uruchomienia zostało uruchomione, czy nie przez platformę rozszerzeń, nie oznaczałoby to, czy skrypt zakończył się niepowodzeniem w przypadku awarii skryptu. Zobacz widok wystąpienia polecenia uruchamiania w przypadku niepowodzeń skryptu, aby wyświetlić komunikat 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. Identyfikator ObjectId nie powinien być używany, jeśli jest to podane. ciąg
objectId Identyfikator obiektu (wartość GUID) tożsamości zarządzanej przypisanej przez użytkownika. Identyfikator ClientId nie powinien być używany, jeśli jest to podane. ciąg

RunCommandInputParameter

Nazwa Opis Wartość
name Nazwa parametru polecenia run. ciąg (wymagany)
wartość Wartość parametru polecenia run. ciąg (wymagany)

VirtualMachineRunCommandScriptSource

Nazwa Opis Wartość
Commandid Określa identyfikator polecenia wstępnie zdefiniowanego wbudowanego skryptu. ciąg
skrypt Określa zawartość skryptu do wykonania na maszynie wirtualnej. ciąg
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. ciąg
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 została udzielona dostępu do kontenera obiektów blob z przypisaniem roli "Czytelnik danych obiektów blob usługi Storage". W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamość 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 dziennik zmian.

Format zasobu

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

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

Wartości właściwości

virtualMachineScaleSets/virtualMachines/runCommands

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

VirtualMachineRunCommandProperties

Nazwa Opis Wartość
asyncExecution Opcjonalny. Jeśli ustawiono wartość true, aprowizacja zostanie zakończona zaraz 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ść 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 w celu zapewnienia dostępu maszyny wirtualnej do obiektu blob. Zapoznaj się z parametrem errorBlobManagedIdentity. ciąg
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ść 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 w celu zapewnienia dostępu maszyny wirtualnej do obiektu blob. Zapoznaj się z parametrem outputBlobManagedIdentity. ciąg
parameters 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 run. ciąg
runAsUser Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia run. ciąg
source Źródło skryptu polecenia run. VirtualMachineRunCommandScriptSource
timeoutInSeconds Limit czasu w sekundach do wykonania polecenia uruchomienia. int
treatFailureAsDeploymentFailure Opcjonalny. Jeśli ustawiono wartość true, wszystkie błędy w skry skrycie nie powiedzą się, a parametr ProvisioningState zostanie oznaczony jako Niepowodzenie. Jeśli ustawiono wartość false, provisioningState będzie odzwierciedlać tylko to, czy polecenie uruchomienia zostało uruchomione, czy nie przez platformę rozszerzeń, nie oznaczałoby to, czy skrypt zakończył się niepowodzeniem w przypadku awarii skryptu. Zobacz widok wystąpienia polecenia uruchamiania w przypadku niepowodzeń skryptu, aby wyświetlić komunikat 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. Identyfikator ObjectId nie powinien być używany, jeśli jest to podane. ciąg
objectId Identyfikator obiektu (wartość GUID) tożsamości zarządzanej przypisanej przez użytkownika. Identyfikator ClientId nie powinien być używany, jeśli jest to podane. ciąg

RunCommandInputParameter

Nazwa Opis Wartość
name Nazwa parametru polecenia run. ciąg (wymagany)
wartość Wartość parametru polecenia run. ciąg (wymagany)

VirtualMachineRunCommandScriptSource

Nazwa Opis Wartość
Commandid Określa identyfikator polecenia wstępnie zdefiniowanego wbudowanego skryptu. ciąg
skrypt Określa zawartość skryptu do wykonania na maszynie wirtualnej. ciąg
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. ciąg
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 została udzielona dostępu do kontenera obiektów blob z przypisaniem roli "Czytelnik danych obiektów blob usługi Storage". W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamość 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