Megosztás a következőn keresztül:


Cloud Services - Get

Felhőszolgáltatással kapcsolatos információk megjelenítése.

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

URI-paraméterek

Name In Kötelező Típus Description
cloudServiceName
path True

string

A felhőszolgáltatás neve.

resourceGroupName
path True

string

Az erőforráscsoport neve.

subscriptionId
path True

string

Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi.

api-version
query True

string

Ügyfél API-verziója.

Válaszok

Name Típus Description
200 OK

CloudService

OKÉ

Other Status Codes

CloudError

Hiba

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation a felhasználói fiók megszemélyesítése

Példák

Get Cloud Service with Multiple Roles and RDP Extension

Mintakérelem

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

Mintaválasz

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

Definíciók

Name Description
ApiError

Api-hiba.

ApiErrorBase

Api-hibabázis.

CloudError

Hibaválasz a Compute szolgáltatástól.

CloudService

A felhőszolgáltatást ismerteti.

CloudServiceExtensionProfile

Egy felhőszolgáltatás-bővítményprofil ismertetése.

CloudServiceExtensionProperties

Bővítmény tulajdonságai.

CloudServiceNetworkProfile

A felhőszolgáltatás hálózati profilja.

CloudServiceOsProfile

A felhőszolgáltatás operációsrendszer-profilját ismerteti.

CloudServiceProperties

Felhőszolgáltatás tulajdonságai

CloudServiceRoleProfile

A felhőszolgáltatás szerepkörprofiljának ismertetése.

CloudServiceRoleProfileProperties

A szerepkör tulajdonságainak leírása.

CloudServiceRoleSku

A felhőszolgáltatás szerepkör-termékváltozatát ismerteti.

CloudServiceSlotType

A felhőszolgáltatás ponttípusa. A lehetséges értékek a következők:

Éles

átmeneti

Ha nincs megadva, az alapértelmezett érték az Éles környezet.

CloudServiceUpgradeMode

Frissítési mód a felhőszolgáltatáshoz. A szerepkörpéldányok a szolgáltatás üzembe helyezésekor a tartományok frissítéséhez vannak lefoglalva. A frissítések manuálisan indíthatók minden frissítési tartományban, vagy automatikusan kezdeményezhetők az összes frissítési tartományban. A lehetséges értékek a következők:

automatikus

manuális

Egyidejű

Ha nincs megadva, az alapértelmezett érték az Automatikus érték. Ha manuális értékre van állítva, a PUT UpdateDomain-t meg kell hívni a frissítés alkalmazásához. Ha automatikus értékre van állítva, a rendszer automatikusan alkalmazza a frissítést az egyes frissítési tartományokra egymás után.

CloudServiceVaultAndSecretReference

A bővítmény védett beállításai, amelyekre a KeyVault használatával hivatkozunk, amelyek titkosítva vannak, mielőtt elküldené őket a szerepkörpéldánynak.

CloudServiceVaultCertificate

A Key Vault egyetlen tanúsítványhivatkozását ismerteti, és azt, hogy a tanúsítványnak hol kell lennie a szerepkörpéldányon.

CloudServiceVaultSecretGroup

Egy olyan tanúsítványkészletet ír le, amely ugyanabban a Key Vaultban található.

Extension

Egy felhőalapú szolgáltatásbővítményt ismertet.

InnerError

Belső hiba részletei.

LoadBalancerConfiguration

A terheléselosztó konfigurációját ismerteti.

LoadBalancerConfigurationProperties

A terheléselosztó konfigurációjának tulajdonságait ismerteti.

LoadBalancerFrontendIpConfiguration

Megadja a terheléselosztóhoz használandó előtérbeli IP-címet. Csak az IPv4 előtér IP-címe támogatott. Minden terheléselosztó-konfigurációnak pontosan egy előtérbeli IP-konfigurációval kell rendelkeznie.

LoadBalancerFrontendIpConfigurationProperties

A felhőszolgáltatás IP-konfigurációjának ismertetése

SubResource
SystemData

Az erőforráshoz kapcsolódó rendszer metaadatai.

ApiError

Api-hiba.

Name Típus Description
code

string

A hibakód.

details

ApiErrorBase[]

Az API-hiba részletei

innererror

InnerError

Az Api belső hibája

message

string

A hibaüzenet.

target

string

Az adott hiba célja.

ApiErrorBase

Api-hibabázis.

Name Típus Description
code

string

A hibakód.

message

string

A hibaüzenet.

target

string

Az adott hiba célja.

CloudError

Hibaválasz a Compute szolgáltatástól.

Name Típus Description
error

ApiError

Api-hiba.

CloudService

A felhőszolgáltatást ismerteti.

Name Típus Description
id

string

Erőforrás-azonosító.

location

string

Erőforrás helye.

name

string

Erőforrás neve.

properties

