Microsoft.Compute virtualMachines/extensions

• Najnowsza
• 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

Definicja zasobu Bicep

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

• Grupy zasobów — zobacz polecenia wdrażania 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/virtualMachines/extensions, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.Compute/virtualMachines/extensions@2023-09-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    autoUpgradeMinorVersion: bool
    enableAutomaticUpgrade: bool
    forceUpdateTag: 'string'
    instanceView: {
      name: 'string'
      statuses: [
        {
          code: 'string'
          displayStatus: 'string'
          level: 'string'
          message: 'string'
          time: 'string'
        }
      ]
      substatuses: [
        {
          code: 'string'
          displayStatus: 'string'
          level: 'string'
          message: 'string'
          time: 'string'
        }
      ]
      type: 'string'
      typeHandlerVersion: 'string'
    }
    protectedSettings: any()
    protectedSettingsFromKeyVault: {
      secretUrl: 'string'
      sourceVault: {
        id: 'string'
      }
    }
    provisionAfterExtensions: [
      'string'
    ]
    publisher: 'string'
    settings: any()
    suppressFailures: bool
    type: 'string'
    typeHandlerVersion: 'string'
  }
}

Wartości właściwości

virtualMachines/extensions

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
tags	Tagi zasobów	Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
Nadrzędny	W pliku 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.	Symboliczna nazwa zasobu typu: virtualMachines
properties	Opisuje właściwości rozszerzenia maszyny wirtualnej.	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Nazwa	Opis	Wartość
autoUpgradeMinorVersion	Wskazuje, czy rozszerzenie powinno używać nowszej wersji pomocniczej, jeśli jest ona dostępna w czasie wdrażania. Po wdrożeniu rozszerzenie nie będzie jednak uaktualniać wersji pomocniczych, chyba że zostanie ponownie wdrożone, nawet jeśli ta właściwość ma wartość true.	bool
enableAutomaticUpgrade	Wskazuje, czy rozszerzenie powinno zostać automatycznie uaktualnione przez platformę, jeśli dostępna jest nowsza wersja rozszerzenia.	bool
forceUpdateTag	Sposób, w jaki program obsługi rozszerzeń powinien zostać zmuszony do aktualizacji, nawet jeśli konfiguracja rozszerzenia nie uległa zmianie.	ciąg
Instanceview	Widok wystąpienia rozszerzenia maszyny wirtualnej.	VirtualMachineExtensionInstanceView
protectedSettings	Rozszerzenie może zawierać ustawienia protectedSettings lub protectedSettingsFromKeyVault lub w ogóle nie są chronione.	W przypadku Bicep można użyć funkcji any().
protectedSettingsFromKeyVault	Rozszerzenia chronione ustawienia, które są przekazywane przez odwołanie i używane z magazynu kluczy	KeyVaultSecretReference
provisionAfterExtensions	Kolekcja nazw rozszerzeń, po których należy aprowizować to rozszerzenie.	ciąg[]
publisher	Nazwa wydawcy programu obsługi rozszerzeń.	ciąg
ustawienia	Ustawienia publiczne w formacie Json dla rozszerzenia.	W przypadku Bicep można użyć funkcji any().
suppressFailures	Wskazuje, czy błędy wynikające z rozszerzenia zostaną pominięte (błędy operacyjne, takie jak brak połączenia z maszyną wirtualną, nie zostaną pominięte niezależnie od tej wartości). Wartością domyślną jest false.	bool
typ	Określa typ rozszerzenia; przykładem jest "CustomScriptExtension".	ciąg
typeHandlerVersion	Określa wersję programu obsługi skryptów.	ciąg

VirtualMachineExtensionInstanceView

Nazwa	Opis	Wartość
name	Nazwa rozszerzenia maszyny wirtualnej.	ciąg
Statusy	Informacje o stanie zasobu.	InstanceViewStatus[]
podstatuses	Informacje o stanie zasobu.	InstanceViewStatus[]
typ	Określa typ rozszerzenia; przykładem jest "CustomScriptExtension".	ciąg
typeHandlerVersion	Określa wersję programu obsługi skryptów.	ciąg

InstanceViewStatus

Nazwa	Opis	Wartość
kod	Kod stanu.	ciąg
displayStatus	Krótka etykieta lokalizowalna dla stanu.	ciąg
poziom	Kod poziomu.	"Błąd" "Informacje" "Ostrzeżenie"
message	Szczegółowy komunikat o stanie, w tym alerty i komunikaty o błędach.	ciąg
time	Czas stanu.	ciąg

