Cloud Services - Get

Reference

Služba:: Compute

Verze rozhraní API:: 2024-11-04

Zobrazení informací o cloudové službě

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
cloudServiceName	path	True	string	Název cloudové služby.
resourceGroupName	path	True	string	Název skupiny prostředků
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	CloudService	OK
Other Status Codes	CloudError	Chyba

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Get Cloud Service with Multiple Roles and RDP Extension

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Definice

Name	Description
ApiError	Chyba rozhraní API
ApiErrorBase	Základ chyb rozhraní API.
CloudError	Odpověď na chybu z výpočetní služby
CloudService	Popisuje cloudovou službu.
CloudServiceExtensionProfile	Popisuje profil rozšíření cloudové služby.
CloudServiceExtensionProperties	Vlastnosti rozšíření
CloudServiceNetworkProfile	Profil sítě pro cloudovou službu.
CloudServiceOsProfile	Popisuje profil operačního systému cloudové služby.
CloudServiceProperties	Vlastnosti cloudové služby
CloudServiceRoleProfile	Popisuje profil role cloudové služby.
CloudServiceRoleProfileProperties	Popisuje vlastnosti role.
CloudServiceRoleSku	Popisuje skladovou položku role cloudové služby.
CloudServiceSlotType	Typ slotu pro cloudovou službu. Možné hodnoty jsou Production pracovní Pokud není zadáno, výchozí hodnota je Production.
CloudServiceUpgradeMode	Režim aktualizace cloudové služby Instance rolí se při nasazení služby přidělují k aktualizačním doménám. Aktualizace je možné inicializovat ručně v každé aktualizační doméně nebo automaticky zahájit ve všech aktualizačních doménách. Možné hodnoty jsou automatické ruční souběžné Pokud není zadána, výchozí hodnota je Automaticky. Pokud je nastavena hodnota Manual, PUT UpdateDomain musí být volána pro instalaci aktualizace. Pokud je tato možnost nastavená na hodnotu Automaticky, aktualizace se automaticky použije pro každou aktualizační doménu v posloupnosti.
CloudServiceVaultAndSecretReference	Chráněná nastavení pro rozšíření, na která se odkazuje pomocí služby KeyVault, která jsou před odesláním do instance role šifrovaná.
CloudServiceVaultCertificate	Popisuje jeden odkaz na certifikát ve službě Key Vault a umístění certifikátu v instanci role.
CloudServiceVaultSecretGroup	Popisuje sadu certifikátů, které jsou všechny ve stejné službě Key Vault.
Extension	Popisuje rozšíření cloudové služby.
InnerError	Podrobnosti vnitřní chyby.
LoadBalancerConfiguration	Popisuje konfiguraci nástroje pro vyrovnávání zatížení.
LoadBalancerConfigurationProperties	Popisuje vlastnosti konfigurace nástroje pro vyrovnávání zatížení.
LoadBalancerFrontendIpConfiguration	Určuje front-endovou IP adresu, která se má použít pro nástroj pro vyrovnávání zatížení. Podporuje se jenom front-endová IP adresa IPv4. Každá konfigurace nástroje pro vyrovnávání zatížení musí mít přesně jednu konfiguraci front-endové IP adresy.
LoadBalancerFrontendIpConfigurationProperties	Popisuje konfiguraci IP adresy cloudové služby.
SubResource
SystemData	Systémová meta data týkající se tohoto prostředku.

ApiError

Chyba rozhraní API

Name	Typ	Description
code	string	Kód chyby.
details	ApiErrorBase[]	Podrobnosti o chybě rozhraní API
innererror	InnerError	Vnitřní chyba rozhraní API
message	string	Chybová zpráva.
target	string	Cíl konkrétní chyby.

ApiErrorBase

Základ chyb rozhraní API.

Name	Typ	Description
code	string	Kód chyby.
message	string	Chybová zpráva.
target	string	Cíl konkrétní chyby.

CloudError

Odpověď na chybu z výpočetní služby

Name	Typ	Description
error	ApiError	Chyba rozhraní API

CloudService

Popisuje cloudovou službu.