CloudServiceProperties

Felhőszolgáltatás tulajdonságai

systemData

SystemData

Az erőforráshoz kapcsolódó rendszer metaadatai.

tags

object

Erőforráscímkék.

type

string

Erőforrás típusa.

zones

string[]

Az erőforrás logikai rendelkezésre állási zónájának listája. A listának csak 1 zónát kell tartalmaznia, ahol a felhőszolgáltatást ki kell építeni. Ez a mező nem kötelező.

CloudServiceExtensionProfile

Egy felhőszolgáltatás-bővítményprofil ismertetése.

Name Típus Description
extensions

Extension[]

A felhőszolgáltatás bővítményeinek listája.

CloudServiceExtensionProperties

Bővítmény tulajdonságai.

Name Típus Description
autoUpgradeMinorVersion

boolean

Explicit módon adja meg, hogy a platform képes-e automatikusan frissíteni a TypeHandlerVersion típust a magasabb alverziókra, amikor elérhetővé válnak.

forceUpdateTag

string

A megadott nyilvános és védett beállítások kényszerítéséhez használja a címkét. A címke értékének módosítása lehetővé teszi a bővítmény újrafuttatását a nyilvános vagy védett beállítások módosítása nélkül. Ha a forceUpdateTag nem módosul, a kezelő továbbra is alkalmazza a nyilvános vagy védett beállítások frissítéseit. Ha sem a forceUpdateTag, sem a nyilvános vagy védett beállítások nem változnak, a bővítmény ugyanazzal a sorszámmal áramlik a szerepkörpéldányra, és a kezelőn múlik, hogy újra futtatja-e vagy sem.

protectedSettings

object

A szerepkörpéldánynak való küldés előtt titkosított bővítmény védett beállításai.

protectedSettingsFromKeyVault

CloudServiceVaultAndSecretReference

A bővítmény védett beállításai, amelyekre a KeyVault használatával hivatkozunk, amelyek titkosítva vannak, mielőtt elküldené őket a szerepkörpéldánynak.

provisioningState

string

A kiépítési állapot, amely csak a válaszban jelenik meg.

publisher

string

A bővítménykezelő közzétevőjének neve.

rolesAppliedTo

string[]

Nem kötelező a bővítmény alkalmazásához szükséges szerepkörök listája. Ha a tulajdonság nincs megadva, vagy a "*" meg van adva, a bővítmény a felhőszolgáltatás összes szerepkörére vonatkozik.

settings

object

A bővítmény nyilvános beállításai. JSON-bővítmények esetén ez a bővítmény JSON-beállításai. Az XML-bővítmény (például RDP) esetében ez a bővítmény XML-beállítása.

type

string

A bővítmény típusát adja meg.

typeHandlerVersion

string

A bővítmény verzióját adja meg. A bővítmény verzióját adja meg. Ha ez az elem nincs megadva, vagy csillagot (*) használ az értékként, a bővítmény legújabb verzióját használja a rendszer. Ha az érték főverziószámmal és csillaggal van megadva alverziószámként (X.), a megadott főverzió legújabb alverziója lesz kiválasztva. Ha egy főverziószám és egy alverziószám van megadva (X.Y), a bővítmény adott verziója lesz kiválasztva. Ha meg van adva verzió, automatikus frissítés történik a szerepkörpéldányon.

CloudServiceNetworkProfile

A felhőszolgáltatás hálózati profilja.

Name Típus Description
loadBalancerConfigurations

LoadBalancerConfiguration[]

A Terheléselosztó konfigurációinak listája. A felhőszolgáltatás legfeljebb két terheléselosztó konfigurációval rendelkezhet, amelyek egy nyilvános terheléselosztónak és egy belső terheléselosztónak felelnek meg.

slotType

CloudServiceSlotType

A felhőszolgáltatás ponttípusa. A lehetséges értékek a következők:

Éles

átmeneti

Ha nincs megadva, az alapértelmezett érték az Éles környezet.

swappableCloudService

SubResource

Annak a felhőszolgáltatásnak az azonosítóhivatkozása, amely tartalmazza azt a cél IP-címet, amellyel az érintett felhőszolgáltatás felcserélhető. Ez a tulajdonság a beállítás után nem frissíthető. Az azonosító által hivatkozott cserélhető felhőszolgáltatásnak jelen kell lennie, különben hibaüzenet jelenik meg.

CloudServiceOsProfile

A felhőszolgáltatás operációsrendszer-profilját ismerteti.

Name Típus Description
secrets

CloudServiceVaultSecretGroup[]

Megadja a szerepkörpéldányokra telepíteni kívánt tanúsítványok készletét.

CloudServiceProperties

Felhőszolgáltatás tulajdonságai

Name Típus Description
allowModelOverride

boolean

