Freigeben über


Microsoft.Compute cloudServices 2022-09-04

Bicep-Ressourcendefinition

Der CloudServices-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Compute/cloudServices-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.Compute/cloudServices@2022-09-04' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    allowModelOverride: bool
    configuration: 'string'
    configurationUrl: 'string'
    extensionProfile: {
      extensions: [
        {
          name: 'string'
          properties: {
            autoUpgradeMinorVersion: bool
            forceUpdateTag: 'string'
            protectedSettings: any()
            protectedSettingsFromKeyVault: {
              secretUrl: 'string'
              sourceVault: {
                id: 'string'
              }
            }
            publisher: 'string'
            rolesAppliedTo: [
              'string'
            ]
            settings: any()
            type: 'string'
            typeHandlerVersion: 'string'
          }
        }
      ]
    }
    networkProfile: {
      loadBalancerConfigurations: [
        {
          id: 'string'
          name: 'string'
          properties: {
            frontendIpConfigurations: [
              {
                name: 'string'
                properties: {
                  privateIPAddress: 'string'
                  publicIPAddress: {
                    id: 'string'
                  }
                  subnet: {
                    id: 'string'
                  }
                }
              }
            ]
          }
        }
      ]
      slotType: 'string'
      swappableCloudService: {
        id: 'string'
      }
    }
    osProfile: {
      secrets: [
        {
          sourceVault: {
            id: 'string'
          }
          vaultCertificates: [
            {
              certificateUrl: 'string'
            }
          ]
        }
      ]
    }
    packageUrl: 'string'
    roleProfile: {
      roles: [
        {
          name: 'string'
          sku: {
            capacity: int
            name: 'string'
            tier: 'string'
          }
        }
      ]
    }
    startCloudService: bool
    upgradeMode: 'string'
  }
  systemData: {}
  zones: [
    'string' or int
  ]
}

Eigenschaftswerte

cloudServices

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 1-15



Gültige Zeichen:
Leerzeichen, Steuerzeichen oder diese Zeichen können nicht verwendet werden:
~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ?

Kann nicht mit Unterstrich beginnen. Kann nicht mit Punkt oder Bindestrich enden.
Ort Ressourcenspeicherort. Zeichenfolge (erforderlich)
Schilder Ressourcentags. Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Eigenschaften Clouddiensteigenschaften CloudServiceProperties
systemData Die Systemmetadaten, die sich auf diese Ressource beziehen. SystemData-
Zonen Liste der logischen Verfügbarkeitszone der Ressource. Die Liste sollte nur eine Zone enthalten, in der Clouddienst bereitgestellt werden soll. Dieses Feld ist optional. Array von Verfügbarkeitszonen als Zeichenfolge oder Int.

CloudServiceProperties

Name Beschreibung Wert
allowModelOverride (Optional) Gibt an, ob die rollensku-Eigenschaften (roleProfile.roles.sku), die im Modell/der Vorlage angegeben sind, die Anzahl der Rolleninstanzen und die vm-Größe überschreiben soll, die in der CSCFG- bzw. CSDEF-Datei angegeben ist.
Der Standardwert ist false.
Bool
Konfiguration Gibt die XML-Dienstkonfiguration (.cscfg) für den Clouddienst an. Schnur
configurationUrl Gibt eine URL an, die auf den Speicherort der Dienstkonfiguration im Blob-Dienst verweist. Die Dienstpaket-URL kann von einem beliebigen Speicherkonto aus einen SAS-URI (Shared Access Signature) sein.
Dies ist eine schreibgeschützte Eigenschaft und wird in GET-Aufrufen nicht zurückgegeben.
Schnur
extensionProfile Beschreibt ein Clouddiensterweiterungsprofil. CloudServiceExtensionProfile
networkProfile Netzwerkprofil für den Clouddienst. CloudServiceNetworkProfile-
osProfile Beschreibt das Betriebssystemprofil für den Clouddienst. CloudServiceOsProfile-
packageUrl Gibt eine URL an, die auf den Speicherort des Dienstpakets im Blob-Dienst verweist. Die Dienstpaket-URL kann von einem beliebigen Speicherkonto aus einen SAS-URI (Shared Access Signature) sein.
Dies ist eine schreibgeschützte Eigenschaft und wird in GET-Aufrufen nicht zurückgegeben.
Schnur
roleProfile Beschreibt das Rollenprofil für den Clouddienst. CloudServiceRoleProfile-
startCloudService (Optional) Gibt an, ob der Clouddienst unmittelbar nach der Erstellung gestartet werden soll. Der Standardwert ist true.
Wenn false, wird das Dienstmodell weiterhin bereitgestellt, der Code wird jedoch nicht sofort ausgeführt. Stattdessen wird der Dienst unterstützt, bis Sie "Start" aufrufen, zu dem zeitpunkt, zu dem der Dienst gestartet wird. Ein bereitgestellter Dienst verursacht weiterhin Gebühren, auch wenn er ausgeschaltet wird.
Bool
upgradeMode Updatemodus für den Clouddienst. Rolleninstanzen werden aktualisierungsdomänen zugewiesen, wenn der Dienst bereitgestellt wird. Updates können manuell in jeder Updatedomäne initiiert oder automatisch in allen Updatedomänen initiiert werden.
Mögliche Werte sind