KeyVaultSecretReference

Nazwa	Opis	Wartość
secretUrl	Adres URL odwołujący się do wpisu tajnego w Key Vault.	ciąg (wymagany)
sourceVault	Względny adres URL Key Vault zawierający wpis tajny.	Podźródło (wymagane)

Podźródło

Nazwa	Opis	Wartość
identyfikator	Identyfikator zasobu	ciąg

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Template	Opis
Tworzenie maszyny wirtualnej z systemem Windows z włączonym rozszerzeniem chroniącym przed złośliwym oprogramowaniem	Ten szablon tworzy maszynę wirtualną z systemem Windows i konfiguruje ochronę przed złośliwym oprogramowaniem
Serwer IIS z rozszerzeniem DSC na maszynie wirtualnej z systemem Windows	Ten szablon tworzy maszynę wirtualną z systemem Windows i konfiguruje serwer usług IIS przy użyciu rozszerzenia DSC. Należy pamiętać, że moduł konfiguracji DSC wymaga przekazania tokenu SAS, jeśli używasz usługi Azure Storage. W przypadku linku modułu DSC z usługi GitHub (domyślnie w tym szablonie) nie jest to wymagane.
Rozszerzenie maszyny wirtualnej FIRMY ESET	Tworzy maszynę wirtualną z rozszerzeniem FIRMY ESET
McAfee Endpoint Security (licencja próbna) na maszynie wirtualnej z systemem Windows	Ten szablon tworzy maszynę wirtualną z systemem Windows i konfiguruje wersję próbną programu McAfee Endpoint Security
Wdrażanie maszyny wirtualnej z systemem Ubuntu przy użyciu rozszerzenia pakietu OMS	Ten szablon umożliwia wdrożenie maszyny wirtualnej z systemem Ubuntu z zainstalowanym rozszerzeniem pakietu OMS i dołączonym do określonego obszaru roboczego
Wdrażanie maszyny wirtualnej z systemem Windows przy użyciu rozszerzenia pakietu OMS	Ten szablon umożliwia wdrożenie maszyny wirtualnej z systemem Windows z zainstalowanym i dołączonym rozszerzeniem pakietu OMS do określonego obszaru roboczego
Wersja próbna rozszerzenia Symantec Endpoint Protection na maszynie wirtualnej z systemem Windows	Ten szablon tworzy maszynę wirtualną z systemem Windows i konfiguruje wersję próbną programu Symantec Endpoint Protection
Rozszerzenie niestandardowego skryptu na maszynie wirtualnej z systemem Ubuntu	Ten szablon tworzy maszynę wirtualną z systemem Ubuntu i instaluje rozszerzenie CustomScript
Rozszerzenie stosowania poprawek systemu operacyjnego na maszynie wirtualnej z systemem Ubuntu	Ten szablon tworzy maszynę wirtualną z systemem Ubuntu i instaluje rozszerzenie OSPatching
Wdrażanie maszyny wirtualnej z systemem Windows w warstwie Premium przy użyciu diagnostyki	Ten szablon umożliwia wdrożenie maszyny wirtualnej z systemem Windows w warstwie Premium przy użyciu kilku różnych opcji dla wersji systemu Windows przy użyciu najnowszej poprawkowej wersji.
Wdrażanie prostej maszyny wirtualnej z systemem Windows z monitorowaniem i diagnostyką	Ten szablon umożliwia wdrożenie prostej maszyny wirtualnej z systemem Windows wraz z rozszerzeniem diagnostycznym, które umożliwia monitorowanie i diagnostykę maszyny wirtualnej
Instalowanie bazy danych Mongo DB na maszynie wirtualnej z systemem Ubuntu przy użyciu rozszerzeń skryptów	Ten szablon służy do wdrażania i instalowania bazy danych Mongo DB na maszynie wirtualnej z systemem Ubuntu w dwóch oddzielnych skryptach. Ten szablon jest dobrym przykładem pokazującym sposób wyrażania zależności między dwoma skryptami uruchomionymi na tej samej maszynie wirtualnej. Ten szablon służy również do wdrażania konta magazynu, Virtual Network, publicznych adresów IP i interfejsu sieciowego.

Definicja zasobu szablonu usługi ARM

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

