Microsoft.Compute virtualMachineScaleSets/virtualMachines/extensions 2023-09-01
Bicep-Ressourcendefinition
Der Ressourcentyp virtualMachineScaleSets/virtualMachines/extensions kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Ressource "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions" zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2023-09-01' = {
name: 'string'
location: 'string'
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'
}
}
Eigenschaftswerte
virtualMachineScaleSets/virtualMachines/extensions
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep. |
Zeichenfolge (erforderlich) |
| location | Der Speicherort der Erweiterung. | Zeichenfolge |
| parent | In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource. |
Symbolischer Name für Ressource vom Typ : virtualMachines |
| properties | Beschreibt die Eigenschaften einer VM-Erweiterung. | VirtualMachineExtensionProperties |
VirtualMachineExtensionProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| autoUpgradeMinorVersion | Gibt an, ob die Erweiterung eine neuere Nebenversion verwenden soll, wenn sie zum Zeitpunkt der Bereitstellung verfügbar ist. Abgesehen von erneuten Bereitstellungen führt die Erweiterung nach der Bereitstellung jedoch keine Upgrades für Nebenversionen aus, selbst wenn diese Eigenschaft auf „true“ festgelegt ist. | bool |
| enableAutomaticUpgrade | Gibt an, ob die Erweiterung automatisch von der Plattform aktualisiert werden soll, wenn eine neuere Version der Erweiterung verfügbar ist. | bool |
| forceUpdateTag | Wie der Erweiterungshandler zum Aktualisieren gezwungen werden soll, auch wenn sich die Erweiterungskonfiguration nicht geändert hat. | Zeichenfolge |
| instanceView | Die VM-Erweiterung instance Ansicht. | VirtualMachineExtensionInstanceView |
| protectedSettings | Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder gar keine geschützten Einstellungen enthalten. | Für Bicep können Sie die funktion any() verwenden. |
| protectedSettingsFromKeyVault | Die durch Erweiterungen geschützten Einstellungen, die als Verweis übergeben und vom Schlüsseltresor verwendet werden | KeyVaultSecretReference |
| provisionAfterExtensions | Sammlung von Erweiterungsnamen, nach denen diese Erweiterung bereitgestellt werden muss. | string[] |
| publisher | Der Name des Erweiterungshandlerherausgebers. | Zeichenfolge |
| settings | Im Json-Format formatierte öffentliche Einstellungen für die Erweiterung. | Für Bicep können Sie die funktion any() verwenden. |
| suppressFailures | Gibt an, ob Fehler, die von der Erweiterung stammen, unterdrückt werden (Betriebsfehler, z. B. keine Verbindung mit dem virtuellen Computer herzustellen, werden unabhängig von diesem Wert nicht unterdrückt). Die Standardeinstellung ist „false“. | bool |
| Typ | Gibt den Typ der Erweiterung an. Ein Beispiel ist "CustomScriptExtension". | Zeichenfolge |
| typeHandlerVersion | Gibt die Version des Skripthandlers an. | Zeichenfolge |
VirtualMachineExtensionInstanceView
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Name der VM-Erweiterung. | Zeichenfolge |
| statuses | Die Ressource status Informationen. | InstanceViewStatus[] |
| substatuses | Die Ressource status Informationen. | InstanceViewStatus[] |
| Typ | Gibt den Typ der Erweiterung an. Ein Beispiel ist "CustomScriptExtension". | Zeichenfolge |
| typeHandlerVersion | Gibt die Version des Skripthandlers an. | Zeichenfolge |
InstanceViewStatus
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| code | Der Statuscode. | Zeichenfolge |
| displayStatus | Die kurze lokalisierbare Bezeichnung für die status. | Zeichenfolge |
| Level | Der Ebenencode. | "Fehler" "Info" "Warnung" |
| message | Die detaillierte status Meldung, einschließlich Warnungen und Fehlermeldungen. | Zeichenfolge |
| time | Die Zeit des status. | Zeichenfolge |
KeyVaultSecretReference
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| secretUrl | Die URL, die auf ein Geheimnis in einer Key Vault verweist. | Zeichenfolge (erforderlich) |
| sourceVault | Die relative URL der Key Vault, die das Geheimnis enthält. | SubResource (erforderlich) |
Subresource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| id | Ressourcen-ID | Zeichenfolge |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp virtualMachineScaleSets/virtualMachines/extensions kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
"apiVersion": "2023-09-01",
"name": "string",
"location": "string",
"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"
}
}
Eigenschaftswerte
virtualMachineScaleSets/virtualMachines/extensions
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions" |
| apiVersion | Die Ressourcen-API-Version | '2023-09-01' |
| name | Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen. |
Zeichenfolge (erforderlich) |
| location | Der Speicherort der Erweiterung. | Zeichenfolge |
| properties | Beschreibt die Eigenschaften einer VM-Erweiterung. | VirtualMachineExtensionProperties |
VirtualMachineExtensionProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| autoUpgradeMinorVersion | Gibt an, ob die Erweiterung eine neuere Nebenversion verwenden soll, wenn sie zur Bereitstellungszeit verfügbar ist. Abgesehen von erneuten Bereitstellungen führt die Erweiterung nach der Bereitstellung jedoch keine Upgrades für Nebenversionen aus, selbst wenn diese Eigenschaft auf „true“ festgelegt ist. | bool |
| enableAutomaticUpgrade | Gibt an, ob die Erweiterung automatisch von der Plattform aktualisiert werden soll, wenn eine neuere Version der Erweiterung verfügbar ist. | bool |
| forceUpdateTag | Wie der Erweiterungshandler zum Aktualisieren gezwungen werden soll, auch wenn sich die Erweiterungskonfiguration nicht geändert hat. | Zeichenfolge |
| instanceView | Die VM-Erweiterung instance Ansicht. | VirtualMachineExtensionInstanceView |
| protectedSettings | Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder überhaupt keine geschützten Einstellungen enthalten. | |
| protectedSettingsFromKeyVault | Die durch Erweiterungen geschützten Einstellungen, die als Verweis übergeben und aus dem Schlüsseltresor verwendet werden | KeyVaultSecretReference |
| provisionAfterExtensions | Auflistung von Erweiterungsnamen, nach denen diese Erweiterung bereitgestellt werden muss. | string[] |
| publisher | Der Name des Erweiterungshandlerherausgebers. | Zeichenfolge |
| settings | Json-formatierte öffentliche Einstellungen für die Erweiterung. | |
| suppressFailures | Gibt an, ob Fehler, die von der Erweiterung stammen, unterdrückt werden (Betriebsfehler, z. B. keine Verbindung mit dem virtuellen Computer herzustellen, werden unabhängig von diesem Wert nicht unterdrückt). Die Standardeinstellung ist „false“. | bool |
| Typ | Gibt den Typ der Erweiterung an. Ein Beispiel ist "CustomScriptExtension". | Zeichenfolge |
| typeHandlerVersion | Gibt die Version des Skripthandlers an. | Zeichenfolge |
VirtualMachineExtensionInstanceView
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Name der VM-Erweiterung. | Zeichenfolge |
| statuses | Die Ressource status Informationen. | InstanceViewStatus[] |
| substatuses | Die Ressource status Informationen. | InstanceViewStatus[] |
| Typ | Gibt den Typ der Erweiterung an. Ein Beispiel ist "CustomScriptExtension". | Zeichenfolge |
| typeHandlerVersion | Gibt die Version des Skripthandlers an. | Zeichenfolge |
InstanceViewStatus
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| code | Der Statuscode. | Zeichenfolge |
| displayStatus | Die kurze lokalisierbare Bezeichnung für die status. | Zeichenfolge |
| Level | Der Ebenencode. | "Fehler" 'Info' "Warnung" |
| message | Die detaillierte status Meldung, einschließlich Warnungen und Fehlermeldungen. | Zeichenfolge |
| time | Die Zeit der status. | Zeichenfolge |
KeyVaultSecretReference
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| secretUrl | Die URL, die auf ein Geheimnis in einem Key Vault verweist. | Zeichenfolge (erforderlich) |
| sourceVault | Die relative URL der Key Vault, die das Geheimnis enthält. | SubResource (erforderlich) |
Subresource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| id | Ressourcen-ID | Zeichenfolge |
Terraform-Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp virtualMachineScaleSets/virtualMachines/extensions kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Ressource "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions" zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2023-09-01"
name = "string"
location = "string"
parent_id = "string"
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"
}
})
}
Eigenschaftswerte
virtualMachineScaleSets/virtualMachines/extensions
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2023-09-01" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| location | Der Speicherort der Erweiterung. | Zeichenfolge |
| parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource vom Typ : virtualMachines |
| properties | Beschreibt die Eigenschaften einer VM-Erweiterung. | VirtualMachineExtensionProperties |
VirtualMachineExtensionProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| autoUpgradeMinorVersion | Gibt an, ob die Erweiterung eine neuere Nebenversion verwenden soll, wenn sie zum Zeitpunkt der Bereitstellung verfügbar ist. Abgesehen von erneuten Bereitstellungen führt die Erweiterung nach der Bereitstellung jedoch keine Upgrades für Nebenversionen aus, selbst wenn diese Eigenschaft auf „true“ festgelegt ist. | bool |
| enableAutomaticUpgrade | Gibt an, ob die Erweiterung automatisch von der Plattform aktualisiert werden soll, wenn eine neuere Version der Erweiterung verfügbar ist. | bool |
| forceUpdateTag | Wie der Erweiterungshandler zum Aktualisieren gezwungen werden soll, auch wenn sich die Erweiterungskonfiguration nicht geändert hat. | Zeichenfolge |
| instanceView | Die VM-Erweiterung instance Ansicht. | VirtualMachineExtensionInstanceView |
| protectedSettings | Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder gar keine geschützten Einstellungen enthalten. | |
| protectedSettingsFromKeyVault | Die durch Erweiterungen geschützten Einstellungen, die als Verweis übergeben und vom Schlüsseltresor verwendet werden | KeyVaultSecretReference |
| provisionAfterExtensions | Sammlung von Erweiterungsnamen, nach denen diese Erweiterung bereitgestellt werden muss. | string[] |
| publisher | Der Name des Erweiterungshandlerherausgebers. | Zeichenfolge |
| settings | Im Json-Format formatierte öffentliche Einstellungen für die Erweiterung. | |
| suppressFailures | Gibt an, ob Fehler, die von der Erweiterung stammen, unterdrückt werden (Betriebsfehler, z. B. keine Verbindung mit dem virtuellen Computer herzustellen, werden unabhängig von diesem Wert nicht unterdrückt). Die Standardeinstellung ist „false“. | bool |
| Typ | Gibt den Typ der Erweiterung an. Ein Beispiel ist "CustomScriptExtension". | Zeichenfolge |
| typeHandlerVersion | Gibt die Version des Skripthandlers an. | Zeichenfolge |
VirtualMachineExtensionInstanceView
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Name der VM-Erweiterung. | Zeichenfolge |
| statuses | Die Ressource status Informationen. | InstanceViewStatus[] |
| substatuses | Die Ressource status Informationen. | InstanceViewStatus[] |
| Typ | Gibt den Typ der Erweiterung an. Ein Beispiel ist "CustomScriptExtension". | Zeichenfolge |
| typeHandlerVersion | Gibt die Version des Skripthandlers an. | Zeichenfolge |
InstanceViewStatus
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| code | Der Statuscode. | Zeichenfolge |
| displayStatus | Die kurze lokalisierbare Bezeichnung für die status. | Zeichenfolge |
| Level | Der Ebenencode. | "Fehler" "Info" "Warning" |
| message | Die detaillierte status Meldung, einschließlich Warnungen und Fehlermeldungen. | Zeichenfolge |
| time | Die Zeit der status. | Zeichenfolge |
KeyVaultSecretReference
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| secretUrl | Die URL, die auf ein Geheimnis in einem Key Vault verweist. | Zeichenfolge (erforderlich) |
| sourceVault | Die relative URL der Key Vault, die das Geheimnis enthält. | SubResource (erforderlich) |
Subresource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| id | Ressourcen-ID | Zeichenfolge |
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für