automatischen

Manuelle

gleichzeitige


Wenn nicht angegeben, ist der Standardwert "Auto". Wenn "Manuell" festgelegt ist, muss PUT UpdateDomain aufgerufen werden, um das Update anzuwenden. Bei Festlegung auf "Automatisch" wird das Update automatisch auf jede Updatedomäne in Folge angewendet.
"Auto"
"Manuell"
"Gleichzeitig"

CloudServiceExtensionProfile

Name Beschreibung Wert
Erweiterungen Liste der Erweiterungen für den Clouddienst. Erweiterung[]

Erweiterung

Name Beschreibung Wert
Name Der Name der Erweiterung. Schnur
Eigenschaften Erweiterungseigenschaften. CloudServiceExtensionProperties-

CloudServiceExtensionProperties

Name Beschreibung Wert
autoUpgradeMinorVersion Geben Sie explizit an, ob die Plattform typeHandlerVersion automatisch auf höhere Nebenversionen aktualisieren kann, wenn sie verfügbar sind. Bool
forceUpdateTag Tag zum Erzwingen der Anwendung der bereitgestellten öffentlichen und geschützten Einstellungen.
Wenn Sie den Tagwert ändern, können Sie die Erweiterung erneut ausführen, ohne die öffentlichen oder geschützten Einstellungen zu ändern.
Wenn forceUpdateTag nicht geändert wird, werden Updates für öffentliche oder geschützte Einstellungen weiterhin vom Handler angewendet.
Wenn sich weder forceUpdateTag noch eine der öffentlichen oder geschützten Einstellungen ändert, würde die Erweiterung zur Rolleninstanz mit derselben Sequenznummer fließen und
es ist an der Handlerimplementierung, ob sie erneut ausgeführt werden soll oder nicht.
Schnur
protectedSettings Geschützte Einstellungen für die Erweiterung, die vor dem Senden an die Rolleninstanz verschlüsselt werden. Für Bicep können Sie die any()-Funktion verwenden.
protectedSettingsFromKeyVault Geschützte Einstellungen für die Erweiterung, auf die mithilfe von KeyVault verwiesen wird, die verschlüsselt werden, bevor sie an die Rolleninstanz gesendet werden. CloudServiceVaultAndSecretReference
Verlag Der Name des Herausgebers des Erweiterungshandlers. Schnur
rolesAppliedTo Optionale Liste der Rollen, die diese Erweiterung anwenden sollen. Wenn die Eigenschaft nicht angegeben oder '*' angegeben ist, wird die Erweiterung auf alle Rollen im Clouddienst angewendet. string[]
Einstellungen Öffentliche Einstellungen für die Erweiterung. Bei JSON-Erweiterungen ist dies die JSON-Einstellungen für die Erweiterung. Für XML-Erweiterung (z. B. RDP) ist dies die XML-Einstellung für die Erweiterung. Für Bicep können Sie die any()-Funktion verwenden.
Art Gibt den Typ der Erweiterung an. Schnur
typeHandlerVersion Gibt die Version der Erweiterung an. Gibt die Version der Erweiterung an. Wenn dieses Element nicht angegeben ist oder ein Sternchen (*) als Wert verwendet wird, wird die neueste Version der Erweiterung verwendet. Wenn der Wert mit einer Hauptversionsnummer und einem Sternchen als Nebenversionsnummer (X.) angegeben wird, wird die neueste Nebenversion der angegebenen Hauptversion ausgewählt. Wenn eine Hauptversionsnummer und eine Nebenversionsnummer angegeben werden (X.Y), wird die spezifische Erweiterungsversion ausgewählt. Wenn eine Version angegeben ist, wird ein automatisches Upgrade für die Rolleninstanz ausgeführt. Schnur

CloudServiceVaultAndSecretReference

Name Beschreibung Wert
secretUrl Geheime URL, die die geschützten Einstellungen der Erweiterung enthält Schnur
sourceVault Die ARM-Ressourcen-ID des Key Vault SubResource-

Unterressource

Name Beschreibung Wert
id Ressourcen-ID Schnur

CloudServiceNetworkProfile

Name Beschreibung Wert
loadBalancerConfigurations Liste der Konfigurationen des Lastenausgleichs. Der Clouddienst kann bis zu zwei Lastenausgleichskonfigurationen aufweisen, die einem öffentlichen Lastenausgleichsmodul und einem internen Lastenausgleichsmodul entsprechen. LoadBalancerConfiguration[]
slotType Slottyp für den Clouddienst.
Mögliche Werte sind

Produktions-

Staging-


Wenn nicht angegeben, lautet der Standardwert "Production".
"Produktion"
"Staging"
swappableCloudService Der ID-Verweis des Clouddiensts, der die Ziel-IP enthält, mit der der Betreff-Clouddienst einen Tausch durchführen kann. Diese Eigenschaft kann nicht aktualisiert werden, nachdem sie festgelegt wurde. Der austauschbare Clouddienst, auf den diese ID verweist, muss vorhanden sein, andernfalls wird ein Fehler ausgelöst. SubResource-