• Grupy zasobów — zobacz polecenia wdrażania 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/virtualMachines/extensions, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "apiVersion": "2023-09-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "autoUpgradeMinorVersion": "bool",
    "enableAutomaticUpgrade": "bool",
    "forceUpdateTag": "string",
    "instanceView": {
      "name": "string",
      "statuses": [
        {
          "code": "string",
          "displayStatus": "string",
          "level": "string",
          "message": "string",
          "time": "string"
        }
      ],
      "substatuses": [
        {
          "code": "string",
          "displayStatus": "string",
          "level": "string",
          "message": "string",
          "time": "string"
        }
      ],
      "type": "string",
      "typeHandlerVersion": "string"
    },
    "protectedSettings": {},
    "protectedSettingsFromKeyVault": {
      "secretUrl": "string",
      "sourceVault": {
        "id": "string"
      }
    },
    "provisionAfterExtensions": [ "string" ],
    "publisher": "string",
    "settings": {},
    "suppressFailures": "bool",
    "type": "string",
    "typeHandlerVersion": "string"
  }
}

Wartości właściwości

virtualMachines/extensions

Nazwa	Opis	Wartość
typ	Typ zasobu	"Microsoft.Compute/virtualMachines/extensions"
apiVersion	Wersja interfejsu API zasobów	'2023-09-01'
name	Nazwa zasobu Zobacz, jak ustawiać nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM JSON.	ciąg (wymagany)
location	Lokalizacja zasobu	ciąg
tags	Tagi zasobów	Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
properties	Opisuje właściwości rozszerzenia maszyny wirtualnej.	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Nazwa	Opis	Wartość
autoUpgradeMinorVersion	Wskazuje, czy rozszerzenie powinno używać nowszej wersji pomocniczej, jeśli jest ona dostępna w czasie wdrażania. Po wdrożeniu rozszerzenie nie będzie jednak uaktualniać wersji pomocniczych, chyba że zostanie ponownie wdrożone, nawet jeśli ta właściwość ma wartość true.	bool
enableAutomaticUpgrade	Wskazuje, czy rozszerzenie powinno zostać automatycznie uaktualnione przez platformę, jeśli dostępna jest nowsza wersja rozszerzenia.	bool
forceUpdateTag	Sposób, w jaki program obsługi rozszerzeń powinien zostać zmuszony do aktualizacji, nawet jeśli konfiguracja rozszerzenia nie uległa zmianie.	ciąg
Instanceview	Widok wystąpienia rozszerzenia maszyny wirtualnej.	VirtualMachineExtensionInstanceView
protectedSettings	Rozszerzenie może zawierać ustawienia protectedSettings lub protectedSettingsFromKeyVault lub w ogóle nie są chronione.
protectedSettingsFromKeyVault	Rozszerzenia chronione ustawienia, które są przekazywane przez odwołanie i używane z magazynu kluczy	KeyVaultSecretReference
provisionAfterExtensions	Kolekcja nazw rozszerzeń, po których należy aprowizować to rozszerzenie.	ciąg[]
publisher	Nazwa wydawcy programu obsługi rozszerzeń.	ciąg
ustawienia	Ustawienia publiczne w formacie Json dla rozszerzenia.
suppressFailures	Wskazuje, czy błędy wynikające z rozszerzenia zostaną pominięte (błędy operacyjne, takie jak brak połączenia z maszyną wirtualną, nie zostaną pominięte niezależnie od tej wartości). Wartością domyślną jest false.	bool
typ	Określa typ rozszerzenia; przykładem jest "CustomScriptExtension".	ciąg
typeHandlerVersion	Określa wersję programu obsługi skryptów.	ciąg

VirtualMachineExtensionInstanceView

Nazwa	Opis	Wartość
name	Nazwa rozszerzenia maszyny wirtualnej.	ciąg
Statusy	Informacje o stanie zasobu.	InstanceViewStatus[]
podstatuses	Informacje o stanie zasobu.	InstanceViewStatus[]
typ	Określa typ rozszerzenia; przykładem jest "CustomScriptExtension".	ciąg
typeHandlerVersion	Określa wersję programu obsługi skryptów.	ciąg

InstanceViewStatus

Nazwa	Opis	Wartość
kod	Kod stanu.	ciąg
displayStatus	Krótka etykieta lokalizowalna dla stanu.	ciąg
poziom	Kod poziomu.	"Błąd" "Informacje" "Ostrzeżenie"
message	Szczegółowy komunikat o stanie, w tym alerty i komunikaty o błędach.	ciąg
time	Czas stanu.	ciąg

