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=2022-09-04
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
cloud
|
path | True |
string |
A felhőszolgáltatás neve. |
resource
|
path | True |
string |
Az erőforráscsoport neve. |
subscription
|
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ó az URI részét képezi minden szolgáltatáshíváshoz. |
api-version
|
query | True |
string |
Client API-verzió. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Hiba |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | felhasználói fiók megszemélyesítése |
Példák
Get Cloud Service with Multiple Roles and RDP Extension
Sample Request
GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}?api-version=2022-09-04
Sample Response
{
"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 |
---|---|
Api |
Api-hiba. |
Api |
Api-hibabázis. |
Cloud |
Hibaválasz a Számítási szolgáltatástól. |
Cloud |
A felhőszolgáltatás ismertetése. |
Cloud |
Egy felhőalapú szolgáltatásbővítmény-profilt ismertet. |
Cloud |
Bővítmény tulajdonságai. |
Cloud |
Hálózati profil a felhőszolgáltatáshoz. |
Cloud |
A felhőszolgáltatás operációsrendszer-profilját ismerteti. |
Cloud |
Felhőszolgáltatás tulajdonságai |
Cloud |
A felhőszolgáltatás szerepkörprofiljának ismertetése. |
Cloud |
A szerepkör tulajdonságainak ismertetése. |
Cloud |
A felhőszolgáltatás szerepkör-termékváltozatát ismerteti. |
Cloud |
A felhőszolgáltatás ponttípusa.
A lehetséges értékek a következők: |
Cloud |
Frissítési mód a felhőszolgáltatáshoz. A szerepkörpéldányok a szolgáltatás üzembe helyezésekor lesznek lefoglalva a tartományok frissítéséhez. Frissítések minden frissítési tartományban manuálisan indítható el, vagy az összes frissítési tartományban automatikusan elindítható.
A lehetséges értékek a következők: |
Cloud |
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. |
Cloud |
Egy 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. |
Cloud |
Egy olyan tanúsítványkészletet ír le, amely ugyanabban a Key Vault található. |
Extension |
Egy felhőalapú szolgáltatásbővítményt ismertet. |
Inner |
Belső hiba részletei. |
Load |
A terheléselosztó konfigurációját ismerteti. |
Load |
A terheléselosztó konfigurációjának tulajdonságait ismerteti. |
Load |
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. |
Load |
A felhőszolgáltatás IP-konfigurációját ismerteti |
Sub |
|
System |
Az erőforráshoz kapcsolódó rendszer metaadatai. |
ApiError
Api-hiba.
Name | Típus | Description |
---|---|---|
code |
string |
A hibakód. |
details |
Az API-hiba részletei |
|
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 Számítási szolgáltatástól.
Name | Típus | Description |
---|---|---|
error |
Api-hiba. |
CloudService
A felhőszolgáltatás ismertetése.
Name | Típus | Description |
---|---|---|
id |
string |
Erőforrás-azonosító. |
location |
string |
Erőforrás helye. |
name |
string |
Erőforrás neve. |
properties |
Felhőszolgáltatás tulajdonságai |
|
systemData |
Az erőforráshoz kapcsolódó rendszer metaadatai. |
|
tags |
object |
Erőforráscímkék. |
type |
string |
Erőforrástípus. |
zones |
string[] |
Az erőforrás logikai rendelkezésre állási zónájának listája. A lista csak 1 zónát tartalmazhat, ahol a felhőszolgáltatást ki kell építeni. A mező nem kötelező. |
CloudServiceExtensionProfile
Egy felhőalapú szolgáltatásbővítmény-profilt ismertet.
Name | Típus | Description |
---|---|---|
extensions |
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 |
Címke a megadott nyilvános és védett beállítások alkalmazásának kényszerítéséhez. A címke értékének módosítása lehetővé teszi a bővítmény újbóli futtatá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 jutna el a szerepkörpéldányhoz, és a kezelőnek kell eldöntenie, hogy újra futtatja-e vagy sem. |
protectedSettings |
object |
A bővítmény védett beállításai, amelyek a szerepkörpéldánynak való küldés előtt titkosítva vannak. |
protectedSettingsFromKeyVault |
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 "*" van megadva, a bővítmény a felhőszolgáltatás összes szerepkörére érvényes lesz. |
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 é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), az adott bővítményverzió lesz kiválasztva. Ha meg van adva verzió, automatikus frissítés történik a szerepkörpéldányon. |
CloudServiceNetworkProfile
Hálózati profil a felhőszolgáltatáshoz.
Name | Típus | Description |
---|---|---|
loadBalancerConfigurations |
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 Load Balancer és egy belső Load Balancer felelnek meg. |
|
slotType |
A felhőszolgáltatás ponttípusa.
A lehetséges értékek a következők: |
|
swappableCloudService |
Annak a felhőszolgáltatásnak az azonosítóhivatkozása, amely tartalmazza azt a cél IP-címet, amellyel a tárgyfelhő-szolgáltatás felcserélhető. Ezt a tulajdonságot a beállítás után nem lehet frissíteni. 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 |
Megadja a szerepkörpéldányokra telepíteni kívánt tanúsítványok halmazá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ágoknak (roleProfile.roles.sku) felül kell-e bírálnia a szerepkörpéldányok számát és a .cscfg és a .csdef fájlban megadott virtuálisgép-méretet.
Az alapértelmezett érték |
configuration |
string |
Megadja a felhőszolgáltatás XML-szolgáltatáskonfigurációját (.cscfg). |
configurationUrl |
string |
A blobszolgáltatás szolgáltatáskonfigurációjának helyére hivatkozó URL-címet ad meg. A szolgáltatáscsomag URL-címe bármely tárfiók megosztott hozzáférésű jogosultságkódjának (SAS) URI-ja lehet. Ez egy írásvédett tulajdonság, amely nem jelenik meg a GET-hívásokban. |
extensionProfile |
Egy felhőalapú szolgáltatásbővítmény-profilt ismertet. |
|
networkProfile |
Hálózati profil a felhőszolgáltatáshoz. |
|
osProfile |
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ódjának (SAS) URI-ja lehet. Ez egy írásvédett tulajdonság, amely nem jelenik meg a GET-hívásokban. |
provisioningState |
string |
A kiépítési állapot, amely csak a válaszban jelenik meg. |
roleProfile |
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 |
uniqueId |
string |
A felhőszolgáltatás egyedi azonosítója. |
upgradeMode |
Frissítési mód a felhőszolgáltatáshoz. A szerepkörpéldányok a szolgáltatás üzembe helyezésekor lesznek lefoglalva a tartományok frissítéséhez. Frissítések minden frissítési tartományban manuálisan indítható el, vagy az összes frissítési tartományban automatikusan elindítható.
A lehetséges értékek a következők: |
CloudServiceRoleProfile
A felhőszolgáltatás szerepkörprofiljának ismertetése.
Name | Típus | Description |
---|---|---|
roles |
A felhőszolgáltatás szerepköreinek listája. |
CloudServiceRoleProfileProperties
A szerepkör tulajdonságainak ismertetése.
Name | Típus | Description |
---|---|---|
name |
string |
Erőforrás neve. |
sku |
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 |
Meghatározza a szerepkörpéldányok számát a felhőszolgáltatásban. |
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 fut, 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 |
Meghatározza a felhőszolgáltatás szintjét. A lehetséges értékek a következők: |
CloudServiceSlotType
A felhőszolgáltatás ponttípusa.
A lehetséges értékek a következők:
Éles
Előkészítés
Ha nincs megadva, az alapértelmezett érték a Production (Éles).
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 lesznek lefoglalva a tartományok frissítéséhez. Frissítések minden frissítési tartományban manuálisan indítható el, vagy az összes frissítési tartományban automatikusan elindítható.
A lehetséges értékek a következők:
Automatikus
Kézi
Egyidejű
Ha nincs megadva, az alapértelmezett érték az Automatikus. Ha manuális értékre van állítva, a PUT UpdateDomaint meg kell hívni a frissítés alkalmazásához. Ha az 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 |
A Key Vault ARM-erőforrás-azonosítója |
CloudServiceVaultCertificate
Egy 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 annak a tanúsítványnak az URL-címe, amelyet titkos kódként töltött fel Key Vault. |
CloudServiceVaultSecretGroup
Egy olyan tanúsítványkészletet ír le, amely ugyanabban a Key Vault található.
Name | Típus | Description |
---|---|---|
sourceVault |
A VaultCertificates összes tanúsítványát tartalmazó Key Vault relatív URL-címe. |
|
vaultCertificates |
A Tanúsítványokat tartalmazó SourceVault kulcstartó-hivatkozásainak listája. |
Extension
Egy felhőalapú szolgáltatásbővítményt ismertet.
Name | Típus | Description |
---|---|---|
name |
string |
A bővítmény neve. |
properties |
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 |
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 |
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érbeli 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 |
A terheléselosztó előtérbeli IP-konfigurációjának tulajdonságai. |
LoadBalancerFrontendIpConfigurationProperties
A felhőszolgáltatás IP-konfigurációját ismerteti
Name | Típus | Description |
---|---|---|
privateIPAddress |
string |
Az IP-konfiguráció virtuális hálózati magánhálózati IP-címe. |
publicIPAddress |
A nyilvános IP-cím erőforrásra mutató hivatkozás. |
|
subnet |
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 |
A cloud service (kiterjesztett támogatás) erőforrás létrehozásának időpontja UTC-ben. |
lastModifiedAt |
string |
Azt az időpontot adja meg UTC-ben, amikor a cloud service (kiterjesztett támogatás) erőforrást legutóbb módosították. |