LoadBalancerConfiguration

Name Beschreibung Wert
id Ressourcen-ID Schnur
Name Der Name des Lastenausgleichsmoduls Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften der Konfiguration des Lastenausgleichs. LoadBalancerConfigurationProperties (erforderlich)

LoadBalancerConfigurationProperties

Name Beschreibung Wert
frontendIpConfigurations Gibt die Front-End-IP an, die für das Lastenausgleichsmodul verwendet werden soll. Nur IPv4-Frontend-IP-Adresse wird unterstützt. Jede Konfiguration des Lastenausgleichs muss genau eine Front-End-IP-Konfiguration aufweisen. LoadBalancerFrontendIpConfiguration[] (erforderlich)

LoadBalancerFrontendIpConfiguration

Name Beschreibung Wert
Name Der Name der Ressource, die innerhalb des Satzes von Front-End-IP-Konfigurationen eindeutig ist, die vom Lastenausgleichsmodul verwendet werden. Dieser Name kann für den Zugriff auf die Ressource verwendet werden. Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften der Front-End-Ip-Konfiguration des Lastenausgleichs. LoadBalancerFrontendIpConfigurationProperties (erforderlich)

LoadBalancerFrontendIpConfigurationProperties

Name Beschreibung Wert
privateIPAddress Die private IP-Adresse des virtuellen Netzwerks der IP-Konfiguration. Schnur
publicIPAddress Der Verweis auf die Öffentliche IP-Adressressource. SubResource-
Subnetz Der Verweis auf die Subnetzressource des virtuellen Netzwerks. SubResource-

CloudServiceOsProfile

Name Beschreibung Wert
Geheimnisse Gibt einen Satz von Zertifikaten an, die in den Rolleninstanzen installiert werden sollen. CloudServiceVaultSecretGroup[]

CloudServiceVaultSecretGroup

Name Beschreibung Wert
sourceVault Die relative URL des Key Vault mit allen Zertifikaten in VaultCertificates. SubResource-
vaultCertificates Die Liste der Schlüsseltresorverweise in SourceVault, die Zertifikate enthalten. CloudServiceVaultCertificate[]

CloudServiceVaultCertificate

Name Beschreibung Wert
certificateUrl Dies ist die URL eines Zertifikats, das als geheimer Schlüssel in den Key Vault hochgeladen wurde. Schnur

CloudServiceRoleProfile

Name Beschreibung Wert
Rollen Liste der Rollen für den Clouddienst. CloudServiceRoleProfileProperties[]

CloudServiceRoleProfileProperties

Name Beschreibung Wert
Name Ressourcenname. Schnur
Sku Beschreibt die Clouddienstrollensku. CloudServiceRoleSku-

CloudServiceRoleSku

Name Beschreibung Wert
Fassungsvermögen Gibt die Anzahl der Rolleninstanzen im Clouddienst an. Int
Name Der Sku-Name. HINWEIS: Wenn die neue SKU auf der Hardware, auf der der Clouddienst derzeit installiert ist, nicht unterstützt wird, müssen Sie den Clouddienst löschen und neu erstellen oder zur alten SKU zurückkehren. Schnur
Rang Gibt die Ebene des Clouddiensts an. Mögliche Werte sind

Standard-

Basic-
Schnur

SystemData

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

ARM-Vorlagenressourcendefinition

Der CloudServices-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Compute/cloudServices-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.Compute/cloudServices",
  "apiVersion": "2022-09-04",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "allowModelOverride": "bool",
    "configuration": "string",
    "configurationUrl": "string",
    "extensionProfile": {
      "extensions": [
        {
          "name": "string",
          "properties": {
            "autoUpgradeMinorVersion": "bool",
            "forceUpdateTag": "string",
            "protectedSettings": {},
            "protectedSettingsFromKeyVault": {
              "secretUrl": "string",
              "sourceVault": {
                "id": "string"
              }
            },
            "publisher": "string",
            "rolesAppliedTo": [ "string" ],
            "settings": {},
            "type": "string",
            "typeHandlerVersion": "string"
          }
        }
      ]
    },
    "networkProfile": {
      "loadBalancerConfigurations": [
        {
          "id": "string",
          "name": "string",
          "properties": {
            "frontendIpConfigurations": [
              {
                "name": "string",
                "properties": {
                  "privateIPAddress": "string",
                  "publicIPAddress": {
                    "id": "string"
                  },
                  "subnet": {
                    "id": "string"
                  }
                }
              }
            ]
          }
        }
      ],
      "slotType": "string",
      "swappableCloudService": {
        "id": "string"
      }
    },
    "osProfile": {
      "secrets": [
        {
          "sourceVault": {
            "id": "string"
          },
          "vaultCertificates": [
            {
              "certificateUrl": "string"
            }
          ]
        }
      ]
    },
    "packageUrl": "string",
    "roleProfile": {
      "roles": [
        {
          "name": "string",
          "sku": {
            "capacity": "int",
            "name": "string",
            "tier": "string"
          }
        }
      ]
    },
    "startCloudService": "bool",
    "upgradeMode": "string"
  },
  "systemData": {},
  "zones": [ "string" or int ]
}