KeyVaultSecretReference

Nazwa	Opis	Wartość
secretUrl	Adres URL odwołujący się do wpisu tajnego w Key Vault.	ciąg (wymagany)
sourceVault	Względny adres URL Key Vault zawierający wpis tajny.	Podźródło (wymagane)

Podźródło

Nazwa	Opis	Wartość
identyfikator	Identyfikator zasobu	ciąg

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Template	Opis
Tworzenie maszyny wirtualnej z systemem Windows z włączonym rozszerzeniem chroniącym przed złośliwym oprogramowaniem	Ten szablon tworzy maszynę wirtualną z systemem Windows i konfiguruje ochronę przed złośliwym oprogramowaniem
Serwer IIS z rozszerzeniem DSC na maszynie wirtualnej z systemem Windows	Ten szablon tworzy maszynę wirtualną z systemem Windows i konfiguruje serwer usług IIS przy użyciu rozszerzenia DSC. Należy pamiętać, że moduł konfiguracji DSC wymaga przekazania tokenu SAS, jeśli używasz usługi Azure Storage. W przypadku linku modułu DSC z usługi GitHub (domyślnie w tym szablonie) nie jest to wymagane.
Rozszerzenie maszyny wirtualnej FIRMY ESET	Tworzy maszynę wirtualną z rozszerzeniem FIRMY ESET
McAfee Endpoint Security (licencja próbna) na maszynie wirtualnej z systemem Windows	Ten szablon tworzy maszynę wirtualną z systemem Windows i konfiguruje wersję próbną programu McAfee Endpoint Security
Wdrażanie maszyny wirtualnej z systemem Ubuntu przy użyciu rozszerzenia pakietu OMS	Ten szablon umożliwia wdrożenie maszyny wirtualnej z systemem Ubuntu z zainstalowanym rozszerzeniem pakietu OMS i dołączonym do określonego obszaru roboczego
Wdrażanie maszyny wirtualnej z systemem Windows przy użyciu rozszerzenia pakietu OMS	Ten szablon umożliwia wdrożenie maszyny wirtualnej z systemem Windows z zainstalowanym i dołączonym rozszerzeniem pakietu OMS do określonego obszaru roboczego
Wersja próbna rozszerzenia Symantec Endpoint Protection na maszynie wirtualnej z systemem Windows	Ten szablon tworzy maszynę wirtualną z systemem Windows i konfiguruje wersję próbną programu Symantec Endpoint Protection
Rozszerzenie niestandardowego skryptu na maszynie wirtualnej z systemem Ubuntu	Ten szablon tworzy maszynę wirtualną z systemem Ubuntu i instaluje rozszerzenie CustomScript
Rozszerzenie stosowania poprawek systemu operacyjnego na maszynie wirtualnej z systemem Ubuntu	Ten szablon tworzy maszynę wirtualną z systemem Ubuntu i instaluje rozszerzenie OSPatching
Wdrażanie maszyny wirtualnej z systemem Windows w warstwie Premium przy użyciu diagnostyki	Ten szablon umożliwia wdrożenie maszyny wirtualnej z systemem Windows w warstwie Premium przy użyciu kilku różnych opcji dla wersji systemu Windows przy użyciu najnowszej poprawkowej wersji.
Wdrażanie prostej maszyny wirtualnej z systemem Windows z monitorowaniem i diagnostyką	Ten szablon umożliwia wdrożenie prostej maszyny wirtualnej z systemem Windows wraz z rozszerzeniem diagnostycznym, które umożliwia monitorowanie i diagnostykę maszyny wirtualnej
Instalowanie bazy danych Mongo DB na maszynie wirtualnej z systemem Ubuntu przy użyciu rozszerzeń skryptów	Ten szablon służy do wdrażania i instalowania bazy danych Mongo DB na maszynie wirtualnej z systemem Ubuntu w dwóch oddzielnych skryptach. Ten szablon jest dobrym przykładem pokazującym sposób wyrażania zależności między dwoma skryptami uruchomionymi na tej samej maszynie wirtualnej. Ten szablon służy również do wdrażania konta magazynu, Virtual Network, publicznych adresów IP i interfejsu sieciowego.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

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