Name	Typ	Description
id	string	ID prostředku.
location	string	Umístění prostředku
name	string	Název prostředku
properties	CloudServiceProperties	Vlastnosti cloudové služby
systemData	SystemData	Systémová meta data týkající se tohoto prostředku.
tags	object	Značky prostředků
type	string	Typ prostředku.
zones	string[]	Seznam logické zóny dostupnosti prostředku Seznam by měl obsahovat pouze 1 zónu, ve které by měla být zřízena cloudová služba. Toto pole je volitelné.

CloudServiceExtensionProfile

Popisuje profil rozšíření cloudové služby.

Name	Typ	Description
extensions	Extension[]	Seznam rozšíření pro cloudovou službu

CloudServiceExtensionProperties

Vlastnosti rozšíření

Name	Typ	Description
autoUpgradeMinorVersion	boolean	Explicitně určete, zda platforma může automaticky upgradovat typeHandlerVersion na vyšší podverze, jakmile budou k dispozici.
forceUpdateTag	string	Značka, která vynutí použití poskytnutého veřejného a chráněného nastavení. Změna hodnoty značky umožňuje opětovné spuštění rozšíření beze změny veřejného nebo chráněného nastavení. Pokud se forceUpdateTag nezmění, aktualizace veřejného nebo chráněného nastavení by obslužná rutina stále použila. Pokud se nezmění ani forceUpdateTag ani žádná veřejná nebo chráněná nastavení, rozšíření by tok do instance role se stejným pořadovým číslem a je až do implementace obslužné rutiny bez ohledu na to, jestli se má znovu spustit, nebo ne.
protectedSettings	object	Chráněná nastavení rozšíření, která jsou před odesláním do instance role zašifrována.
protectedSettingsFromKeyVault	CloudServiceVaultAndSecretReference	Chráněná nastavení pro rozšíření, na která se odkazuje pomocí služby KeyVault, která jsou před odesláním do instance role šifrovaná.
provisioningState	string	Stav zřizování, který se zobrazí pouze v odpovědi.
publisher	string	Název vydavatele obslužné rutiny rozšíření.
rolesAppliedTo	string[]	Volitelný seznam rolí pro použití tohoto rozšíření Pokud není zadána vlastnost nebo *, použije se rozšíření pro všechny role v cloudové službě.
settings	object	Veřejná nastavení rozšíření U rozšíření JSON se jedná o nastavení JSON pro rozšíření. Pro rozšíření XML (například RDP) se jedná o nastavení XML pro rozšíření.
type	string	Určuje typ rozšíření.
typeHandlerVersion	string	Určuje verzi rozšíření. Určuje verzi rozšíření. Pokud tento prvek není zadán nebo hvězdička (*) se použije jako hodnota, použije se nejnovější verze rozšíření. Pokud je hodnota zadána číslem hlavní verze a hvězdička jako číslo podverze (X.), je vybrána nejnovější podverze zadané hlavní verze. Pokud je zadáno číslo hlavní verze a číslo podverze (X.Y), je vybraná konkrétní verze rozšíření. Pokud je zadána verze, provede se v instanci role automatický upgrade.

CloudServiceNetworkProfile

Profil sítě pro cloudovou službu.

Name	Typ	Description
loadBalancerConfigurations	LoadBalancerConfiguration[]	Seznam konfigurací nástroje pro vyrovnávání zatížení Cloudová služba může mít až dvě konfigurace nástroje pro vyrovnávání zatížení, které odpovídají veřejnému nástroji pro vyrovnávání zatížení a internímu nástroji pro vyrovnávání zatížení.
slotType	CloudServiceSlotType	Typ slotu pro cloudovou službu. Možné hodnoty jsou Production pracovní Pokud není zadáno, výchozí hodnota je Production.
swappableCloudService	SubResource	Referenční informace o ID cloudové služby obsahující cílovou IP adresu, se kterou může předmět cloudová služba provést prohození. Tuto vlastnost nelze aktualizovat, jakmile je nastavena. V případě, že dojde k chybě, musí existovat prohozená cloudová služba odkazující na toto ID.

CloudServiceOsProfile

Popisuje profil operačního systému cloudové služby.

Name	Typ	Description
secrets	CloudServiceVaultSecretGroup[]	Určuje sadu certifikátů, které by se měly nainstalovat do instancí rolí.

CloudServiceProperties

Vlastnosti cloudové služby