Eigenschaftswerte

cloudServices

Name Beschreibung Wert
Art Der Ressourcentyp "Microsoft.Compute/cloudServices"
apiVersion Die Ressourcen-API-Version '2022-09-04'
Name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 1-15



Gültige Zeichen:
Leerzeichen, Steuerzeichen oder diese Zeichen können nicht verwendet werden:
~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ?

Kann nicht mit Unterstrich beginnen. Kann nicht mit Punkt oder Bindestrich enden.
Ort Ressourcenspeicherort. Zeichenfolge (erforderlich)
Schilder Ressourcentags. Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Eigenschaften Clouddiensteigenschaften CloudServiceProperties
systemData Die Systemmetadaten, die sich auf diese Ressource beziehen. SystemData-
Zonen Liste der logischen Verfügbarkeitszone der Ressource. Die Liste sollte nur eine Zone enthalten, in der Clouddienst bereitgestellt werden soll. Dieses Feld ist optional. Array von Verfügbarkeitszonen als Zeichenfolge oder Int.

CloudServiceProperties

Name Beschreibung Wert
allowModelOverride (Optional) Gibt an, ob die rollensku-Eigenschaften (roleProfile.roles.sku), die im Modell/der Vorlage angegeben sind, die Anzahl der Rolleninstanzen und die vm-Größe überschreiben soll, die in der CSCFG- bzw. CSDEF-Datei angegeben ist.
Der Standardwert ist false.
Bool
Konfiguration Gibt die XML-Dienstkonfiguration (.cscfg) für den Clouddienst an. Schnur
configurationUrl Gibt eine URL an, die auf den Speicherort der Dienstkonfiguration im Blob-Dienst verweist. Die Dienstpaket-URL kann von einem beliebigen Speicherkonto aus einen SAS-URI (Shared Access Signature) sein.
Dies ist eine schreibgeschützte Eigenschaft und wird in GET-Aufrufen nicht zurückgegeben.
Schnur
extensionProfile Beschreibt ein Clouddiensterweiterungsprofil. CloudServiceExtensionProfile
networkProfile Netzwerkprofil für den Clouddienst. CloudServiceNetworkProfile-
osProfile Beschreibt das Betriebssystemprofil für den Clouddienst. CloudServiceOsProfile-
packageUrl Gibt eine URL an, die auf den Speicherort des Dienstpakets im Blob-Dienst verweist. Die Dienstpaket-URL kann von einem beliebigen Speicherkonto aus einen SAS-URI (Shared Access Signature) sein.
Dies ist eine schreibgeschützte Eigenschaft und wird in GET-Aufrufen nicht zurückgegeben.
Schnur
roleProfile Beschreibt das Rollenprofil für den Clouddienst. CloudServiceRoleProfile-
startCloudService (Optional) Gibt an, ob der Clouddienst unmittelbar nach der Erstellung gestartet werden soll. Der Standardwert ist true.
Wenn false, wird das Dienstmodell weiterhin bereitgestellt, der Code wird jedoch nicht sofort ausgeführt. Stattdessen wird der Dienst unterstützt, bis Sie "Start" aufrufen, zu dem zeitpunkt, zu dem der Dienst gestartet wird. Ein bereitgestellter Dienst verursacht weiterhin Gebühren, auch wenn er ausgeschaltet wird.
Bool
upgradeMode Updatemodus für den Clouddienst. Rolleninstanzen werden aktualisierungsdomänen zugewiesen, wenn der Dienst bereitgestellt wird. Updates können manuell in jeder Updatedomäne initiiert oder automatisch in allen Updatedomänen initiiert werden.
Mögliche Werte sind

automatischen

Manuelle

gleichzeitige


Wenn nicht angegeben, ist der Standardwert "Auto". Wenn "Manuell" festgelegt ist, muss PUT UpdateDomain aufgerufen werden, um das Update anzuwenden. Bei Festlegung auf "Automatisch" wird das Update automatisch auf jede Updatedomäne in Folge angewendet.
"Auto"
"Manuell"
"Gleichzeitig"

CloudServiceExtensionProfile

Name Beschreibung Wert
Erweiterungen Liste der Erweiterungen für den Clouddienst. Erweiterung[]

Erweiterung

Name Beschreibung Wert
Name Der Name der Erweiterung. Schnur
Eigenschaften Erweiterungseigenschaften. CloudServiceExtensionProperties-

CloudServiceExtensionProperties

