Cloud Services - Get
Visualizzare informazioni su un servizio cloud.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}?api-version=2024-11-04
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
cloud
|
path | True |
string |
Nome del servizio cloud. |
resource
|
path | True |
string |
Nome del gruppo di risorse. |
subscription
|
path | True |
string |
Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio. |
api-version
|
query | True |
string |
Versione dell'API client. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Errore |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
Get Cloud Service with Multiple Roles and RDP Extension
Esempio di richiesta
GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}?api-version=2024-11-04
Risposta di esempio
{
"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"
}
}
Definizioni
Nome | Descrizione |
---|---|
Api |
Errore dell'API. |
Api |
Base degli errori api. |
Cloud |
Risposta di errore dal servizio di calcolo. |
Cloud |
Descrive il servizio cloud. |
Cloud |
Descrive un profilo di estensione del servizio cloud. |
Cloud |
Proprietà dell'estensione. |
Cloud |
Profilo di rete per il servizio cloud. |
Cloud |
Descrive il profilo del sistema operativo per il servizio cloud. |
Cloud |
Proprietà del servizio cloud |
Cloud |
Descrive il profilo del ruolo per il servizio cloud. |
Cloud |
Descrive le proprietà del ruolo. |
Cloud |
Descrive lo SKU del ruolo del servizio cloud. |
Cloud |
Tipo di slot per il servizio cloud.
I valori possibili sono |
Cloud |
Modalità di aggiornamento per il servizio cloud. Le istanze del ruolo vengono allocate ai domini di aggiornamento quando il servizio viene distribuito. Gli aggiornamenti possono essere avviati manualmente in ogni dominio di aggiornamento o avviati automaticamente in tutti i domini di aggiornamento.
I valori possibili sono |
Cloud |
Impostazioni protette per l'estensione, a cui si fa riferimento usando KeyVault crittografate prima dell'invio all'istanza del ruolo. |
Cloud |
Descrive un singolo riferimento al certificato in un insieme di credenziali delle chiavi e dove deve risiedere il certificato nell'istanza del ruolo. |
Cloud |
Descrive un set di certificati che si trovano tutti nello stesso insieme di credenziali delle chiavi. |
Extension |
Descrive un'estensione del servizio cloud. |
Inner |
Dettagli dell'errore interno. |
Load |
Descrive la configurazione del servizio di bilanciamento del carico. |
Load |
Descrive le proprietà della configurazione del servizio di bilanciamento del carico. |
Load |
Specifica l'indirizzo IP front-end da usare per il servizio di bilanciamento del carico. È supportato solo l'indirizzo IP front-end IPv4. Ogni configurazione del servizio di bilanciamento del carico deve avere esattamente una configurazione IP front-end. |
Load |
Descrive una configurazione IP del servizio cloud |
Sub |
|
System |
Metadati di sistema relativi a questa risorsa. |
ApiError
Errore dell'API.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore. |
details |
Dettagli dell'errore dell'API |
|
innererror |
Errore interno dell'API |
|
message |
string |
Messaggio di errore. |
target |
string |
Destinazione dell'errore specifico. |
ApiErrorBase
Base degli errori api.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore. |
message |
string |
Messaggio di errore. |
target |
string |
Destinazione dell'errore specifico. |
CloudError
Risposta di errore dal servizio di calcolo.
Nome | Tipo | Descrizione |
---|---|---|
error |
Errore dell'API. |
CloudService
Descrive il servizio cloud.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID risorsa. |
location |
string |
Percorso della risorsa. |
name |
string |
Nome risorsa. |
properties |
Proprietà del servizio cloud |
|
systemData |
Metadati di sistema relativi a questa risorsa. |
|
tags |
object |
Tag di risorsa. |
type |
string |
Tipo di risorsa. |
zones |
string[] |
Elenco della zona di disponibilità logica della risorsa. L'elenco deve contenere solo 1 zona in cui eseguire il provisioning del servizio cloud. Questo campo è facoltativo. |
CloudServiceExtensionProfile
Descrive un profilo di estensione del servizio cloud.
Nome | Tipo | Descrizione |
---|---|---|
extensions |
Elenco di estensioni per il servizio cloud. |
CloudServiceExtensionProperties
Proprietà dell'estensione.
Nome | Tipo | Descrizione |
---|---|---|
autoUpgradeMinorVersion |
boolean |
Specificare in modo esplicito se la piattaforma può aggiornare automaticamente typeHandlerVersion a versioni secondarie superiori quando diventano disponibili. |
forceUpdateTag |
string |
Tag per forzare l'applicazione delle impostazioni pubbliche e protette fornite. La modifica del valore del tag consente di eseguire nuovamente l'estensione senza modificare le impostazioni pubbliche o protette. Se forceUpdateTag non viene modificato, gli aggiornamenti alle impostazioni pubbliche o protette verranno comunque applicati dal gestore. Se né forceUpdateTag né alcuna delle impostazioni pubbliche o protette cambiano, l'estensione passa all'istanza del ruolo con lo stesso numero di sequenza e spetta all'implementazione del gestore se eseguirla nuovamente o meno |
protectedSettings |
object |
Impostazioni protette per l'estensione crittografata prima dell'invio all'istanza del ruolo. |
protectedSettingsFromKeyVault |
Impostazioni protette per l'estensione, a cui si fa riferimento usando KeyVault crittografate prima dell'invio all'istanza del ruolo. |
|
provisioningState |
string |
Stato di provisioning, visualizzato solo nella risposta. |
publisher |
string |
Nome del server di pubblicazione del gestore dell'estensione. |
rolesAppliedTo |
string[] |
Elenco facoltativo di ruoli da applicare a questa estensione. Se la proprietà non è specificata o viene specificata '*', l'estensione viene applicata a tutti i ruoli nel servizio cloud. |
settings |
object |
Impostazioni pubbliche per l'estensione. Per le estensioni JSON, si tratta delle impostazioni JSON per l'estensione. Per l'estensione XML (ad esempio RDP), si tratta dell'impostazione XML per l'estensione. |
type |
string |
Specifica il tipo dell'estensione. |
typeHandlerVersion |
string |
Specifica la versione dell'estensione. Specifica la versione dell'estensione. Se questo elemento non viene specificato o viene utilizzato un asterisco (*) come valore, viene utilizzata la versione più recente dell'estensione. Se il valore viene specificato con un numero di versione principale e un asterisco come numero di versione secondaria (X.), viene selezionata la versione secondaria più recente della versione principale specificata. Se vengono specificati un numero di versione principale e un numero di versione secondaria (X.Y), viene selezionata la versione dell'estensione specifica. Se si specifica una versione, viene eseguito un aggiornamento automatico nell'istanza del ruolo. |
CloudServiceNetworkProfile
Profilo di rete per il servizio cloud.
Nome | Tipo | Descrizione |
---|---|---|
loadBalancerConfigurations |
Elenco delle configurazioni del servizio di bilanciamento del carico. Il servizio cloud può avere fino a due configurazioni del servizio di bilanciamento del carico, corrispondenti a un servizio di bilanciamento del carico pubblico e a un servizio di bilanciamento del carico interno. |
|
slotType |
Tipo di slot per il servizio cloud.
I valori possibili sono |
|
swappableCloudService |
Riferimento ID del servizio cloud contenente l'INDIRIZZO IP di destinazione con cui il servizio cloud soggetto può eseguire uno scambio. Questa proprietà non può essere aggiornata una volta impostata. Il servizio cloud scambiabile a cui fa riferimento questo ID deve essere presente; in caso contrario, verrà generato un errore. |
CloudServiceOsProfile
Descrive il profilo del sistema operativo per il servizio cloud.
Nome | Tipo | Descrizione |
---|---|---|
secrets |
Specifica il set di certificati che devono essere installati nelle istanze del ruolo. |
CloudServiceProperties
Proprietà del servizio cloud
Nome | Tipo | Descrizione |
---|---|---|
allowModelOverride |
boolean |
(Facoltativo) Indica se le proprietà dello SKU del ruolo (roleProfile.roles.sku) specificate nel modello/modello devono eseguire l'override rispettivamente del numero di istanze del ruolo e delle dimensioni della macchina virtuale specificate rispettivamente in .cscfg e .csdef.
Il valore predefinito è |
configuration |
string |
Specifica la configurazione del servizio XML (con estensione cscfg) per il servizio cloud. |
configurationUrl |
string |
Specifica un URL che fa riferimento al percorso della configurazione del servizio nel servizio BLOB. L'URL del pacchetto di servizio può essere l'URI della firma di accesso condiviso da qualsiasi account di archiviazione. Si tratta di una proprietà di sola scrittura e non viene restituita nelle chiamate GET. |
extensionProfile |
Descrive un profilo di estensione del servizio cloud. |
|
networkProfile |
Profilo di rete per il servizio cloud. |
|
osProfile |
Descrive il profilo del sistema operativo per il servizio cloud. |
|
packageUrl |
string |
Specifica un URL che fa riferimento al percorso del pacchetto del servizio nel servizio BLOB. L'URL del pacchetto di servizio può essere l'URI della firma di accesso condiviso da qualsiasi account di archiviazione. Si tratta di una proprietà di sola scrittura e non viene restituita nelle chiamate GET. |
provisioningState |
string |
Stato di provisioning, visualizzato solo nella risposta. |
roleProfile |
Descrive il profilo del ruolo per il servizio cloud. |
|
startCloudService |
boolean |
(Facoltativo) Indica se avviare il servizio cloud subito dopo la creazione. Il valore predefinito è |
uniqueId |
string |
Identificatore univoco per il servizio cloud. |
upgradeMode |
Modalità di aggiornamento per il servizio cloud. Le istanze del ruolo vengono allocate ai domini di aggiornamento quando il servizio viene distribuito. Gli aggiornamenti possono essere avviati manualmente in ogni dominio di aggiornamento o avviati automaticamente in tutti i domini di aggiornamento.
I valori possibili sono |
CloudServiceRoleProfile
Descrive il profilo del ruolo per il servizio cloud.
Nome | Tipo | Descrizione |
---|---|---|
roles |
Elenco dei ruoli per il servizio cloud. |
CloudServiceRoleProfileProperties
Descrive le proprietà del ruolo.
Nome | Tipo | Descrizione |
---|---|---|
name |
string |
Nome risorsa. |
sku |
Descrive lo SKU del ruolo del servizio cloud. |
CloudServiceRoleSku
Descrive lo SKU del ruolo del servizio cloud.
Nome | Tipo | Descrizione |
---|---|---|
capacity |
integer |
Specifica il numero di istanze del ruolo nel servizio cloud. |
name |
string |
Nome sku. NOTA: se il nuovo SKU non è supportato nell'hardware in cui è attualmente attivo il servizio cloud, è necessario eliminare e ricreare il servizio cloud o tornare allo SKU precedente. |
tier |
string |
Specifica il livello del servizio cloud. I valori possibili sono |
CloudServiceSlotType
Tipo di slot per il servizio cloud.
I valori possibili sono
di produzione
di gestione temporanea
Se non specificato, il valore predefinito è Production.
Nome | Tipo | Descrizione |
---|---|---|
Production |
string |
|
Staging |
string |
CloudServiceUpgradeMode
Modalità di aggiornamento per il servizio cloud. Le istanze del ruolo vengono allocate ai domini di aggiornamento quando il servizio viene distribuito. Gli aggiornamenti possono essere avviati manualmente in ogni dominio di aggiornamento o avviati automaticamente in tutti i domini di aggiornamento.
I valori possibili sono
automatico
manuale
simultanee
Se non specificato, il valore predefinito è Auto. Se impostato su Manuale, PUT UpdateDomain deve essere chiamato per applicare l'aggiornamento. Se impostato su Auto, l'aggiornamento viene applicato automaticamente a ogni dominio di aggiornamento in sequenza.
Nome | Tipo | Descrizione |
---|---|---|
Auto |
string |
|
Manual |
string |
|
Simultaneous |
string |
CloudServiceVaultAndSecretReference
Impostazioni protette per l'estensione, a cui si fa riferimento usando KeyVault crittografate prima dell'invio all'istanza del ruolo.
Nome | Tipo | Descrizione |
---|---|---|
secretUrl |
string |
URL segreto che contiene le impostazioni protette dell'estensione |
sourceVault |
ID risorsa ARM dell'insieme di credenziali delle chiavi |
CloudServiceVaultCertificate
Descrive un singolo riferimento al certificato in un insieme di credenziali delle chiavi e dove deve risiedere il certificato nell'istanza del ruolo.
Nome | Tipo | Descrizione |
---|---|---|
certificateUrl |
string |
Si tratta dell'URL di un certificato caricato in Key Vault come segreto. |
isBootstrapCertificate |
boolean |
Flag che indica se il certificato fornito è un certificato bootstrap da usare dall'estensione dell'insieme di credenziali delle chiavi per recuperare i certificati rimanenti. |
CloudServiceVaultSecretGroup
Descrive un set di certificati che si trovano tutti nello stesso insieme di credenziali delle chiavi.
Nome | Tipo | Descrizione |
---|---|---|
sourceVault |
URL relativo dell'insieme di credenziali delle chiavi contenente tutti i certificati in VaultCertificates. |
|
vaultCertificates |
Elenco di riferimenti all'insieme di credenziali delle chiavi in SourceVault che contengono certificati. |
Extension
Descrive un'estensione del servizio cloud.
Nome | Tipo | Descrizione |
---|---|---|
name |
string |
Nome dell'estensione. |
properties |
Proprietà dell'estensione. |
InnerError
Dettagli dell'errore interno.
Nome | Tipo | Descrizione |
---|---|---|
errordetail |
string |
Messaggio di errore interno o dump delle eccezioni. |
exceptiontype |
string |
Tipo di eccezione. |
LoadBalancerConfiguration
Descrive la configurazione del servizio di bilanciamento del carico.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID risorsa |
name |
string |
Nome del servizio di bilanciamento del carico |
properties |
Proprietà della configurazione del servizio di bilanciamento del carico. |
LoadBalancerConfigurationProperties
Descrive le proprietà della configurazione del servizio di bilanciamento del carico.
Nome | Tipo | Descrizione |
---|---|---|
frontendIpConfigurations |
Specifica l'indirizzo IP front-end da usare per il servizio di bilanciamento del carico. È supportato solo l'indirizzo IP front-end IPv4. Ogni configurazione del servizio di bilanciamento del carico deve avere esattamente una configurazione IP front-end. |
LoadBalancerFrontendIpConfiguration
Specifica l'indirizzo IP front-end da usare per il servizio di bilanciamento del carico. È supportato solo l'indirizzo IP front-end IPv4. Ogni configurazione del servizio di bilanciamento del carico deve avere esattamente una configurazione IP front-end.
Nome | Tipo | Descrizione |
---|---|---|
name |
string |
Nome della risorsa univoca all'interno del set di configurazioni IP front-end usate dal servizio di bilanciamento del carico. Questo nome può essere usato per accedere alla risorsa. |
properties |
Proprietà della configurazione ip front-end del servizio di bilanciamento del carico. |
LoadBalancerFrontendIpConfigurationProperties
Descrive una configurazione IP del servizio cloud
Nome | Tipo | Descrizione |
---|---|---|
privateIPAddress |
string |
Indirizzo IP privato della rete virtuale della configurazione IP. |
publicIPAddress |
Riferimento alla risorsa indirizzo IP pubblico. |
|
subnet |
Riferimento alla risorsa subnet della rete virtuale. |
SubResource
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID risorsa |
SystemData
Metadati di sistema relativi a questa risorsa.
Nome | Tipo | Descrizione |
---|---|---|
createdAt |
string |
Specifica l'ora in formato UTC in cui è stata creata la risorsa servizio cloud (supporto esteso). |
lastModifiedAt |
string |
Specifica l'ora in formato UTC in cui la risorsa del servizio cloud (supporto esteso) è stata modificata per l'ultima volta. |