Udostępnij za pośrednictwem


Microsoft.Compute virtualMachines/extensions 2023-03-01

Definicja zasobu Bicep

Typ zasobu virtualMachines/extensions 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/virtualMachines/extensions, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.Compute/virtualMachines/extensions@2023-03-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ść
nazwa Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w Bicep.
ciąg (wymagany)
lokalizacja Lokalizacja zasobu struna
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 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. struna
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. string[]
wydawca Nazwa wydawcy programu obsługi rozszerzeń. struna
Ustawienia Ustawienia publiczne w formacie Json dla rozszerzenia. W przypadku Bicep można użyć funkcji any().
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ść domyślna to false. Bool
typ Określa typ rozszerzenia; przykładem jest "CustomScriptExtension". struna
typeHandlerVersion Określa wersję programu obsługi skryptów. struna

VirtualMachineExtensionInstanceView

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

InstanceViewStatus

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

KeyVaultSecretReference

Nazwa Opis Wartość
secretUrl Adres URL odwołujący się do wpisu tajnego w usłudze Key Vault. ciąg (wymagany)
sourceVault Względny adres URL usługi Key Vault zawierający wpis tajny. SubResource (wymagane)

Podźródło

Nazwa Opis Wartość
id Identyfikator zasobu struna

Szablony szybkiego startu

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

Szablon Opis
Tworzenie maszyny wirtualnej z systemem Windows z włączonym rozszerzeniem chroniącym przed złośliwym oprogramowaniem

wdrażanie w usłudze Azure
Ten szablon tworzy maszynę wirtualną z systemem Windows i konfiguruje ochronę przed złośliwym oprogramowaniem
serwera IIS przy użyciu rozszerzenia DSC na maszynie wirtualnej z systemem Windows

wdrażanie w usłudze Azure
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.
rozszerzenia maszyny wirtualnej PROGRAMU VM PROGRAMU

wdrażanie w usłudze Azure
Tworzy maszynę wirtualną z rozszerzeniem FIRMY ESET
McAfee Endpoint Security (licencja próbna) na maszynie wirtualnej z systemem Windows

wdrażanie w usłudze Azure
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

wdrażanie w usłudze Azure
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

wdrażanie w usłudze Azure
Ten szablon umożliwia wdrożenie maszyny wirtualnej z systemem Windows z zainstalowanym rozszerzeniem pakietu OMS i dołączonym do określonego obszaru roboczego
wersji próbnej rozszerzenia Symantec Endpoint Protection na maszynie wirtualnej z systemem Windows

wdrażanie w usłudze Azure
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

wdrażanie w usłudze Azure
Ten szablon tworzy maszynę wirtualną z systemem Ubuntu i instaluje rozszerzenie CustomScript
rozszerzenie stosowania poprawek systemu operacyjnego na maszynie wirtualnej z systemem Ubuntu

wdrażanie w usłudze Azure
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

wdrażanie w usłudze Azure
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 przy użyciu monitorowania i diagnostyki

wdrażanie w usłudze Azure
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
Używanie rozszerzeń skryptów do instalowania bazy danych Mongo DB na maszynie wirtualnej z systemem Ubuntu

wdrażanie w usłudze Azure
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 wdraża również konto magazynu, sieć wirtualną, publiczne adresy IP i interfejs sieciowy.

Definicja zasobu szablonu usługi ARM

Typ zasobu virtualMachines/extensions 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/virtualMachines/extensions, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "apiVersion": "2023-03-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-03-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 struna
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 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. struna
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. string[]
wydawca Nazwa wydawcy programu obsługi rozszerzeń. struna
Ustawienia 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ść domyślna to false. Bool
typ Określa typ rozszerzenia; przykładem jest "CustomScriptExtension". struna
typeHandlerVersion Określa wersję programu obsługi skryptów. struna

VirtualMachineExtensionInstanceView

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

InstanceViewStatus

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

KeyVaultSecretReference

Nazwa Opis Wartość
secretUrl Adres URL odwołujący się do wpisu tajnego w usłudze Key Vault. ciąg (wymagany)
sourceVault Względny adres URL usługi Key Vault zawierający wpis tajny. SubResource (wymagane)

Podźródło

Nazwa Opis Wartość
id Identyfikator zasobu struna

Szablony szybkiego startu

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

Szablon Opis
Tworzenie maszyny wirtualnej z systemem Windows z włączonym rozszerzeniem chroniącym przed złośliwym oprogramowaniem

wdrażanie w usłudze Azure
Ten szablon tworzy maszynę wirtualną z systemem Windows i konfiguruje ochronę przed złośliwym oprogramowaniem
serwera IIS przy użyciu rozszerzenia DSC na maszynie wirtualnej z systemem Windows

wdrażanie w usłudze Azure
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.
rozszerzenia maszyny wirtualnej PROGRAMU VM PROGRAMU

wdrażanie w usłudze Azure
Tworzy maszynę wirtualną z rozszerzeniem FIRMY ESET
McAfee Endpoint Security (licencja próbna) na maszynie wirtualnej z systemem Windows

wdrażanie w usłudze Azure
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

wdrażanie w usłudze Azure
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

wdrażanie w usłudze Azure
Ten szablon umożliwia wdrożenie maszyny wirtualnej z systemem Windows z zainstalowanym rozszerzeniem pakietu OMS i dołączonym do określonego obszaru roboczego
wersji próbnej rozszerzenia Symantec Endpoint Protection na maszynie wirtualnej z systemem Windows

wdrażanie w usłudze Azure
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

wdrażanie w usłudze Azure
Ten szablon tworzy maszynę wirtualną z systemem Ubuntu i instaluje rozszerzenie CustomScript
rozszerzenie stosowania poprawek systemu operacyjnego na maszynie wirtualnej z systemem Ubuntu

wdrażanie w usłudze Azure
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

wdrażanie w usłudze Azure
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 przy użyciu monitorowania i diagnostyki

wdrażanie w usłudze Azure
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
Używanie rozszerzeń skryptów do instalowania bazy danych Mongo DB na maszynie wirtualnej z systemem Ubuntu

wdrażanie w usłudze Azure
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 wdraża również konto magazynu, sieć wirtualną, publiczne adresy IP i interfejs sieciowy.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachines/extensions@2023-03-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-03-01"
nazwa Nazwa zasobu ciąg (wymagany)
lokalizacja Lokalizacja zasobu struna
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 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. struna
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. string[]
wydawca Nazwa wydawcy programu obsługi rozszerzeń. struna
Ustawienia 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ść domyślna to false. Bool
typ Określa typ rozszerzenia; przykładem jest "CustomScriptExtension". struna
typeHandlerVersion Określa wersję programu obsługi skryptów. struna

VirtualMachineExtensionInstanceView

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

InstanceViewStatus

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

KeyVaultSecretReference

Nazwa Opis Wartość
secretUrl Adres URL odwołujący się do wpisu tajnego w usłudze Key Vault. ciąg (wymagany)
sourceVault Względny adres URL usługi Key Vault zawierający wpis tajny. SubResource (wymagane)

Podźródło

Nazwa Opis Wartość
id Identyfikator zasobu struna