Cloud Services - Get

Referenz

Dienst:: Compute

API-Version:: 2024-11-04

Anzeigen von Informationen zu einem Clouddienst.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}?api-version=2024-11-04

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
cloudServiceName	path	True	string	Name des Clouddiensts.
resourceGroupName	path	True	string	Name der Ressourcengruppe.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	CloudService	OKAY
Other Status Codes	CloudError	Fehler

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get Cloud Service with Multiple Roles and RDP Extension

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}?api-version=2024-11-04

Beispiel für eine Antwort

Statuscode:: 200

{
  "name": "{cs-name}",
  "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
  "type": "Microsoft.Compute/cloudServices",
  "location": "eastus2euap",
  "properties": {
    "configuration": "{ServiceConfiguration}",
    "upgradeMode": "Auto",
    "roleProfile": {
      "roles": [
        {
          "name": "ContosoFrontend",
          "sku": {
            "name": "Standard_D1_v2",
            "tier": "Standard",
            "capacity": 2
          }
        },
        {
          "name": "ContosoBackend",
          "sku": {
            "name": "Standard_D1_v2",
            "tier": "Standard",
            "capacity": 2
          }
        }
      ]
    },
    "osProfile": {
      "secrets": []
    },
    "networkProfile": {
      "loadBalancerConfigurations": [
        {
          "name": "contosolb",
          "properties": {
            "frontendIpConfigurations": [
              {
                "name": "contosofe",
                "properties": {
                  "publicIPAddress": {
                    "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
                  }
                }
              }
            ]
          }
        }
      ]
    },
    "extensionProfile": {
      "extensions": [
        {
          "name": "RDPExtension",
          "properties": {
            "autoUpgradeMinorVersion": false,
            "provisioningState": "Succeeded",
            "rolesAppliedTo": [
              "*"
            ],
            "publisher": "Microsoft.Windows.Azure.Extensions",
            "type": "RDP",
            "typeHandlerVersion": "1.2",
            "settings": "<PublicConfig><UserName>userazure</UserName><Expiration>01/12/2022 16:29:02</Expiration></PublicConfig>"
          }
        }
      ]
    },
    "provisioningState": "Succeeded",
    "uniqueId": "4ccb4323-4740-4545-bb81-780b27375947"
  },
  "systemData": {
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedAt": "2020-01-01T17:18:19.1234567Z"
  }
}

Definitionen

Name	Beschreibung
ApiError	API-Fehler.
ApiErrorBase	API-Fehlerbasis.
CloudError	Eine Fehlerantwort des Computediensts.
CloudService	Beschreibt den Clouddienst.
CloudServiceExtensionProfile	Beschreibt ein Clouddiensterweiterungsprofil.
CloudServiceExtensionProperties	Erweiterungseigenschaften.
CloudServiceNetworkProfile	Netzwerkprofil für den Clouddienst.
CloudServiceOsProfile	Beschreibt das Betriebssystemprofil für den Clouddienst.
CloudServiceProperties	Clouddiensteigenschaften
CloudServiceRoleProfile	Beschreibt das Rollenprofil für den Clouddienst.
CloudServiceRoleProfileProperties	Beschreibt die Rolleneigenschaften.
CloudServiceRoleSku	Beschreibt die Clouddienstrollensku.
CloudServiceSlotType	Slottyp für den Clouddienst. Mögliche Werte sind Produktions- Staging- Wenn nicht angegeben, lautet der Standardwert "Production".
CloudServiceUpgradeMode	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.
CloudServiceVaultAndSecretReference	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.
CloudServiceVaultCertificate	Beschreibt einen einzelnen Zertifikatverweis in einem Key Vault und wo sich das Zertifikat in der Rolleninstanz befinden soll.
CloudServiceVaultSecretGroup	Beschreibt eine Gruppe von Zertifikaten, die sich alle im selben Key Vault befinden.
Extension	Beschreibt eine Clouddiensterweiterung.
InnerError	Innere Fehlerdetails.
LoadBalancerConfiguration	Beschreibt die Konfiguration des Lastenausgleichs.
LoadBalancerConfigurationProperties	Beschreibt die Eigenschaften der Konfiguration des Lastenausgleichs.
LoadBalancerFrontendIpConfiguration	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.
LoadBalancerFrontendIpConfigurationProperties	Beschreibt eine IP-Konfiguration des Clouddiensts
SubResource
SystemData	Die Systemmetadaten, die sich auf diese Ressource beziehen.

