Cloud Services - List
Ruft eine Liste aller Clouddienste unter einer Ressourcengruppe ab. Verwenden Sie die nextLink-Eigenschaft in der Antwort, um die nächste Seite von Cloud Services abzurufen. Führen Sie dies aus, bis nextLink null ist, um alle Cloud Services abzurufen.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices?api-version=2022-09-04
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
resource
|
path | True |
string |
Name der Ressourcengruppe |
subscription
|
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 |
OK |
|
Other Status Codes |
Fehler |
Sicherheit
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Annehmen der Identität Ihres Benutzerkontos |
Beispiele
List Cloud Services in a Resource Group
Sample Request
GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices?api-version=2022-09-04
Sample Response
{
"value": [
{
"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"
}
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Api |
API-Fehler. |
Api |
API-Fehlerbasis. |
Cloud |
Eine Fehlerantwort des Computediensts. |
Cloud |
Beschreibt den Clouddienst. |
Cloud |
Beschreibt ein Clouddiensterweiterungsprofil. |
Cloud |
Erweiterungseigenschaften. |
Cloud |
Das Ergebnis des Listenvorgangs. |
Cloud |
Netzwerkprofil für den Clouddienst. |
Cloud |
Beschreibt das Betriebssystemprofil für den Clouddienst. |
Cloud |
Clouddiensteigenschaften |
Cloud |
Beschreibt das Rollenprofil für den Clouddienst. |
Cloud |
Beschreibt die Rolleneigenschaften. |
Cloud |
Beschreibt die Clouddienstrollensku. |
Cloud |
Slottyp für den Clouddienst.
Mögliche Werte: |
Cloud |
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: |
Cloud |
Geschützte Einstellungen für die Erweiterung, auf die mithilfe von KeyVault verwiesen wird, die verschlüsselt werden, bevor sie an die Rolle instance gesendet werden. |
Cloud |
Beschreibt einen einzelnen Zertifikatverweis in einem Key Vault und den Speicherort des Zertifikats für die Rolle instance. |
Cloud |
Beschreibt eine Gruppe von Zertifikaten, die sich alle im gleichen Key Vault befinden. |
Extension |
Beschreibt eine Clouddiensterweiterung. |
Inner |
Details zu inneren Fehlern. |
Load |
Beschreibt die Konfiguration des Lastenausgleichs. |
Load |
Beschreibt die Eigenschaften der Lastenausgleichskonfiguration. |
Load |
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. |
Load |
Beschreibt die IP-Konfiguration eines Clouddiensts |
Sub |
|
System |
Die Systemmetadaten zu dieser Ressource. |
ApiError
API-Fehler.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Der Fehlercode. |
details |
Details zu API-Fehlern |
|
innererror |
Innerer 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 |
API-Fehler. |
CloudService
Beschreibt den Clouddienst.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Ressourcen-ID. |
location |
string |
Ressourcenspeicherort |
name |
string |
Name der Ressource. |
properties |
Clouddiensteigenschaften |
|
systemData |
Die Systemmetadaten zu dieser Ressource. |
|
tags |
object |
Ressourcentags. |
type |
string |
Der Ressourcentyp. |
zones |
string[] |
Liste der logischen Verfügbarkeitszone der Ressource. Die Liste sollte nur eine Zone enthalten, in der der Clouddienst bereitgestellt werden soll. Dieses Feld ist optional. |
CloudServiceExtensionProfile
Beschreibt ein Clouddiensterweiterungsprofil.
Name | Typ | Beschreibung |
---|---|---|
extensions |
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 werden. |
forceUpdateTag |
string |
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 öffentliche oder geschützte Einstellungen ändern, würde die Erweiterung an die Rolle instance 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 verschlüsselt werden, bevor sie an die Rolle instance gesendet werden. |
protectedSettingsFromKeyVault |
Geschützte Einstellungen für die Erweiterung, auf die mithilfe von KeyVault verwiesen wird, die verschlüsselt werden, bevor sie an die Rolle instance gesendet werden. |
|
provisioningState |
string |
Der Bereitstellungsstatus, der nur in der Antwort angezeigt wird. |
publisher |
string |
Der Name des Erweiterungshandlerherausgebers. |
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 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. |
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 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. |
CloudServiceListResult
Das Ergebnis des Listenvorgangs.
Name | Typ | Beschreibung |
---|---|---|
nextLink |
string |
Der URI zum Abrufen der nächsten Ressourcenseite. Verwenden Sie diese Option, um die nächste Seite mit Ressourcen abzurufen. Gehen Sie so vor, bis nextLink null ist, um alle Ressourcen abzurufen. |
value |
Die Liste der Ressourcen. |
CloudServiceNetworkProfile
Netzwerkprofil für den Clouddienst.
Name | Typ | Beschreibung |
---|---|---|
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. |
|
slotType |
Slottyp für den Clouddienst.
Mögliche Werte: |
|
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. |
CloudServiceOsProfile
Beschreibt das Betriebssystemprofil für den Clouddienst.
Name | Typ | Beschreibung |
---|---|---|
secrets |
Gibt einen Satz von Zertifikaten an, die auf den Rolleninstanzen installiert werden sollen. |
CloudServiceProperties
Clouddiensteigenschaften
Name | Typ | Beschreibung |
---|---|---|
allowModelOverride |
boolean |
(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: |
configuration |
string |
Gibt die XML-Dienstkonfiguration (.cscfg) für den Clouddienst an. |
configurationUrl |
string |
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. |
extensionProfile |
Beschreibt ein Clouddiensterweiterungsprofil. |
|
networkProfile |
Netzwerkprofil für den Clouddienst. |
|
osProfile |
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 ein SAS-URI (Shared Access Signature) eines beliebigen Speicherkontos sein. Dies ist eine schreibgeschützte Eigenschaft, die in GET-Aufrufen nicht zurückgegeben wird. |
provisioningState |
string |
Der Bereitstellungsstatus, der nur in der Antwort angezeigt wird. |
roleProfile |
Beschreibt das Rollenprofil für den Clouddienst. |
|
startCloudService |
boolean |
(Optional) Gibt an, ob der Clouddienst unmittelbar nach der Erstellung gestartet werden soll. Standardwert: |
uniqueId |
string |
Der eindeutige Bezeichner für den Clouddienst. |
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: |
CloudServiceRoleProfile
Beschreibt das Rollenprofil für den Clouddienst.
Name | Typ | Beschreibung |
---|---|---|
roles |
Liste der Rollen für den Clouddienst. |
CloudServiceRoleProfileProperties
Beschreibt die Rolleneigenschaften.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Name der Ressource. |
sku |
Beschreibt die SKU der Clouddienstrolle. |
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 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. |
tier |
string |
Gibt die Ebene des Clouddiensts an. Mögliche Werte sind |
CloudServiceSlotType
Slottyp für den Clouddienst.
Mögliche Werte:
Produktion
Staging
Falls nicht angegeben, lautet der Standardwert Production.
Name | Typ | Beschreibung |
---|---|---|
Production |
string |
|
Staging |
string |
CloudServiceUpgradeMode
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.
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 Rolle instance gesendet werden.
Name | Typ | Beschreibung |
---|---|---|
secretUrl |
string |
Geheime URL, die die geschützten Einstellungen der Erweiterung enthält |
sourceVault |
Die ARM-Ressourcen-ID des Key Vault |
CloudServiceVaultCertificate
Beschreibt einen einzelnen Zertifikatverweis in einem Key Vault und den Speicherort des Zertifikats für die Rolle instance.
Name | Typ | Beschreibung |
---|---|---|
certificateUrl |
string |
Dies ist die URL eines Zertifikats, das als Geheimnis in Key Vault hochgeladen wurde. |
CloudServiceVaultSecretGroup
Beschreibt eine Gruppe von Zertifikaten, die sich alle im gleichen Key Vault befinden.
Name | Typ | Beschreibung |
---|---|---|
sourceVault |
Die relative URL der Key Vault, die alle Zertifikate in VaultCertificates enthält. |
|
vaultCertificates |
Die Liste der Schlüsseltresorverweise in SourceVault, die Zertifikate enthalten. |
Extension
Beschreibt eine Clouddiensterweiterung.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Der Name der Erweiterung. |
properties |
Erweiterungseigenschaften. |
InnerError
Details zu inneren Fehlern.
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 Lastenausgleichs |
properties |
Eigenschaften der Lastenausgleichskonfiguration. |
LoadBalancerConfigurationProperties
Beschreibt die Eigenschaften der Lastenausgleichskonfiguration.
Name | Typ | Beschreibung |
---|---|---|
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
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.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
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. |
properties |
Eigenschaften der Front-End-IP-Konfiguration des Lastenausgleichs. |
LoadBalancerFrontendIpConfigurationProperties
Beschreibt die IP-Konfiguration eines Clouddiensts
Name | Typ | Beschreibung |
---|---|---|
privateIPAddress |
string |
Die private IP-Adresse des virtuellen Netzwerks der IP-Konfiguration. |
publicIPAddress |
Der Verweis auf die öffentliche IP-Adressressource. |
|
subnet |
Der Verweis auf die Subnetzressource des virtuellen Netzwerks. |
SubResource
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Ressourcen-ID |
SystemData
Die Systemmetadaten zu dieser Ressource.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string |
Gibt den Zeitpunkt in UTC an, zu dem die Clouddienstressource (erweiterter Support) erstellt wurde. |
lastModifiedAt |
string |
Gibt den Zeitpunkt in UTC an, zu dem die Clouddienstressource (erweiterter Support) zuletzt geändert wurde. |