Name Beschreibung Wert
autoUpgradeMinorVersion Geben Sie explizit an, ob die Plattform typeHandlerVersion automatisch auf höhere Nebenversionen aktualisieren kann, wenn sie verfügbar sind. Bool
forceUpdateTag Tag zum Erzwingen der Anwendung der bereitgestellten öffentlichen und geschützten Einstellungen.
Wenn Sie den Tagwert ändern, können Sie die Erweiterung erneut ausführen, ohne die öffentlichen oder geschützten Einstellungen zu ändern.
Wenn forceUpdateTag nicht geändert wird, werden Updates für öffentliche oder geschützte Einstellungen weiterhin vom Handler angewendet.
Wenn sich weder forceUpdateTag noch eine der öffentlichen oder geschützten Einstellungen ändert, würde die Erweiterung zur Rolleninstanz mit derselben Sequenznummer fließen und
es ist an der Handlerimplementierung, ob sie erneut ausgeführt werden soll oder nicht.
Schnur
protectedSettings Geschützte Einstellungen für die Erweiterung, die vor dem Senden an die Rolleninstanz verschlüsselt werden.
protectedSettingsFromKeyVault Geschützte Einstellungen für die Erweiterung, auf die mithilfe von KeyVault verwiesen wird, die verschlüsselt werden, bevor sie an die Rolleninstanz gesendet werden. CloudServiceVaultAndSecretReference
Verlag Der Name des Herausgebers des Erweiterungshandlers. Schnur
rolesAppliedTo Optionale Liste der Rollen, die diese Erweiterung anwenden sollen. Wenn die Eigenschaft nicht angegeben oder '*' angegeben ist, wird die Erweiterung auf alle Rollen im Clouddienst angewendet. string[]
Einstellungen Öffentliche Einstellungen für die Erweiterung. Bei JSON-Erweiterungen ist dies die JSON-Einstellungen für die Erweiterung. Für XML-Erweiterung (z. B. RDP) ist dies die XML-Einstellung für die Erweiterung.
Art Gibt den Typ der Erweiterung an. Schnur
typeHandlerVersion Gibt die Version der Erweiterung an. Gibt die Version der Erweiterung an. Wenn dieses Element nicht angegeben ist oder ein Sternchen (*) als Wert verwendet wird, wird die neueste Version der Erweiterung verwendet. Wenn der Wert mit einer Hauptversionsnummer und einem Sternchen als Nebenversionsnummer (X.) angegeben wird, wird die neueste Nebenversion der angegebenen Hauptversion ausgewählt. Wenn eine Hauptversionsnummer und eine Nebenversionsnummer angegeben werden (X.Y), wird die spezifische Erweiterungsversion ausgewählt. Wenn eine Version angegeben ist, wird ein automatisches Upgrade für die Rolleninstanz ausgeführt. Schnur

CloudServiceVaultAndSecretReference

Name Beschreibung Wert
secretUrl Geheime URL, die die geschützten Einstellungen der Erweiterung enthält Schnur
sourceVault Die ARM-Ressourcen-ID des Key Vault SubResource-

Unterressource

Name Beschreibung Wert
id Ressourcen-ID Schnur

CloudServiceNetworkProfile

Name Beschreibung Wert
loadBalancerConfigurations Liste der Konfigurationen des Lastenausgleichs. Der Clouddienst kann bis zu zwei Lastenausgleichskonfigurationen aufweisen, die einem öffentlichen Lastenausgleichsmodul und einem internen Lastenausgleichsmodul entsprechen. LoadBalancerConfiguration[]
slotType Slottyp für den Clouddienst.
Mögliche Werte sind

Produktions-

Staging-


Wenn nicht angegeben, lautet der Standardwert "Production".
"Produktion"
"Staging"
swappableCloudService Der ID-Verweis des Clouddiensts, der die Ziel-IP enthält, mit der der Betreff-Clouddienst einen Tausch durchführen kann. Diese Eigenschaft kann nicht aktualisiert werden, nachdem sie festgelegt wurde. Der austauschbare Clouddienst, auf den diese ID verweist, muss vorhanden sein, andernfalls wird ein Fehler ausgelöst. SubResource-

LoadBalancerConfiguration

Name Beschreibung Wert
id Ressourcen-ID Schnur
Name Der Name des Lastenausgleichsmoduls Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften der Konfiguration des Lastenausgleichs. LoadBalancerConfigurationProperties (erforderlich)

LoadBalancerConfigurationProperties

Name Beschreibung Wert
frontendIpConfigurations Gibt die Front-End-IP an, die für das Lastenausgleichsmodul verwendet werden soll. Nur IPv4-Frontend-IP-Adresse wird unterstützt. Jede Konfiguration des Lastenausgleichs muss genau eine Front-End-IP-Konfiguration aufweisen. LoadBalancerFrontendIpConfiguration[] (erforderlich)

LoadBalancerFrontendIpConfiguration

Name Beschreibung Wert
Name Der Name der Ressource, die innerhalb des Satzes von Front-End-IP-Konfigurationen eindeutig ist, die vom Lastenausgleichsmodul verwendet werden. Dieser Name kann für den Zugriff auf die Ressource verwendet werden. Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften der Front-End-Ip-Konfiguration des Lastenausgleichs. LoadBalancerFrontendIpConfigurationProperties (erforderlich)

LoadBalancerFrontendIpConfigurationProperties

Name Beschreibung Wert
privateIPAddress Die private IP-Adresse des virtuellen Netzwerks der IP-Konfiguration. Schnur
publicIPAddress Der Verweis auf die Öffentliche IP-Adressressource. SubResource-
Subnetz Der Verweis auf die Subnetzressource des virtuellen Netzwerks. SubResource-