• 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/virtualMachines/extensions, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachines/extensions@2023-09-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      autoUpgradeMinorVersion = bool
      enableAutomaticUpgrade = bool
      forceUpdateTag = "string"
      instanceView = {
        name = "string"
        statuses = [
          {
            code = "string"
            displayStatus = "string"
            level = "string"
            message = "string"
            time = "string"
          }
        ]
        substatuses = [
          {
            code = "string"
            displayStatus = "string"
            level = "string"
            message = "string"
            time = "string"
          }
        ]
        type = "string"
        typeHandlerVersion = "string"
      }
      protectedSettingsFromKeyVault = {
        secretUrl = "string"
        sourceVault = {
          id = "string"
        }
      }
      provisionAfterExtensions = [
        "string"
      ]
      publisher = "string"
      suppressFailures = bool
      type = "string"
      typeHandlerVersion = "string"
    }
  })
}

Wartości właściwości

virtualMachines/extensions

Nazwa	Opis	Wartość
typ	Typ zasobu	"Microsoft.Compute/virtualMachines/extensions@2023-09-01"
name	Nazwa zasobu	ciąg (wymagany)
location	Lokalizacja zasobu	ciąg
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 rozszerzenia maszyny wirtualnej.	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Nazwa	Opis	Wartość
autoUpgradeMinorVersion	Wskazuje, czy rozszerzenie powinno używać nowszej wersji pomocniczej, jeśli jest ona dostępna w czasie wdrażania. Po wdrożeniu rozszerzenie nie uaktualni wersji pomocniczych, chyba że zostanie ponownie wdrożone, nawet jeśli ta właściwość ma wartość true.	bool
enableAutomaticUpgrade	Wskazuje, czy rozszerzenie powinno zostać automatycznie uaktualnione przez platformę, jeśli jest dostępna nowsza wersja rozszerzenia.	bool
forceUpdateTag	Sposób, w jaki program obsługi rozszerzeń powinien zostać zmuszony do aktualizacji, nawet jeśli konfiguracja rozszerzenia nie uległa zmianie.	ciąg
Instanceview	Widok wystąpienia rozszerzenia maszyny wirtualnej.	VirtualMachineExtensionInstanceView
protectedSettings	Rozszerzenie może zawierać ustawienia protectedSettings lub protectedSettingsFromKeyVault lub w ogóle nie są chronione.
protectedSettingsFromKeyVault	Ustawienia chronione rozszerzeń, które są przekazywane przez odwołanie i używane z magazynu kluczy	KeyVaultSecretReference
provisionAfterExtensions	Kolekcja nazw rozszerzeń, po których należy aprowizować to rozszerzenie.	ciąg[]
publisher	Nazwa wydawcy programu obsługi rozszerzeń.	ciąg
ustawienia	Formatowane ustawienia publiczne w formacie JSON dla rozszerzenia.
suppressFailures	Wskazuje, czy awarie wynikające z rozszerzenia zostaną pominięte (błędy operacyjne, takie jak brak nawiązywania połączenia z maszyną wirtualną, nie zostaną pominięte niezależnie od tej wartości). Wartością domyślną jest false.	bool
typ	Określa typ rozszerzenia; przykładem jest "CustomScriptExtension".	ciąg
typeHandlerVersion	Określa wersję programu obsługi skryptów.	ciąg

VirtualMachineExtensionInstanceView

Nazwa	Opis	Wartość
name	Nazwa rozszerzenia maszyny wirtualnej.	ciąg
Statusy	Informacje o stanie zasobu.	InstanceViewStatus[]
podstany	Informacje o stanie zasobu.	InstanceViewStatus[]
typ	Określa typ rozszerzenia; przykładem jest "CustomScriptExtension".	ciąg
typeHandlerVersion	Określa wersję programu obsługi skryptów.	ciąg

InstanceViewStatus

Nazwa	Opis	Wartość
kod	Kod stanu.	ciąg
displayStatus	Krótka etykieta lokalizowalna dla stanu.	ciąg
poziom	Kod poziomu.	"Błąd" "Informacje" "Ostrzeżenie"
message	Szczegółowy komunikat o stanie, w tym alerty i komunikaty o błędach.	ciąg
time	Czas stanu.	ciąg

KeyVaultSecretReference

Nazwa	Opis	Wartość
secretUrl	Adres URL odwołujący się do wpisu tajnego w Key Vault.	ciąg (wymagany)
sourceVault	Względny adres URL Key Vault zawierający wpis tajny.	Podźródło (wymagane)

Podźródło

Nazwa	Opis	Wartość
identyfikator	Identyfikator zasobu	ciąg