ApiError

API-Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	ApiErrorBase[]	Die API-Fehlerdetails
innererror	InnerError	Interner API-Fehler
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

ApiErrorBase

API-Fehlerbasis.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

CloudError

Eine Fehlerantwort des Computediensts.

Name	Typ	Beschreibung
error	ApiError	API-Fehler.

CloudService

Beschreibt den Clouddienst.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
location	string	Ressourcenspeicherort.
name	string	Ressourcenname.
properties	CloudServiceProperties	Clouddiensteigenschaften
systemData	SystemData	Die Systemmetadaten, die sich auf diese Ressource beziehen.
tags	object	Ressourcentags.
type	string	Ressourcentyp.
zones	string[]	Liste der logischen Verfügbarkeitszone der Ressource. Die Liste sollte nur eine Zone enthalten, in der Clouddienst bereitgestellt werden soll. Dieses Feld ist optional.

CloudServiceExtensionProfile

Beschreibt ein Clouddiensterweiterungsprofil.

Name	Typ	Beschreibung
extensions	Extension[]	Liste der Erweiterungen für den Clouddienst.

CloudServiceExtensionProperties

Erweiterungseigenschaften.

Name	Typ	Beschreibung
autoUpgradeMinorVersion	boolean	Geben Sie explizit an, ob die Plattform typeHandlerVersion automatisch auf höhere Nebenversionen aktualisieren kann, wenn sie verfügbar sind.
forceUpdateTag	string	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 an die Rolleninstanz mit derselben Sequenznummer fließen, und es liegt bei der Handlerimplementierung, ob sie erneut ausgeführt werden soll oder nicht.
protectedSettings	object	Geschützte Einstellungen für die Erweiterung, die vor dem Senden an die Rolleninstanz verschlüsselt werden.
protectedSettingsFromKeyVault	CloudServiceVaultAndSecretReference	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.
provisioningState	string	Der Bereitstellungsstatus, der nur in der Antwort angezeigt wird.
publisher	string	Der Name des Herausgebers des Erweiterungshandlers.
rolesAppliedTo	string[]	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.
settings	object	Ö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.
type	string	Gibt den Typ der Erweiterung an.
typeHandlerVersion	string	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.

CloudServiceNetworkProfile

Netzwerkprofil für den Clouddienst.

Name	Typ	Beschreibung
loadBalancerConfigurations	LoadBalancerConfiguration[]	Liste der Konfigurationen des Lastenausgleichs. Der Clouddienst kann bis zu zwei Lastenausgleichskonfigurationen aufweisen, die einem öffentlichen Lastenausgleichsmodul und einem internen Lastenausgleichsmodul entsprechen.
slotType	CloudServiceSlotType	Slottyp für den Clouddienst. Mögliche Werte sind Produktions- Staging- Wenn nicht angegeben, lautet der Standardwert "Production".
swappableCloudService	SubResource	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.

CloudServiceOsProfile

Beschreibt das Betriebssystemprofil für den Clouddienst.

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

CloudServiceProperties

Clouddiensteigenschaften

