Freigeben über


Microsoft.Compute cloudServices 2021-03-01

Bicep-Ressourcendefinition

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

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

Ressourcenformat

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

resource symbolicname 'Microsoft.Compute/cloudServices@2021-03-01' = {
  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: 'string'
            protectedSettingsFromKeyVault: {
              secretUrl: 'string'
              sourceVault: {
                id: 'string'
              }
            }
            publisher: 'string'
            rolesAppliedTo: [
              'string'
            ]
            settings: 'string'
            type: 'string'
            typeHandlerVersion: 'string'
          }
        }
      ]
    }
    networkProfile: {
      loadBalancerConfigurations: [
        {
          id: 'string'
          name: 'string'
          properties: {
            frontendIPConfigurations: [
              {
                name: 'string'
                properties: {
                  privateIPAddress: 'string'
                  publicIPAddress: {
                    id: 'string'
                  }
                  subnet: {
                    id: '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'
  }
}

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:
~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ?

Darf nicht mit einem Unterstrich beginnen. Darf nicht mit einem Punkt oder Bindestrich enden.
location Ressourcenspeicherort Zeichenfolge (erforderlich)
tags Ressourcentags. Wörterbuch der Tagnamen und -werte. Weitere Informationen finden Sie unter Tags in Vorlagen.
properties Clouddiensteigenschaften CloudServiceProperties

CloudServiceProperties

Name Beschreibung Wert
allowModelOverride (Optional) Gibt an, ob die im Modell/der Vorlage angegebenen Rollen-SKU-Eigenschaften (roleProfile.roles.sku) die Rolle instance Anzahl und VM-Größe überschreiben sollen, die in CSCFG bzw. CSDEF angegeben sind.
Standardwert: false.
bool
Konfiguration Gibt die XML-Dienstkonfiguration (.cscfg) für den Clouddienst an. Zeichenfolge
configurationUrl Gibt eine URL an, die sich auf den Speicherort der Dienstkonfiguration im Blobdienst bezieht. Die Dienstpaket-URL kann ein SAS-URI (Shared Access Signature) eines beliebigen Speicherkontos sein.
Dies ist eine schreibgeschützte Eigenschaft, die in GET-Aufrufen nicht zurückgegeben wird.
Zeichenfolge
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 ein SAS-URI (Shared Access Signature) eines beliebigen Speicherkontos sein.
Dies ist eine schreibgeschützte Eigenschaft, die in GET-Aufrufen nicht zurückgegeben wird.
Zeichenfolge
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, aber der Code wird nicht sofort ausgeführt. Stattdessen wird der Dienst so lange poweredOff ausgeführt, bis Sie Start aufrufen. Zu diesem Zeitpunkt wird der Dienst gestartet. Für einen bereitgestellten Dienst fallen weiterhin Gebühren an, auch wenn er ausgeschaltet wird.
bool
upgradeMode Updatemodus für den Clouddienst. Rolleninstanzen werden den Aktualisierungsdomänen zugeordnet, wenn der Dienst bereitgestellt wird. Updates können in jeder Aktualisierungsdomäne manuell initiiert oder in allen Updatedomänen automatisch initiiert werden.
Mögliche Werte sind:

Automatisch

Manuell

Gleichzeitige


Wenn nicht angegeben, lautet der Standardwert Auto. Wenn diese Einstellung auf Manuell festgelegt ist, muss PUT UpdateDomain aufgerufen werden, um das Update anzuwenden. Bei Festlegung auf Auto wird das Update automatisch nacheinander auf jede Updatedomäne 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. Zeichenfolge
properties Erweiterungseigenschaften. CloudServiceExtensionProperties

CloudServiceExtensionProperties

Name Beschreibung Wert
autoUpgradeMinorVersion Geben Sie explizit an, ob die Plattform typeHandlerVersion automatisch auf höhere Nebenversionen aktualisieren kann, sobald diese verfügbar werden. bool
forceUpdateTag Tag, um die Anwendung der bereitgestellten öffentlichen und geschützten Einstellungen zu erzwingen.
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 öffentliche oder geschützte Einstellungen ändern, würde die Erweiterung an die Rolle instance mit derselben Sequenznummer und
Es liegt an der Handlerimplementierung, ob sie erneut ausgeführt werden soll oder nicht
Zeichenfolge
protectedSettings Geschützte Einstellungen für die Erweiterung, die verschlüsselt werden, bevor sie an die Rolle instance gesendet werden. Zeichenfolge
protectedSettingsFromKeyVault CloudServiceVaultAndSecretReference
publisher Der Name des Erweiterungshandlerherausgebers. Zeichenfolge
rolesAppliedTo Optionale Liste der Rollen zum Anwenden dieser Erweiterung. Wenn die Eigenschaft nicht oder "*" angegeben ist, wird die Erweiterung auf alle Rollen im Clouddienst angewendet. string[]
settings Öffentliche Einstellungen für die Erweiterung. Für JSON-Erweiterungen sind dies die JSON-Einstellungen für die Erweiterung. Für die XML-Erweiterung (wie RDP) ist dies die XML-Einstellung für die Erweiterung. Zeichenfolge
type Gibt den Typ der Erweiterung an. Zeichenfolge
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 (X.Y) angegeben werden, wird die spezifische Erweiterungsversion ausgewählt. Wenn eine Version angegeben wird, wird ein automatisches Upgrade für die Rolleninstanz durchgeführt. Zeichenfolge

CloudServiceVaultAndSecretReference

Name Beschreibung Wert
secretUrl Zeichenfolge
sourceVault Subresource

Subresource

Name Beschreibung Wert
id Ressourcen-ID Zeichenfolge

CloudServiceNetworkProfile

Name Beschreibung Wert
loadBalancerConfigurations Liste der Load Balancer-Konfigurationen. Der Clouddienst kann über bis zu zwei Lastenausgleichskonfigurationen verfügen, die einem öffentlichen Load Balancer und einem internen Load Balancer entsprechen. LoadBalancerConfiguration[]
swappableCloudService Der ID-Verweis des Clouddiensts, der die Ziel-IP-Adresse enthält, mit der der antragstellerbasierte Clouddienst einen Austausch durchführen kann. Diese Eigenschaft kann nach dem Festlegen nicht mehr aktualisiert werden. 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 Zeichenfolge
name Der Name des Lastenausgleichs Zeichenfolge (erforderlich)
properties Eigenschaften der Load Balancer-Konfiguration. LoadBalancerConfigurationProperties (erforderlich)

LoadBalancerConfigurationProperties

Name Beschreibung Wert
frontendIPConfigurations Gibt die Front-End-IP an, die für den Lastenausgleich verwendet werden soll. Es wird nur die IPv4-Front-End-IP-Adresse unterstützt. Jede Load Balancer-Konfiguration muss genau eine Front-End-IP-Konfiguration aufweisen. LoadBalancerFrontendIPConfiguration[] (erforderlich)

LoadBalancerFrontendIPConfiguration

Name Beschreibung Wert
name Der Name der Ressource, die innerhalb der Vom Lastenausgleich verwendeten Front-End-IP-Konfigurationen eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden. Zeichenfolge (erforderlich)
properties 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. Zeichenfolge
publicIPAddress Der Verweis auf die öffentliche IP-Adressressource. Subresource
Subnetz Der Verweis auf die Subnetzressource des virtuellen Netzwerks. Subresource

CloudServiceOsProfile

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

CloudServiceVaultSecretGroup

Name Beschreibung Wert
sourceVault Die relative URL der Key Vault, die alle Zertifikate in VaultCertificates enthält. 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 Geheimnis in Key Vault hochgeladen wurde. Zeichenfolge

CloudServiceRoleProfile

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

CloudServiceRoleProfileProperties

Name Beschreibung Wert
name Name der Ressource. Zeichenfolge
sku Beschreibt die SKU der Clouddienstrolle. CloudServiceRoleSku

CloudServiceRoleSku

Name Beschreibung Wert
Kapazität Gibt die Anzahl der Rolleninstanzen im Clouddienst an. INT
name Der SKU-Name. HINWEIS: Wenn die neue SKU auf der Hardware, auf der sich der Clouddienst derzeit befindet, nicht unterstützt wird, müssen Sie den Clouddienst löschen und neu erstellen oder zur alten SKU zurückkehren. Zeichenfolge
Ebene Gibt die Ebene des Clouddiensts an. Mögliche Werte sind:

Standard

Grundlegend
Zeichenfolge

Ressourcendefinition mit einer ARM-Vorlage

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

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

Ressourcenformat

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

{
  "type": "Microsoft.Compute/cloudServices",
  "apiVersion": "2021-03-01",
  "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": "string",
            "protectedSettingsFromKeyVault": {
              "secretUrl": "string",
              "sourceVault": {
                "id": "string"
              }
            },
            "publisher": "string",
            "rolesAppliedTo": [ "string" ],
            "settings": "string",
            "type": "string",
            "typeHandlerVersion": "string"
          }
        }
      ]
    },
    "networkProfile": {
      "loadBalancerConfigurations": [
        {
          "id": "string",
          "name": "string",
          "properties": {
            "frontendIPConfigurations": [
              {
                "name": "string",
                "properties": {
                  "privateIPAddress": "string",
                  "publicIPAddress": {
                    "id": "string"
                  },
                  "subnet": {
                    "id": "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"
  }
}

Eigenschaftswerte

cloudServices

Name Beschreibung Wert
type Der Ressourcentyp "Microsoft.Compute/cloudServices"
apiVersion Die Version der Ressourcen-API '2021-03-01'
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 1-15



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

Darf nicht mit einem Unterstrich beginnen. Darf nicht mit einem Punkt oder Bindestrich enden.
location Ressourcenspeicherort Zeichenfolge (erforderlich)
tags Ressourcentags. Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
properties Clouddiensteigenschaften CloudServiceProperties

CloudServiceProperties

Name Beschreibung Wert
allowModelOverride (Optional) Gibt an, ob die im Modell/der Vorlage angegebenen Rollenskueigenschaften (roleProfile.roles.sku) die Rolle instance Anzahl und VM-Größe überschreiben sollen, die in CSCFG bzw. CSDEF angegeben sind.
Standardwert: false.
bool
Konfiguration Gibt die XML-Dienstkonfiguration (.cscfg) für den Clouddienst an. Zeichenfolge
configurationUrl Gibt eine URL an, die auf den Speicherort der Dienstkonfiguration im Blobdienst verweist. Die Dienstpaket-URL kann SAS-URI (Shared Access Signature) aus einem beliebigen Speicherkonto sein.
Dies ist eine schreibgeschützte Eigenschaft und wird in GET-Aufrufen nicht zurückgegeben.
Zeichenfolge
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 SAS-URI (Shared Access Signature) aus einem beliebigen Speicherkonto sein.
Dies ist eine schreibgeschützte Eigenschaft und wird in GET-Aufrufen nicht zurückgegeben.
Zeichenfolge
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, aber der Code wird nicht sofort ausgeführt. Stattdessen ist der Dienst PoweredOff, bis Sie Start aufrufen, und zu diesem Zeitpunkt wird der Dienst gestartet. Für einen bereitgestellten Dienst fallen weiterhin Gebühren an, auch wenn er ausgeschaltet wird.
bool
upgradeMode Updatemodus für den Clouddienst. Rolleninstanzen werden den Aktualisierungsdomänen zugeordnet, wenn der Dienst bereitgestellt wird. Updates können in jeder Aktualisierungsdomäne manuell initiiert oder in allen Updatedomänen automatisch initiiert werden.
Mögliche Werte sind

Automatisch

Manuell

Gleichzeitige


Wenn nicht angegeben, lautet der Standardwert Auto. Wenn auf Manuell festgelegt ist, muss PUT UpdateDomain aufgerufen werden, um das Update anzuwenden. Wenn sie auf Auto festgelegt ist, wird das Update automatisch nacheinander auf jede Updatedomäne 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. Zeichenfolge
properties 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 werden. bool
forceUpdateTag Tag, um das Anwenden der bereitgestellten öffentlichen und geschützten Einstellungen zu erzwingen.
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 auf öffentliche oder geschützte Einstellungen weiterhin vom Handler angewendet.
Wenn sich weder forceUpdateTag noch eine der öffentlichen oder geschützten Einstellungen ändern, würde die Erweiterung an die Rolle instance mit derselben Sequenznummer und
Es liegt an der Handlerimplementierung, ob sie erneut ausgeführt werden soll oder nicht
Zeichenfolge
protectedSettings Geschützte Einstellungen für die Erweiterung, die verschlüsselt werden, bevor sie an die Rolle instance gesendet werden. Zeichenfolge
protectedSettingsFromKeyVault CloudServiceVaultAndSecretReference
publisher Der Name des Erweiterungshandlerherausgebers. Zeichenfolge
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[]
settings Öffentliche Einstellungen für die Erweiterung. Bei JSON-Erweiterungen sind dies die JSON-Einstellungen für die Erweiterung. Für die XML-Erweiterung (z. B. RDP) ist dies die XML-Einstellung für die Erweiterung. Zeichenfolge
type Gibt den Typ der Erweiterung an. Zeichenfolge
typeHandlerVersion Gibt die Version der Erweiterung an. Gibt die Version der Erweiterung an. Wenn dieses Element nicht angegeben 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 (X.Y) angegeben werden, wird die spezifische Erweiterungsversion ausgewählt. Wenn eine Version angegeben wird, wird ein automatisches Upgrade für die Rolleninstanz durchgeführt. Zeichenfolge

CloudServiceVaultAndSecretReference

Name Beschreibung Wert
secretUrl Zeichenfolge
sourceVault Subresource

Subresource

Name Beschreibung Wert
id Ressourcen-ID Zeichenfolge

CloudServiceNetworkProfile

Name Beschreibung Wert
loadBalancerConfigurations Liste der Lastenausgleichskonfigurationen. Der Clouddienst kann über bis zu zwei Lastenausgleichskonfigurationen verfügen, die einem öffentlichen Load Balancer und einem internen Load Balancer entsprechen. LoadBalancerConfiguration[]
swappableCloudService Der ID-Verweis des Clouddiensts, der die Ziel-IP-Adresse enthält, mit der der betroffene Clouddienst einen Austausch durchführen kann. Diese Eigenschaft kann nicht aktualisiert werden, sobald sie festgelegt ist. 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 Zeichenfolge
name Der Name des Lastenausgleichs Zeichenfolge (erforderlich)
properties Eigenschaften der Lastenausgleichskonfiguration. LoadBalancerConfigurationProperties (erforderlich)

LoadBalancerConfigurationProperties

Name Beschreibung Wert
frontendIPConfigurations Gibt die Front-End-IP an, die für den Lastenausgleich verwendet werden soll. Es wird nur die IPv4-Front-End-IP-Adresse unterstützt. Jede Lastenausgleichskonfiguration muss genau eine Front-End-IP-Konfiguration aufweisen. LoadBalancerFrontendIPConfiguration[] (erforderlich)

LoadBalancerFrontendIPConfiguration

Name Beschreibung Wert
name Der Name der Ressource, der innerhalb der Vom Lastenausgleich verwendeten Front-End-IP-Konfigurationen eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden. Zeichenfolge (erforderlich)
properties 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. Zeichenfolge
publicIPAddress Der Verweis auf die öffentliche IP-Adressressource. Subresource
Subnetz Der Verweis auf die Subnetzressource des virtuellen Netzwerks. Subresource

CloudServiceOsProfile

Name Beschreibung Wert
secrets Gibt eine Gruppe von Zertifikaten an, die in den Rolleninstanzen installiert werden sollen. CloudServiceVaultSecretGroup[]

CloudServiceVaultSecretGroup

Name Beschreibung Wert
sourceVault Die relative URL der Key Vault, die alle Zertifikate in VaultCertificates enthält. 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 Geheimnis in Key Vault hochgeladen wurde. Zeichenfolge

CloudServiceRoleProfile

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

CloudServiceRoleProfileProperties

Name Beschreibung Wert
name Name der Ressource. Zeichenfolge
sku Beschreibt die Clouddienstrollensku. CloudServiceRoleSku

CloudServiceRoleSku

Name Beschreibung Wert
Kapazität Gibt die Anzahl der Rolleninstanzen im Clouddienst an. INT
name Der sku-Name. HINWEIS: Wenn die neue SKU auf der Hardware, auf der sich der Clouddienst derzeit befindet, nicht unterstützt wird, müssen Sie den Clouddienst löschen und neu erstellen oder zur alten SKU zurückkehren. Zeichenfolge
Ebene Gibt die Ebene des Clouddiensts an. Mögliche Werte sind

Standard

Grundlegend
Zeichenfolge

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der cloudServices-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

  • 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 Der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/cloudServices@2021-03-01"
  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"
              protectedSettings = "string"
              protectedSettingsFromKeyVault = {
                secretUrl = "string"
                sourceVault = {
                  id = "string"
                }
              }
              publisher = "string"
              rolesAppliedTo = [
                "string"
              ]
              settings = "string"
              type = "string"
              typeHandlerVersion = "string"
            }
          }
        ]
      }
      networkProfile = {
        loadBalancerConfigurations = [
          {
            id = "string"
            name = "string"
            properties = {
              frontendIPConfigurations = [
                {
                  name = "string"
                  properties = {
                    privateIPAddress = "string"
                    publicIPAddress = {
                      id = "string"
                    }
                    subnet = {
                      id = "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"
    }
  })
}

Eigenschaftswerte

cloudServices

Name Beschreibung Wert
type Ressourcentyp "Microsoft.Compute/cloudServices@2021-03-01"
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 1-15



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

Darf nicht mit einem Unterstrich beginnen. Darf nicht mit einem Punkt oder Bindestrich enden.
location Ressourcenspeicherort Zeichenfolge (erforderlich)
parent_id Verwenden Sie zum Bereitstellen in einer Ressourcengruppe die ID dieser Ressourcengruppe. Zeichenfolge (erforderlich)
tags Ressourcentags. Wörterbuch der Tagnamen und -werte.
properties Clouddiensteigenschaften CloudServiceProperties

CloudServiceProperties

Name Beschreibung Wert
allowModelOverride (Optional) Gibt an, ob die im Modell/der Vorlage angegebenen Rollenskueigenschaften (roleProfile.roles.sku) die Rolle instance Anzahl und VM-Größe überschreiben sollen, die in CSCFG bzw. CSDEF angegeben sind.
Standardwert: false.
bool
Konfiguration Gibt die XML-Dienstkonfiguration (.cscfg) für den Clouddienst an. Zeichenfolge
configurationUrl Gibt eine URL an, die auf den Speicherort der Dienstkonfiguration im Blobdienst verweist. Die Dienstpaket-URL kann SAS-URI (Shared Access Signature) aus einem beliebigen Speicherkonto sein.
Dies ist eine schreibgeschützte Eigenschaft und wird in GET-Aufrufen nicht zurückgegeben.
Zeichenfolge
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 SAS-URI (Shared Access Signature) aus einem beliebigen Speicherkonto sein.
Dies ist eine schreibgeschützte Eigenschaft und wird in GET-Aufrufen nicht zurückgegeben.
Zeichenfolge
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, aber der Code wird nicht sofort ausgeführt. Stattdessen ist der Dienst PoweredOff, bis Sie Start aufrufen, und zu diesem Zeitpunkt wird der Dienst gestartet. Für einen bereitgestellten Dienst fallen weiterhin Gebühren an, auch wenn er ausgeschaltet wird.
bool
upgradeMode Updatemodus für den Clouddienst. Rolleninstanzen werden den Aktualisierungsdomänen zugeordnet, wenn der Dienst bereitgestellt wird. Updates können in jeder Aktualisierungsdomäne manuell initiiert oder in allen Updatedomänen automatisch initiiert werden.
Mögliche Werte sind

Automatisch

Manuell

Gleichzeitige


Wenn nicht angegeben, lautet der Standardwert Auto. Wenn auf Manuell festgelegt ist, muss PUT UpdateDomain aufgerufen werden, um das Update anzuwenden. Wenn sie auf Auto festgelegt ist, wird das Update automatisch nacheinander auf jede Updatedomäne 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. Zeichenfolge
properties 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 werden. bool
forceUpdateTag Tag, um das Anwenden der bereitgestellten öffentlichen und geschützten Einstellungen zu erzwingen.
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 auf öffentliche oder geschützte Einstellungen weiterhin vom Handler angewendet.
Wenn sich weder forceUpdateTag noch eine der öffentlichen oder geschützten Einstellungen ändern, würde die Erweiterung an die Rolle instance mit derselben Sequenznummer und
Es liegt an der Handlerimplementierung, ob sie erneut ausgeführt werden soll oder nicht
Zeichenfolge
protectedSettings Geschützte Einstellungen für die Erweiterung, die verschlüsselt werden, bevor sie an die Rolle instance gesendet werden. Zeichenfolge
protectedSettingsFromKeyVault CloudServiceVaultAndSecretReference
publisher Der Name des Erweiterungshandlerherausgebers. Zeichenfolge
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[]
settings Öffentliche Einstellungen für die Erweiterung. Bei JSON-Erweiterungen sind dies die JSON-Einstellungen für die Erweiterung. Für die XML-Erweiterung (z. B. RDP) ist dies die XML-Einstellung für die Erweiterung. Zeichenfolge
type Gibt den Typ der Erweiterung an. Zeichenfolge
typeHandlerVersion Gibt die Version der Erweiterung an. Gibt die Version der Erweiterung an. Wenn dieses Element nicht angegeben 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 (X.Y) angegeben werden, wird die spezifische Erweiterungsversion ausgewählt. Wenn eine Version angegeben wird, wird ein automatisches Upgrade für die Rolleninstanz durchgeführt. Zeichenfolge

CloudServiceVaultAndSecretReference

Name Beschreibung Wert
secretUrl Zeichenfolge
sourceVault Subresource

Subresource

Name Beschreibung Wert
id Ressourcen-ID Zeichenfolge

CloudServiceNetworkProfile

Name Beschreibung Wert
loadBalancerConfigurations Liste der Lastenausgleichskonfigurationen. Der Clouddienst kann über bis zu zwei Lastenausgleichskonfigurationen verfügen, die einem öffentlichen Load Balancer und einem internen Load Balancer entsprechen. LoadBalancerConfiguration[]
swappableCloudService Der ID-Verweis des Clouddiensts, der die Ziel-IP-Adresse enthält, mit der der betroffene Clouddienst einen Austausch durchführen kann. Diese Eigenschaft kann nicht aktualisiert werden, sobald sie festgelegt ist. 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 Zeichenfolge
name Der Name des Lastenausgleichs Zeichenfolge (erforderlich)
properties Eigenschaften der Lastenausgleichskonfiguration. LoadBalancerConfigurationProperties (erforderlich)

LoadBalancerConfigurationProperties

Name Beschreibung Wert
frontendIPConfigurations Gibt die Front-End-IP an, die für den Lastenausgleich verwendet werden soll. Es wird nur die IPv4-Front-End-IP-Adresse unterstützt. Jede Lastenausgleichskonfiguration muss genau eine Front-End-IP-Konfiguration aufweisen. LoadBalancerFrontendIPConfiguration[] (erforderlich)

LoadBalancerFrontendIPConfiguration

Name Beschreibung Wert
name Der Name der Ressource, der innerhalb der Vom Lastenausgleich verwendeten Front-End-IP-Konfigurationen eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden. Zeichenfolge (erforderlich)
properties 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. Zeichenfolge
publicIPAddress Der Verweis auf die öffentliche IP-Adressressource. Subresource
Subnetz Der Verweis auf die Subnetzressource des virtuellen Netzwerks. Subresource

CloudServiceOsProfile

Name Beschreibung Wert
secrets Gibt eine Gruppe von Zertifikaten an, die in den Rolleninstanzen installiert werden sollen. CloudServiceVaultSecretGroup[]

CloudServiceVaultSecretGroup

Name Beschreibung Wert
sourceVault Die relative URL der Key Vault, die alle Zertifikate in VaultCertificates enthält. 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 Geheimnis in Key Vault hochgeladen wurde. Zeichenfolge

CloudServiceRoleProfile

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

CloudServiceRoleProfileProperties

Name Beschreibung Wert
name Name der Ressource. Zeichenfolge
sku Beschreibt die SKU der Clouddienstrolle. CloudServiceRoleSku

CloudServiceRoleSku

Name Beschreibung Wert
Kapazität Gibt die Anzahl der Rolleninstanzen im Clouddienst an. INT
name Der SKU-Name. HINWEIS: Wenn die neue SKU auf der Hardware, auf der sich der Clouddienst derzeit befindet, nicht unterstützt wird, müssen Sie den Clouddienst löschen und neu erstellen oder zur alten SKU zurückkehren. Zeichenfolge
Ebene Gibt die Ebene des Clouddiensts an. Mögliche Werte sind:

Standard

Grundlegend
Zeichenfolge