CloudServiceOsProfile

Name Beschreibung Wert
Geheimnisse Gibt einen Satz von Zertifikaten an, die in den Rolleninstanzen installiert werden sollen. CloudServiceVaultSecretGroup[]

CloudServiceVaultSecretGroup

Name Beschreibung Wert
sourceVault Die relative URL des Key Vault mit allen Zertifikaten in VaultCertificates. SubResource-
vaultCertificates Die Liste der Schlüsseltresorverweise in SourceVault, die Zertifikate enthalten. CloudServiceVaultCertificate[]

CloudServiceVaultCertificate

Name Beschreibung Wert
certificateUrl Dies ist die URL eines Zertifikats, das als geheimer Schlüssel in den Key Vault hochgeladen wurde. Schnur

CloudServiceRoleProfile

Name Beschreibung Wert
Rollen Liste der Rollen für den Clouddienst. CloudServiceRoleProfileProperties[]

CloudServiceRoleProfileProperties

Name Beschreibung Wert
Name Ressourcenname. Schnur
Sku Beschreibt die Clouddienstrollensku. CloudServiceRoleSku-

CloudServiceRoleSku

Name Beschreibung Wert
Fassungsvermögen Gibt die Anzahl der Rolleninstanzen im Clouddienst an. Int
Name Der Sku-Name. HINWEIS: Wenn die neue SKU auf der Hardware, auf der der Clouddienst derzeit installiert ist, nicht unterstützt wird, müssen Sie den Clouddienst löschen und neu erstellen oder zur alten SKU zurückkehren. Schnur
Rang Gibt die Ebene des Clouddiensts an. Mögliche Werte sind

Standard-

Basic-
Schnur

SystemData

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der CloudServices-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Compute/cloudServices-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/cloudServices@2022-09-04"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      allowModelOverride = bool
      configuration = "string"
      configurationUrl = "string"
      extensionProfile = {
        extensions = [
          {
            name = "string"
            properties = {
              autoUpgradeMinorVersion = bool
              forceUpdateTag = "string"
              protectedSettingsFromKeyVault = {
                secretUrl = "string"
                sourceVault = {
                  id = "string"
                }
              }
              publisher = "string"
              rolesAppliedTo = [
                "string"
              ]
              type = "string"
              typeHandlerVersion = "string"
            }
          }
        ]
      }
      networkProfile = {
        loadBalancerConfigurations = [
          {
            id = "string"
            name = "string"
            properties = {
              frontendIpConfigurations = [
                {
                  name = "string"
                  properties = {
                    privateIPAddress = "string"
                    publicIPAddress = {
                      id = "string"
                    }
                    subnet = {
                      id = "string"
                    }
                  }
                }
              ]
            }
          }
        ]
        slotType = "string"
        swappableCloudService = {
          id = "string"
        }
      }
      osProfile = {
        secrets = [
          {
            sourceVault = {
              id = "string"
            }
            vaultCertificates = [
              {
                certificateUrl = "string"
              }
            ]
          }
        ]
      }
      packageUrl = "string"
      roleProfile = {
        roles = [
          {
            name = "string"
            sku = {
              capacity = int
              name = "string"
              tier = "string"
            }
          }
        ]
      }
      startCloudService = bool
      upgradeMode = "string"
    }
    systemData = {}
    zones = [
      "string" or int
    ]
  })
}

Eigenschaftswerte

cloudServices

Name Beschreibung Wert
Art Der Ressourcentyp "Microsoft.Compute/cloudServices@2022-09-04"
Name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 1-15



Gültige Zeichen:
Leerzeichen, Steuerzeichen oder diese Zeichen können nicht verwendet werden:
~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ?

Kann nicht mit Unterstrich beginnen. Kann nicht mit Punkt oder Bindestrich enden.
Ort Ressourcenspeicherort. Zeichenfolge (erforderlich)
parent_id Verwenden Sie die ID dieser Ressourcengruppe, um sie in einer Ressourcengruppe bereitzustellen. Zeichenfolge (erforderlich)
Schilder Ressourcentags. Wörterbuch der Tagnamen und -werte.
Eigenschaften Clouddiensteigenschaften CloudServiceProperties
systemData Die Systemmetadaten, die sich auf diese Ressource beziehen. SystemData-
Zonen Liste der logischen Verfügbarkeitszone der Ressource. Die Liste sollte nur eine Zone enthalten, in der Clouddienst bereitgestellt werden soll. Dieses Feld ist optional. Array von Verfügbarkeitszonen als Zeichenfolge oder Int.

CloudServiceProperties