Name	Typ	Description
allowModelOverride	boolean	(Volitelné) Určuje, jestli mají vlastnosti skladové položky role (roleProfile.roles.sku) zadané v modelu nebo šabloně přepsat počet instancí role a velikost virtuálního počítače zadané v souboru .cscfg a .csdef. Výchozí hodnota je `false`.
configuration	string	Určuje konfiguraci služby XML (.cscfg) pro cloudovou službu.
configurationUrl	string	Určuje adresu URL, která odkazuje na umístění konfigurace služby ve službě Blob Service. Adresa URL balíčku služby může být identifikátor URI sdíleného přístupového podpisu (SAS) z libovolného účtu úložiště. Toto je vlastnost jen pro zápis a není vrácena ve volání GET.
extensionProfile	CloudServiceExtensionProfile	Popisuje profil rozšíření cloudové služby.
networkProfile	CloudServiceNetworkProfile	Profil sítě pro cloudovou službu.
osProfile	CloudServiceOsProfile	Popisuje profil operačního systému cloudové služby.
packageUrl	string	Určuje adresu URL, která odkazuje na umístění balíčku služby ve službě Blob Service. Adresa URL balíčku služby může být identifikátor URI sdíleného přístupového podpisu (SAS) z libovolného účtu úložiště. Toto je vlastnost jen pro zápis a není vrácena ve volání GET.
provisioningState	string	Stav zřizování, který se zobrazí pouze v odpovědi.
roleProfile	CloudServiceRoleProfile	Popisuje profil role cloudové služby.
startCloudService	boolean	(Volitelné) Určuje, jestli se má cloudová služba spustit hned po vytvoření. Výchozí hodnota je `true`. Pokud je hodnota false, model služby je stále nasazený, ale kód se nespustí okamžitě. Místo toho je služba PoweredOff, dokud nezavoláte Start, kdy bude služba spuštěna. Nasazená služba stále účtuje poplatky, i když je vypnutá.
uniqueId	string	Jedinečný identifikátor cloudové služby.
upgradeMode	CloudServiceUpgradeMode	Režim aktualizace cloudové služby Instance rolí se při nasazení služby přidělují k aktualizačním doménám. Aktualizace je možné inicializovat ručně v každé aktualizační doméně nebo automaticky zahájit ve všech aktualizačních doménách. Možné hodnoty jsou automatické ruční souběžné Pokud není zadána, výchozí hodnota je Automaticky. Pokud je nastavena hodnota Manual, PUT UpdateDomain musí být volána pro instalaci aktualizace. Pokud je tato možnost nastavená na hodnotu Automaticky, aktualizace se automaticky použije pro každou aktualizační doménu v posloupnosti.

CloudServiceRoleProfile

Popisuje profil role cloudové služby.

Name	Typ	Description
roles	CloudServiceRoleProfileProperties[]	Seznam rolí pro cloudovou službu

CloudServiceRoleProfileProperties

Popisuje vlastnosti role.

Name	Typ	Description
name	string	Název prostředku
sku	CloudServiceRoleSku	Popisuje skladovou položku role cloudové služby.

CloudServiceRoleSku

Popisuje skladovou položku role cloudové služby.

Name	Typ	Description
capacity	integer	Určuje počet instancí rolí v cloudové službě.
name	string	Název skladové položky. POZNÁMKA: Pokud nová skladová položka není na hardwaru, ve které je cloudová služba aktuálně zapnutá, musíte cloudovou službu odstranit a znovu vytvořit nebo se vrátit ke staré skladové poště.
tier	string	Určuje úroveň cloudové služby. Možné hodnoty jsou Standard Basic

CloudServiceSlotType

Typ slotu pro cloudovou službu. Možné hodnoty jsou

Production

pracovní

Pokud není zadáno, výchozí hodnota je Production.

Name	Typ	Description
Production	string
Staging	string

CloudServiceUpgradeMode

Režim aktualizace cloudové služby Instance rolí se při nasazení služby přidělují k aktualizačním doménám. Aktualizace je možné inicializovat ručně v každé aktualizační doméně nebo automaticky zahájit ve všech aktualizačních doménách. Možné hodnoty jsou

automatické

ruční

souběžné

Pokud není zadána, výchozí hodnota je Automaticky. Pokud je nastavena hodnota Manual, PUT UpdateDomain musí být volána pro instalaci aktualizace. Pokud je tato možnost nastavená na hodnotu Automaticky, aktualizace se automaticky použije pro každou aktualizační doménu v posloupnosti.