Name	Typ	Beschreibung
allowModelOverride	boolean	(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`.
configuration	string	Gibt die XML-Dienstkonfiguration (.cscfg) für den Clouddienst an.
configurationUrl	string	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.
extensionProfile	CloudServiceExtensionProfile	Beschreibt ein Clouddiensterweiterungsprofil.
networkProfile	CloudServiceNetworkProfile	Netzwerkprofil für den Clouddienst.
osProfile	CloudServiceOsProfile	Beschreibt das Betriebssystemprofil für den Clouddienst.
packageUrl	string	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.
provisioningState	string	Der Bereitstellungsstatus, der nur in der Antwort angezeigt wird.
roleProfile	CloudServiceRoleProfile	Beschreibt das Rollenprofil für den Clouddienst.
startCloudService	boolean	(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.
uniqueId	string	Der eindeutige Bezeichner für den Clouddienst.
upgradeMode	CloudServiceUpgradeMode	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.

CloudServiceRoleProfile

Beschreibt das Rollenprofil für den Clouddienst.

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

CloudServiceRoleProfileProperties

Beschreibt die Rolleneigenschaften.

Name	Typ	Beschreibung
name	string	Ressourcenname.
sku	CloudServiceRoleSku	Beschreibt die Clouddienstrollensku.

CloudServiceRoleSku

Beschreibt die Clouddienstrollensku.

Name	Typ	Beschreibung
capacity	integer	Gibt die Anzahl der Rolleninstanzen im Clouddienst an.
name	string	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.
tier	string	Gibt die Ebene des Clouddiensts an. Mögliche Werte sind Standard- Basic-

CloudServiceSlotType

Slottyp für den Clouddienst. Mögliche Werte sind

Produktions-

Staging-

Wenn nicht angegeben, lautet der Standardwert "Production".

Name	Typ	Beschreibung
Production	string
Staging	string

CloudServiceUpgradeMode

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.

Name	Typ	Beschreibung
Auto	string
Manual	string
Simultaneous	string

CloudServiceVaultAndSecretReference

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.

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

CloudServiceVaultCertificate

Beschreibt einen einzelnen Zertifikatverweis in einem Key Vault und wo sich das Zertifikat in der Rolleninstanz befinden soll.

Name	Typ	Beschreibung
certificateUrl	string	Dies ist die URL eines Zertifikats, das als geheimer Schlüssel in den Key Vault hochgeladen wurde.
isBootstrapCertificate	boolean	Flag, das angibt, ob das bereitgestellte Zertifikat ein Bootstrap-Zertifikat ist, das von der Key Vault-Erweiterung zum Abrufen der verbleibenden Zertifikate verwendet werden soll.

CloudServiceVaultSecretGroup

Beschreibt eine Gruppe von Zertifikaten, die sich alle im selben Key Vault befinden.

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

Extension

Beschreibt eine Clouddiensterweiterung.

Name	Typ	Beschreibung
name	string	Der Name der Erweiterung.
properties	CloudServiceExtensionProperties	Erweiterungseigenschaften.

InnerError

Innere Fehlerdetails.

Name	Typ	Beschreibung
errordetail	string	Die interne Fehlermeldung oder das Ausnahmeabbild.
exceptiontype	string	Der Ausnahmetyp.

LoadBalancerConfiguration

Beschreibt die Konfiguration des Lastenausgleichs.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Der Name des Lastenausgleichsmoduls
properties	LoadBalancerConfigurationProperties	Eigenschaften der Konfiguration des Lastenausgleichs.

LoadBalancerConfigurationProperties

Beschreibt die Eigenschaften der Konfiguration des Lastenausgleichs.

Name	Typ	Beschreibung
frontendIpConfigurations	LoadBalancerFrontendIpConfiguration[]	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

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.

Name	Typ	Beschreibung
name	string	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.
properties	LoadBalancerFrontendIpConfigurationProperties	Eigenschaften der Front-End-Ip-Konfiguration des Lastenausgleichs.

LoadBalancerFrontendIpConfigurationProperties

Beschreibt eine IP-Konfiguration des Clouddiensts

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

SubResource

Name	Typ	Beschreibung
id	string	Ressourcen-ID

SystemData

Die Systemmetadaten, die sich auf diese Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Gibt die Zeit in UTC an, zu der die Clouddienstressource (erweiterte Unterstützung) erstellt wurde. Mindest-API-Version: 2022-04-04.
lastModifiedAt	string	Gibt die Uhrzeit in UTC an, zu der die Ressource für den Clouddienst (erweiterter Support) zuletzt geändert wurde. Mindest-API-Version: 2022-04-04.

Freigeben über