(Nem kötelező) Azt jelzi, hogy a modellben/sablonban megadott szerepkör-termékváltozat tulajdonságainak (roleProfile.role.sku) felül kell-e bírálnia a .cscfg és a .csdef szerepkörpéldányok számát és virtuálisgép-méretét. Az alapértelmezett érték a false.

configuration

string

Megadja a felhőszolgáltatás XML-szolgáltatáskonfigurációját (.cscfg).

configurationUrl

string

Olyan URL-címet ad meg, amely a blobszolgáltatás szolgáltatáskonfigurációjának helyére hivatkozik. A szolgáltatáscsomag URL-címe bármely tárfiók megosztott hozzáférésű jogosultságkódja (SAS) URI lehet. Ez egy írásvédett tulajdonság, és a GET-hívások nem adják vissza.

extensionProfile

CloudServiceExtensionProfile

Egy felhőszolgáltatás-bővítményprofil ismertetése.

networkProfile

CloudServiceNetworkProfile

A felhőszolgáltatás hálózati profilja.

osProfile

CloudServiceOsProfile

A felhőszolgáltatás operációsrendszer-profilját ismerteti.

packageUrl

string

Olyan URL-címet ad meg, amely a szolgáltatáscsomag blobszolgáltatásban való helyére hivatkozik. A szolgáltatáscsomag URL-címe bármely tárfiók megosztott hozzáférésű jogosultságkódja (SAS) URI lehet. Ez egy írásvédett tulajdonság, és a GET-hívások nem adják vissza.

provisioningState

string

A kiépítési állapot, amely csak a válaszban jelenik meg.

roleProfile

CloudServiceRoleProfile

A felhőszolgáltatás szerepkörprofiljának ismertetése.

startCloudService

boolean

(Nem kötelező) Azt jelzi, hogy a felhőszolgáltatást közvetlenül a létrehozása után kell-e elindítani. Az alapértelmezett érték a true. Ha hamis, a szolgáltatásmodell továbbra is üzembe van helyezve, de a kód nem fut azonnal. Ehelyett a szolgáltatás a PoweredOff lesz, amíg meg nem hívja a Startot, és ekkor elindul a szolgáltatás. Az üzembe helyezett szolgáltatások továbbra is díjakat vonnak maga után, még akkor is, ha az ki van kapcsolva.

uniqueId

string

A felhőszolgáltatás egyedi azonosítója.

upgradeMode

CloudServiceUpgradeMode

Frissítési mód a felhőszolgáltatáshoz. A szerepkörpéldányok a szolgáltatás üzembe helyezésekor a tartományok frissítéséhez vannak lefoglalva. A frissítések manuálisan indíthatók minden frissítési tartományban, vagy automatikusan kezdeményezhetők az összes frissítési tartományban. A lehetséges értékek a következők:

automatikus

manuális

Egyidejű

Ha nincs megadva, az alapértelmezett érték az Automatikus érték. Ha manuális értékre van állítva, a PUT UpdateDomain-t meg kell hívni a frissítés alkalmazásához. Ha automatikus értékre van állítva, a rendszer automatikusan alkalmazza a frissítést az egyes frissítési tartományokra egymás után.

CloudServiceRoleProfile

A felhőszolgáltatás szerepkörprofiljának ismertetése.

Name Típus Description
roles

CloudServiceRoleProfileProperties[]

A felhőszolgáltatás szerepköreinek listája.

CloudServiceRoleProfileProperties

A szerepkör tulajdonságainak leírása.

Name Típus Description
name

string

Erőforrás neve.

sku

CloudServiceRoleSku

A felhőszolgáltatás szerepkör-termékváltozatát ismerteti.

CloudServiceRoleSku

A felhőszolgáltatás szerepkör-termékváltozatát ismerteti.

Name Típus Description
capacity

integer

A felhőszolgáltatás szerepkörpéldányainak számát adja meg.

name

string

A termékváltozat neve. MEGJEGYZÉS: Ha az új termékváltozat nem támogatott azon a hardveren, amelyen a felhőszolgáltatás jelenleg működik, törölnie kell és újra létre kell hoznia a felhőszolgáltatást, vagy vissza kell lépnie a régi termékváltozatra.

tier

string

Megadja a felhőszolgáltatás szintjét. A lehetséges értékek a következők:

Standard

Alapszintű

CloudServiceSlotType

A felhőszolgáltatás ponttípusa. A lehetséges értékek a következők:

Éles

átmeneti

Ha nincs megadva, az alapértelmezett érték az Éles környezet.

Name Típus Description
Production

string

Staging

string

CloudServiceUpgradeMode

Frissítési mód a felhőszolgáltatáshoz. A szerepkörpéldányok a szolgáltatás üzembe helyezésekor a tartományok frissítéséhez vannak lefoglalva. A frissítések manuálisan indíthatók minden frissítési tartományban, vagy automatikusan kezdeményezhetők az összes frissítési tartományban. A lehetséges értékek a következők:

automatikus

manuális

Egyidejű

Ha nincs megadva, az alapértelmezett érték az Automatikus érték. Ha manuális értékre van állítva, a PUT UpdateDomain-t meg kell hívni a frissítés alkalmazásához. Ha automatikus értékre van állítva, a rendszer automatikusan alkalmazza a frissítést az egyes frissítési tartományokra egymás után.

Name Típus Description
Auto

string

Manual

string

Simultaneous

string

CloudServiceVaultAndSecretReference

A bővítmény védett beállításai, amelyekre a KeyVault használatával hivatkozunk, amelyek titkosítva vannak, mielőtt elküldené őket a szerepkörpéldánynak.

Name Típus Description
secretUrl

string

Titkos URL-cím, amely a bővítmény védett beállításait tartalmazza

sourceVault

SubResource

A Key Vault ARM-erőforrásazonosítója

CloudServiceVaultCertificate

A Key Vault egyetlen tanúsítványhivatkozását ismerteti, és azt, hogy a tanúsítványnak hol kell lennie a szerepkörpéldányon.

Name Típus Description
certificateUrl

string

Ez egy tanúsítvány URL-címe, amelyet titkos kulcsként töltöttek fel a Key Vaultba.

isBootstrapCertificate

boolean

Jelző, amely jelzi, hogy a megadott tanúsítvány egy bootstrap-tanúsítvány, amelyet a Key Vault-bővítmény használ a fennmaradó tanúsítványok lekéréséhez.

CloudServiceVaultSecretGroup

Egy olyan tanúsítványkészletet ír le, amely ugyanabban a Key Vaultban található.

Name Típus Description
sourceVault

SubResource

A Key Vault relatív URL-címe, amely a VaultCertificates összes tanúsítványát tartalmazza.

vaultCertificates

CloudServiceVaultCertificate[]

A tanúsítványokat tartalmazó Key Vault-hivatkozások listája a SourceVaultban.

Extension

Egy felhőalapú szolgáltatásbővítményt ismertet.

Name Típus Description
name

string

A bővítmény neve.

properties

CloudServiceExtensionProperties

Bővítmény tulajdonságai.

InnerError

Belső hiba részletei.

Name Típus Description
errordetail

string

A belső hibaüzenet vagy kivételkép.

exceptiontype

string

A kivétel típusa.

LoadBalancerConfiguration

A terheléselosztó konfigurációját ismerteti.

Name Típus Description
id

string

Erőforrás-azonosító

name

string

A terheléselosztó neve

properties

LoadBalancerConfigurationProperties

A terheléselosztó konfigurációjának tulajdonságai.

LoadBalancerConfigurationProperties

A terheléselosztó konfigurációjának tulajdonságait ismerteti.

Name Típus Description
frontendIpConfigurations

LoadBalancerFrontendIpConfiguration[]

Megadja a terheléselosztóhoz használandó előtérbeli IP-címet. Csak az IPv4 előtér IP-címe támogatott. Minden terheléselosztó-konfigurációnak pontosan egy előtérbeli IP-konfigurációval kell rendelkeznie.

LoadBalancerFrontendIpConfiguration

Megadja a terheléselosztóhoz használandó előtérbeli IP-címet. Csak az IPv4 előtér IP-címe támogatott. Minden terheléselosztó-konfigurációnak pontosan egy előtérbeli IP-konfigurációval kell rendelkeznie.

Name Típus Description
name

string

A terheléselosztó által használt előtér-IP-konfigurációkon belül egyedi erőforrás neve. Ez a név használható az erőforrás eléréséhez.

properties

LoadBalancerFrontendIpConfigurationProperties

A terheléselosztó előtérbeli IP-konfigurációjának tulajdonságai.

LoadBalancerFrontendIpConfigurationProperties

A felhőszolgáltatás IP-konfigurációjának ismertetése

Name Típus Description
privateIPAddress

string

Az IP-konfiguráció virtuális hálózatának privát IP-címe.

publicIPAddress

SubResource

A nyilvános IP-cím erőforrásra mutató hivatkozás.

subnet

SubResource

A virtuális hálózati alhálózati erőforrásra mutató hivatkozás.

SubResource

Name Típus Description
id

string

Erőforrás-azonosító

SystemData

Az erőforráshoz kapcsolódó rendszer metaadatai.

Name Típus Description
createdAt

string

Azt az időpontot adja meg UTC-ben, amikor a Cloud Service (kiterjesztett támogatás) erőforrás létrejött.
Minimális API-verzió: 2022-04-04.

lastModifiedAt

string

Azt az időpontot adja meg UTC-ben, amikor a Cloud Service (kiterjesztett támogatás) erőforrás utoljára módosult.
Minimális API-verzió: 2022-04-04.