Name Beschreibung Wert
allowModelOverride (Optional) Gibt an, ob die rollensku-Eigenschaften (roleProfile.roles.sku), die im Modell/der Vorlage angegeben sind, die Anzahl der Rolleninstanzen und die vm-Größe überschreiben soll, die in der CSCFG- bzw. CSDEF-Datei angegeben ist.
Der Standardwert ist false.
Bool
Konfiguration Gibt die XML-Dienstkonfiguration (.cscfg) für den Clouddienst an. Schnur
configurationUrl Gibt eine URL an, die auf den Speicherort der Dienstkonfiguration im Blob-Dienst verweist. Die Dienstpaket-URL kann von einem beliebigen Speicherkonto aus einen SAS-URI (Shared Access Signature) sein.
Dies ist eine schreibgeschützte Eigenschaft und wird in GET-Aufrufen nicht zurückgegeben.
Schnur
extensionProfile Beschreibt ein Clouddiensterweiterungsprofil. CloudServiceExtensionProfile
networkProfile Netzwerkprofil für den Clouddienst. CloudServiceNetworkProfile-
osProfile Beschreibt das Betriebssystemprofil für den Clouddienst. CloudServiceOsProfile-
packageUrl Gibt eine URL an, die auf den Speicherort des Dienstpakets im Blob-Dienst verweist. Die Dienstpaket-URL kann von einem beliebigen Speicherkonto aus einen SAS-URI (Shared Access Signature) sein.
Dies ist eine schreibgeschützte Eigenschaft und wird in GET-Aufrufen nicht zurückgegeben.
Schnur
roleProfile Beschreibt das Rollenprofil für den Clouddienst. CloudServiceRoleProfile-
startCloudService (Optional) Gibt an, ob der Clouddienst unmittelbar nach der Erstellung gestartet werden soll. Der Standardwert ist true.
Wenn false, wird das Dienstmodell weiterhin bereitgestellt, der Code wird jedoch nicht sofort ausgeführt. Stattdessen wird der Dienst unterstützt, bis Sie "Start" aufrufen, zu dem zeitpunkt, zu dem der Dienst gestartet wird. Ein bereitgestellter Dienst verursacht weiterhin Gebühren, auch wenn er ausgeschaltet wird.
Bool
upgradeMode Updatemodus für den Clouddienst. Rolleninstanzen werden aktualisierungsdomänen zugewiesen, wenn der Dienst bereitgestellt wird. Updates können manuell in jeder Updatedomäne initiiert oder automatisch in allen Updatedomänen initiiert werden.
Mögliche Werte sind

automatischen

Manuelle

gleichzeitige


Wenn nicht angegeben, ist der Standardwert "Auto". Wenn "Manuell" festgelegt ist, muss PUT UpdateDomain aufgerufen werden, um das Update anzuwenden. Bei Festlegung auf "Automatisch" wird das Update automatisch auf jede Updatedomäne in Folge angewendet.
"Auto"
"Manuell"
"Gleichzeitig"

CloudServiceExtensionProfile

Name Beschreibung Wert
Erweiterungen Liste der Erweiterungen für den Clouddienst. Erweiterung[]

Erweiterung

Name Beschreibung Wert
Name Der Name der Erweiterung. Schnur
Eigenschaften Erweiterungseigenschaften. CloudServiceExtensionProperties-

CloudServiceExtensionProperties

Name Beschreibung Wert
autoUpgradeMinorVersion Geben Sie explizit an, ob die Plattform typeHandlerVersion automatisch auf höhere Nebenversionen aktualisieren kann, wenn sie verfügbar sind. Bool
forceUpdateTag Tag zum Erzwingen der Anwendung der bereitgestellten öffentlichen und geschützten Einstellungen.
Wenn Sie den Tagwert ändern, können Sie die Erweiterung erneut ausführen, ohne die öffentlichen oder geschützten Einstellungen zu ändern.
Wenn forceUpdateTag nicht geändert wird, werden Updates für öffentliche oder geschützte Einstellungen weiterhin vom Handler angewendet.
Wenn sich weder forceUpdateTag noch eine der öffentlichen oder geschützten Einstellungen ändert, würde die Erweiterung zur Rolleninstanz mit derselben Sequenznummer fließen und
es ist an der Handlerimplementierung, ob sie erneut ausgeführt werden soll oder nicht.
Schnur
protectedSettings Geschützte Einstellungen für die Erweiterung, die vor dem Senden an die Rolleninstanz verschlüsselt werden.
protectedSettingsFromKeyVault Geschützte Einstellungen für die Erweiterung, auf die mithilfe von KeyVault verwiesen wird, die verschlüsselt werden, bevor sie an die Rolleninstanz gesendet werden. CloudServiceVaultAndSecretReference
Verlag Der Name des Herausgebers des Erweiterungshandlers. Schnur
rolesAppliedTo Optionale Liste der Rollen, die diese Erweiterung anwenden sollen. Wenn die Eigenschaft nicht angegeben oder '*' angegeben ist, wird die Erweiterung auf alle Rollen im Clouddienst angewendet. string[]
Einstellungen Öffentliche Einstellungen für die Erweiterung. Bei JSON-Erweiterungen ist dies die JSON-Einstellungen für die Erweiterung. Für XML-Erweiterung (z. B. RDP) ist dies die XML-Einstellung für die Erweiterung.
Art Gibt den Typ der Erweiterung an. Schnur
typeHandlerVersion Gibt die Version der Erweiterung an. Gibt die Version der Erweiterung an. Wenn dieses Element nicht angegeben ist oder ein Sternchen (*) als Wert verwendet wird, wird die neueste Version der Erweiterung verwendet. Wenn der Wert mit einer Hauptversionsnummer und einem Sternchen als Nebenversionsnummer (X.) angegeben wird, wird die neueste Nebenversion der angegebenen Hauptversion ausgewählt. Wenn eine Hauptversionsnummer und eine Nebenversionsnummer angegeben werden (X.Y), wird die spezifische Erweiterungsversion ausgewählt. Wenn eine Version angegeben ist, wird ein automatisches Upgrade für die Rolleninstanz ausgeführt. Schnur

