Sdílet prostřednictvím


Cloud Services - List

Získá seznam všech cloudových služeb v rámci skupiny prostředků. Pomocí vlastnosti nextLink v odpovědi získáte další stránku Cloud Services. Pokud chcete načíst všechny Cloud Services, udělejte to do doby, než má nextLink hodnotu null.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
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 je 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

CloudServiceListResult

OK

Other Status Codes

CloudError

Chyba

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

List Cloud Services in a Resource Group

Ukázkový požadavek

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

Ukázková odpověď

{
  "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"
      }
    }
  ]
}

Definice

Name Description
ApiError

Chyba rozhraní API

ApiErrorBase

Základ chyb rozhraní API.

CloudError

Chybová odpověď ze služby Compute.

CloudService

Popisuje cloudovou službu.

CloudServiceExtensionProfile

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

CloudServiceExtensionProperties

Vlastnosti rozšíření.

CloudServiceListResult

Výsledek operace seznamu

CloudServiceNetworkProfile

Profil sítě pro cloudovou službu.

CloudServiceOsProfile

Popisuje profil operačního systému pro cloudovou službu.

CloudServiceProperties

Vlastnosti cloudové služby

CloudServiceRoleProfile

Popisuje profil role pro cloudovou službu.

CloudServiceRoleProfileProperties

Popisuje vlastnosti role.

CloudServiceRoleSku

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

CloudServiceSlotType

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

Produkční

Příprava

Pokud není zadaný, výchozí hodnota je Production.

CloudServiceUpgradeMode

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

Auto

Ruční

Současné

Pokud není zadaný, výchozí hodnota je Auto. Pokud je nastavená hodnota Ručně, musí být pro instalaci aktualizace volána funkce PUT UpdateDomain. Pokud je nastavená možnost Automaticky, aktualizace se automaticky aplikuje na každou aktualizační doménu postupně.

CloudServiceVaultAndSecretReference

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

CloudServiceVaultCertificate

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

CloudServiceVaultSecretGroup

Popisuje sadu certifikátů, které jsou všechny ve stejném Key Vault.

Extension

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

InnerError

Podrobnosti o vnitřní chybě.

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 IP adresu front-endu, která se má použít pro nástroj pro vyrovnávání zatížení. Podporuje se pouze IP adresa front-endu IPv4. Každá konfigurace nástroje pro vyrovnávání zatížení musí mít přesně jednu konfiguraci IP adresy front-endu.

LoadBalancerFrontendIpConfigurationProperties

Popisuje konfiguraci IP adresy cloudové služby.

SubResource
SystemData

Metadata systému vztahující se k tomuto 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

Chybová odpověď ze služby Compute.

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

Metadata systému vztahující se k tomuto 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, jestli 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í, obslužná rutina stále použije aktualizace veřejného nebo chráněného nastavení. 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 na implementaci obslužné rutiny, jestli ho znovu spustíte, nebo ne.

protectedSettings

object

Chráněná nastavení rozšíření, která se před odesláním do instance role zašifrují.

protectedSettingsFromKeyVault

CloudServiceVaultAndSecretReference

Chráněná nastavení rozšíření, na která se odkazuje pomocí služby Key Vault, která jsou před odesláním do instance role zaš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í zadaná vlastnost nebo je zadána hodnota *, 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 se jako hodnota použije hvězdička (*), použije se nejnovější verze rozšíření. Pokud je hodnota zadána číslem hlavní verze a hvězdičkou 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 vybrána konkrétní verze rozšíření. Pokud je zadaná verze, provede se automatický upgrade instance role.

CloudServiceListResult

Výsledek operace seznamu

Name Typ Description
nextLink

string

Identifikátor URI pro načtení další stránky prostředků Pomocí této možnosti získáte další stránku prostředků. Pokud chcete načíst všechny prostředky, udělejte to až do hodnoty nextLink null.

value

CloudService[]

Seznam prostředků.

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é Load Balancer a internímu Load Balancer.

slotType

CloudServiceSlotType

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

Produkční

Příprava

Pokud není zadaný, výchozí hodnota je Production.

swappableCloudService

SubResource

Odkaz na ID cloudové služby obsahující cílovou IP adresu, se kterou může předmětná cloudová služba provést prohození. Tuto vlastnost nelze po nastavení aktualizovat. Musí existovat prohozená cloudová služba, na kterou odkazuje toto ID, jinak dojde k chybě.