Name	Typ	Description
Auto	string
Manual	string
Simultaneous	string

CloudServiceVaultAndSecretReference

Chráněná nastavení pro rozšíření, na která se odkazuje pomocí služby KeyVault, která jsou před odesláním do instance role šifrovaná.

Name	Typ	Description
secretUrl	string	Adresa URL tajného kódu, která obsahuje chráněná nastavení rozšíření
sourceVault	SubResource	ID prostředku ARM trezoru klíčů

CloudServiceVaultCertificate

Popisuje jeden odkaz na certifikát ve službě Key Vault a umístění certifikátu v instanci role.

Name	Typ	Description
certificateUrl	string	Toto je adresa URL certifikátu, který se nahrál do služby Key Vault jako tajný klíč.
isBootstrapCertificate	boolean	Příznak označující, jestli zadaný certifikát je certifikát bootstrap, který má rozšíření key Vault použít k načtení zbývajících certifikátů.

CloudServiceVaultSecretGroup

Popisuje sadu certifikátů, které jsou všechny ve stejné službě Key Vault.

Name	Typ	Description
sourceVault	SubResource	Relativní adresa URL služby Key Vault obsahující všechny certifikáty ve službě VaultCertificates.
vaultCertificates	CloudServiceVaultCertificate[]	Seznam odkazů na trezor klíčů ve službě SourceVault, které obsahují certifikáty.

Extension

Popisuje rozšíření cloudové služby.

Name	Typ	Description
name	string	Název rozšíření.
properties	CloudServiceExtensionProperties	Vlastnosti rozšíření

InnerError

Podrobnosti vnitřní chyby.

Name	Typ	Description
errordetail	string	Vnitřní chybová zpráva nebo výpis výjimky.
exceptiontype	string	Typ výjimky.

LoadBalancerConfiguration

Popisuje konfiguraci nástroje pro vyrovnávání zatížení.

Name	Typ	Description
id	string	ID prostředku
name	string	Název nástroje pro vyrovnávání zatížení
properties	LoadBalancerConfigurationProperties	Vlastnosti konfigurace nástroje pro vyrovnávání zatížení

LoadBalancerConfigurationProperties

Popisuje vlastnosti konfigurace nástroje pro vyrovnávání zatížení.

Name	Typ	Description
frontendIpConfigurations	LoadBalancerFrontendIpConfiguration[]	Určuje front-endovou IP adresu, která se má použít pro nástroj pro vyrovnávání zatížení. Podporuje se jenom front-endová IP adresa IPv4. Každá konfigurace nástroje pro vyrovnávání zatížení musí mít přesně jednu konfiguraci front-endové IP adresy.

LoadBalancerFrontendIpConfiguration

Určuje front-endovou IP adresu, která se má použít pro nástroj pro vyrovnávání zatížení. Podporuje se jenom front-endová IP adresa IPv4. Každá konfigurace nástroje pro vyrovnávání zatížení musí mít přesně jednu konfiguraci front-endové IP adresy.

Name	Typ	Description
name	string	Název prostředku, který je jedinečný v rámci sady konfigurací front-endových IP adres používaných nástrojem pro vyrovnávání zatížení. Tento název lze použít pro přístup k prostředku.
properties	LoadBalancerFrontendIpConfigurationProperties	Vlastnosti konfigurace front-endové IP adresy nástroje pro vyrovnávání zatížení

LoadBalancerFrontendIpConfigurationProperties

Popisuje konfiguraci IP adresy cloudové služby.

Name	Typ	Description
privateIPAddress	string	Privátní IP adresa virtuální sítě konfigurace PROTOKOLU IP.
publicIPAddress	SubResource	Odkaz na prostředek veřejné IP adresy.
subnet	SubResource	Odkaz na prostředek podsítě virtuální sítě.

SubResource

Name	Typ	Description
id	string	ID prostředku

SystemData

Systémová meta data týkající se tohoto prostředku.

Name	Typ	Description
createdAt	string	Určuje čas vytvoření prostředku cloudové služby (rozšířená podpora) ve standardu UTC. Minimální verze api: 2022-04-04.
lastModifiedAt	string	Určuje čas ve standardu UTC, kdy byl naposledy změněn prostředek cloudové služby (rozšířená podpora). Minimální verze api: 2022-04-04.

Sdílet prostřednictvím