CloudServiceVaultAndSecretReference

Name Beschreibung Wert
secretUrl Geheime URL, die die geschützten Einstellungen der Erweiterung enthält Schnur
sourceVault Die ARM-Ressourcen-ID des Key Vault SubResource-

Unterressource

Name Beschreibung Wert
id Ressourcen-ID Schnur

CloudServiceNetworkProfile

Name Beschreibung Wert
loadBalancerConfigurations Liste der Konfigurationen des Lastenausgleichs. Der Clouddienst kann bis zu zwei Lastenausgleichskonfigurationen aufweisen, die einem öffentlichen Lastenausgleichsmodul und einem internen Lastenausgleichsmodul entsprechen. LoadBalancerConfiguration[]
slotType Slottyp für den Clouddienst.
Mögliche Werte sind

Produktions-

Staging-


Wenn nicht angegeben, lautet der Standardwert "Production".
"Produktion"
"Staging"
swappableCloudService Der ID-Verweis des Clouddiensts, der die Ziel-IP enthält, mit der der Betreff-Clouddienst einen Tausch durchführen kann. Diese Eigenschaft kann nicht aktualisiert werden, nachdem sie festgelegt wurde. Der austauschbare Clouddienst, auf den diese ID verweist, muss vorhanden sein, andernfalls wird ein Fehler ausgelöst. SubResource-

LoadBalancerConfiguration

Name Beschreibung Wert
id Ressourcen-ID Schnur
Name Der Name des Lastenausgleichsmoduls Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften der Konfiguration des Lastenausgleichs. LoadBalancerConfigurationProperties (erforderlich)

LoadBalancerConfigurationProperties

Name Beschreibung Wert
frontendIpConfigurations Gibt die Front-End-IP an, die für das Lastenausgleichsmodul verwendet werden soll. Nur IPv4-Frontend-IP-Adresse wird unterstützt. Jede Konfiguration des Lastenausgleichs muss genau eine Front-End-IP-Konfiguration aufweisen. LoadBalancerFrontendIpConfiguration[] (erforderlich)

LoadBalancerFrontendIpConfiguration

Name Beschreibung Wert
Name Der Name der Ressource, die innerhalb des Satzes von Front-End-IP-Konfigurationen eindeutig ist, die vom Lastenausgleichsmodul verwendet werden. Dieser Name kann für den Zugriff auf die Ressource verwendet werden. Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften der Front-End-Ip-Konfiguration des Lastenausgleichs. LoadBalancerFrontendIpConfigurationProperties (erforderlich)

LoadBalancerFrontendIpConfigurationProperties

Name Beschreibung Wert
privateIPAddress Die private IP-Adresse des virtuellen Netzwerks der IP-Konfiguration. Schnur
publicIPAddress Der Verweis auf die Öffentliche IP-Adressressource. SubResource-
Subnetz Der Verweis auf die Subnetzressource des virtuellen Netzwerks. SubResource-

CloudServiceOsProfile

Name Beschreibung Wert
Geheimnisse Gibt einen Satz von Zertifikaten an, die in den Rolleninstanzen installiert werden sollen. CloudServiceVaultSecretGroup[]

CloudServiceVaultSecretGroup

Name Beschreibung Wert
sourceVault Die relative URL des Key Vault mit allen Zertifikaten in VaultCertificates. SubResource-
vaultCertificates Die Liste der Schlüsseltresorverweise in SourceVault, die Zertifikate enthalten. CloudServiceVaultCertificate[]

CloudServiceVaultCertificate

Name Beschreibung Wert
certificateUrl Dies ist die URL eines Zertifikats, das als geheimer Schlüssel in den Key Vault hochgeladen wurde. Schnur

CloudServiceRoleProfile

Name Beschreibung Wert
Rollen Liste der Rollen für den Clouddienst. CloudServiceRoleProfileProperties[]

CloudServiceRoleProfileProperties

Name Beschreibung Wert
Name Ressourcenname. Schnur
Sku Beschreibt die Clouddienstrollensku. CloudServiceRoleSku-

CloudServiceRoleSku

Name Beschreibung Wert
Fassungsvermögen Gibt die Anzahl der Rolleninstanzen im Clouddienst an. Int
Name Der Sku-Name. HINWEIS: Wenn die neue SKU auf der Hardware, auf der der Clouddienst derzeit installiert ist, nicht unterstützt wird, müssen Sie den Clouddienst löschen und neu erstellen oder zur alten SKU zurückkehren. Schnur
Rang Gibt die Ebene des Clouddiensts an. Mögliche Werte sind

Standard-

Basic-
Schnur

SystemData

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.