CloudServiceOsProfile

Popisuje profil operačního systému pro cloudovou službu.

Name Typ Description
secrets

CloudServiceVaultSecretGroup[]

Určuje sadu certifikátů, které se mají nainstalovat do instancí rolí.

CloudServiceProperties

Vlastnosti cloudové služby

Name Typ Description
allowModelOverride

boolean

(Volitelné) Určuje, jestli vlastnosti SKU role (roleProfile.roles.sku) zadané v modelu nebo šabloně mají přepsat počet instancí role a velikost virtuálního počítače zadanou v .cscfg a .csdef v uvedeném pořadí. 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ě. Jedná se o vlastnost určenou jen pro zápis a ve voláníCH GET se nevracela.

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 pro cloudovou službu.

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ě. Jedná se o vlastnost určenou jen pro zápis a ve voláníCH GET se nevracela.

provisioningState

string

Stav zřizování, který se zobrazí pouze v odpovědi.

roleProfile

CloudServiceRoleProfile

Popisuje profil role pro cloudovou službu.

startCloudService

boolean

(Volitelné) Určuje, jestli se má cloudová služba spustit okamžitě po jejím 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 má služba funkci PoweredOff, dokud nezavoláte start, kdy se služba spustí. Za nasazenou službu se stále účtují poplatky, i když je vypnutá.

uniqueId

string

Jedinečný identifikátor cloudové služby.

upgradeMode

CloudServiceUpgradeMode

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

Auto

Ruční

Současné

Pokud není zadaný, výchozí hodnota je Auto. Pokud je nastavená hodnota Ručně, musí být pro instalaci aktualizace volána funkce PUT UpdateDomain. Pokud je nastavená možnost Automaticky, aktualizace se automaticky aplikuje na každou aktualizační doménu postupně.

CloudServiceRoleProfile

Popisuje profil role pro cloudovou službu.

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 se nová skladová položka nepodporuje na hardwaru, na který se cloudová služba aktuálně používá, musíte cloudovou službu odstranit a znovu vytvořit nebo se vrátit k původní skladové položce.

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:

Produkční

Příprava

Pokud není zadaný, výchozí hodnota je Production.

Name Typ Description
Production

string

Staging

string

CloudServiceUpgradeMode

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

Auto

Ruční

Současné

Pokud není zadaný, výchozí hodnota je Auto. Pokud je nastavená hodnota Ručně, musí být pro instalaci aktualizace volána funkce PUT UpdateDomain. Pokud je nastavená možnost Automaticky, aktualizace se automaticky aplikuje na každou aktualizační doménu postupně.

Name Typ Description
Auto

string

Manual

string

Simultaneous

string

CloudServiceVaultAndSecretReference

Chráněná nastavení rozšíření, na která se odkazuje pomocí služby Key Vault, která jsou před odesláním do instance role zaš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 Key Vault

CloudServiceVaultCertificate

Popisuje jeden odkaz na certifikát v 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 Key Vault jako tajný kód.

CloudServiceVaultSecretGroup

Popisuje sadu certifikátů, které jsou všechny ve stejném Key Vault.

Name Typ Description
sourceVault

SubResource

Relativní adresa URL Key Vault obsahující všechny certifikáty v trezoruCertificates.

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 o vnitřní chybě.

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 IP adresu front-endu, která se má použít pro nástroj pro vyrovnávání zatížení. Podporuje se pouze IP adresa front-endu IPv4. Každá konfigurace nástroje pro vyrovnávání zatížení musí mít přesně jednu konfiguraci IP adresy front-endu.

LoadBalancerFrontendIpConfiguration

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

Name Typ Description
name

string

Název prostředku, který je jedinečný v rámci sady konfigurací ip adres front-endu používaných nástrojem pro vyrovnávání zatížení. Tento název se dá použít pro přístup k prostředku.

properties

LoadBalancerFrontendIpConfigurationProperties

Vlastnosti konfigurace IP adresy front-endu 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 IP adresy.

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

Metadata systému vztahující se k tomuto prostředku.

Name Typ Description
createdAt

string

Určuje čas ve standardu UTC, kdy byl prostředek cloudové služby (s rozšířenou podporou) vytvořen.
Minimální verze api:2022-04-04.

lastModifiedAt

string

Určuje čas ve standardu UTC, kdy byl prostředek cloudové služby (s rozšířenou podporou) naposledy změněn.
Minimální verze api:2022-04-04.