Delen via

Cloud Services - Get

Service:
Compute
API-versie:
2024-11-04

Informatie weergeven over een cloudservice.

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

URI-parameters

Name In Vereist Type Description
cloudServiceName
 path True

string

Naam van de cloudservice.
resourceGroupName
 path True

string

De naam van de hulpmiddelengroep.
subscriptionId
 path True

string

Abonnementsreferenties die het Microsoft Azure-abonnement uniek identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version
 query True

string

Client-API-versie.

Antwoorden

Name Type Description
200 OK

CloudService

OK
Other Status Codes

CloudError

Fout

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

Get Cloud Service with Multiple Roles and RDP Extension

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
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"
  }
}

Definities

Name Description
ApiError

Api-fout.
ApiErrorBase

Api-foutbasis.
CloudError

Een foutreactie van de Compute-service.
CloudService

Beschrijft de cloudservice.
CloudServiceExtensionProfile

Beschrijft een profiel voor cloudservice-extensies.
CloudServiceExtensionProperties

Extensie-eigenschappen.
CloudServiceNetworkProfile

Netwerkprofiel voor de cloudservice.
CloudServiceOsProfile

Beschrijft het besturingssysteemprofiel voor de cloudservice.
CloudServiceProperties

Eigenschappen van cloudservice
CloudServiceRoleProfile

Beschrijft het rolprofiel voor de cloudservice.
CloudServiceRoleProfileProperties

Beschrijft de roleigenschappen.
CloudServiceRoleSku

Hierin wordt de SKU van de cloudservicerol beschreven.
CloudServiceSlotType

Sitetype voor de cloudservice. Mogelijke waarden zijn

Production-

faserings

Als dit niet is opgegeven, is de standaardwaarde Productie.
CloudServiceUpgradeMode

Updatemodus voor de cloudservice. Rolinstanties worden toegewezen aan updatedomeinen wanneer de service wordt geïmplementeerd. Updates kunnen handmatig worden gestart in elk updatedomein of automatisch worden gestart in alle updatedomeinen. Mogelijke waarden zijn

Auto

Handmatig

gelijktijdige

Als dit niet is opgegeven, is de standaardwaarde Automatisch. Als deze optie is ingesteld op Handmatig, moet PUT UpdateDomain worden aangeroepen om de update toe te passen. Als deze optie is ingesteld op Automatisch, wordt de update automatisch toegepast op elk updatedomein in volgorde.
CloudServiceVaultAndSecretReference

Beveiligde instellingen voor de extensie, waarnaar wordt verwezen met KeyVault, die zijn versleuteld voordat ze naar het rolexemplaren worden verzonden.
CloudServiceVaultCertificate

Beschrijft één certificaatverwijzing in een sleutelkluis en waar het certificaat zich op het rolexemplaar moet bevinden.
CloudServiceVaultSecretGroup

Beschrijft een set certificaten die zich allemaal in dezelfde Key Vault bevinden.
createdByType

Het type identiteit waarmee de resource is gemaakt.
Extension

Beschrijft een cloudservice-extensie.
InnerError

Interne foutdetails.
LoadBalancerConfiguration

Beschrijft de configuratie van de load balancer.
LoadBalancerConfigurationProperties

Beschrijft de eigenschappen van de configuratie van de load balancer.
LoadBalancerFrontendIpConfiguration

Hiermee geeft u het front-end-IP-adres moet worden gebruikt voor de load balancer. Alleen IPv4-front-end-IP-adres wordt ondersteund. Elke load balancer-configuratie moet precies één front-end-IP-configuratie hebben.
LoadBalancerFrontendIpConfigurationProperties

Beschrijft een IP-configuratie van een cloudservice
SubResource
systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

ApiError

Object

Api-fout.

Name Type Description
code

string

De foutcode.
details

ApiErrorBase[]

Details van de Api-fout
innererror

InnerError

De innerlijke fout van de Api
message

string

Het foutbericht.
target

string

Het doel van de specifieke fout.

ApiErrorBase

Object

Api-foutbasis.

Name Type Description
code

string

De foutcode.
message

string

Het foutbericht.
target

string

Het doel van de specifieke fout.

CloudError

Object

Een foutreactie van de Compute-service.

Name Type Description
error

ApiError

Api-fout.

CloudService

Object

Beschrijft de cloudservice.

Name Type Description
id

string

Resource-id.
location

string

Resourcelocatie.
name

string

Resourcenaam.
properties

CloudServiceProperties

Eigenschappen van cloudservice
systemData

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
tags

object

Resourcetags.
type

string

Type bron
zones

string[]

Lijst met logische beschikbaarheidszone van de resource. De lijst mag slechts één zone bevatten waarin de cloudservice moet worden ingericht. Dit veld is optioneel.

CloudServiceExtensionProfile

Object

Beschrijft een profiel voor cloudservice-extensies.

Name Type Description
extensions

Extension[]

Lijst met extensies voor de cloudservice.

CloudServiceExtensionProperties

Object

Extensie-eigenschappen.

Name Type Description
autoUpgradeMinorVersion

boolean

Geef expliciet op of het platform typeHandlerVersion automatisch kan upgraden naar hogere secundaire versies wanneer deze beschikbaar komen.
forceUpdateTag

string

Tag om af te dwingen de opgegeven openbare en beveiligde instellingen toe te passen. Als u de tagwaarde wijzigt, kunt u de extensie opnieuw uitvoeren zonder de openbare of beveiligde instellingen te wijzigen. Als forceUpdateTag niet wordt gewijzigd, worden updates voor openbare of beveiligde instellingen nog steeds toegepast door de handler. Als noch forceUpdateTag, noch een van de openbare of beveiligde instellingen verandert, stroomt de extensie naar de rolinstantie met hetzelfde volgnummer en is het aan de implementatie van de handler om deze al dan niet opnieuw uit te voeren
protectedSettings

object

Beveiligde instellingen voor de extensie die worden versleuteld voordat ze naar het rolexemplaren worden verzonden.
protectedSettingsFromKeyVault

CloudServiceVaultAndSecretReference

Beveiligde instellingen voor de extensie, waarnaar wordt verwezen met KeyVault, die zijn versleuteld voordat ze naar het rolexemplaren worden verzonden.
provisioningState

string

De inrichtingsstatus, die alleen in het antwoord wordt weergegeven.
publisher

string

De naam van de uitgever van de extensie-handler.
rolesAppliedTo

string[]

Optionele lijst met rollen om deze extensie toe te passen. Als de eigenschap niet is opgegeven of '*' is opgegeven, wordt de extensie toegepast op alle rollen in de cloudservice.
settings

object

Openbare instellingen voor de extensie. Voor JSON-extensies zijn dit de JSON-instellingen voor de extensie. Voor XML-extensie (zoals RDP) is dit de XML-instelling voor de extensie.
type

string

Hiermee geeft u het type van de extensie.
typeHandlerVersion

string

Hiermee geeft u de versie van de extensie. Hiermee geeft u de versie van de extensie. Als dit element niet is opgegeven of als een sterretje (*) wordt gebruikt als de waarde, wordt de nieuwste versie van de extensie gebruikt. Als de waarde wordt opgegeven met een primaire versienummer en een sterretje als het secundaire versienummer (X.), wordt de meest recente secundaire versie van de opgegeven primaire versie geselecteerd. Als een primair versienummer en een secundair versienummer zijn opgegeven (X.Y), wordt de specifieke extensieversie geselecteerd. Als er een versie is opgegeven, wordt er een automatische upgrade uitgevoerd op het rolexemplaren.

CloudServiceNetworkProfile

Object

Netwerkprofiel voor de cloudservice.

Name Type Description
loadBalancerConfigurations

LoadBalancerConfiguration[]

Lijst met load balancer-configuraties. Cloudservice kan maximaal twee load balancer-configuraties hebben, die overeenkomen met een openbare load balancer en een interne load balancer.
slotType

CloudServiceSlotType

Sitetype voor de cloudservice. Mogelijke waarden zijn

Production-

faserings

Als dit niet is opgegeven, is de standaardwaarde Productie.
swappableCloudService

SubResource

De id-verwijzing van de cloudservice met het doel-IP-adres waarmee de onderwerpcloudservice een wissel kan uitvoeren. Deze eigenschap kan niet worden bijgewerkt zodra deze is ingesteld. De wisselbare cloudservice waarnaar wordt verwezen door deze id moet aanwezig zijn, anders wordt er een fout gegenereerd.

CloudServiceOsProfile

Object

Beschrijft het besturingssysteemprofiel voor de cloudservice.

Name Type Description
secrets

CloudServiceVaultSecretGroup[]

Hiermee geeft u een set certificaten op die moeten worden geïnstalleerd op de rolinstanties.

CloudServiceProperties

Object

Eigenschappen van cloudservice

Name Type Description
allowModelOverride

boolean

(Optioneel) Geeft aan of de eigenschappen van de rol-sKU (roleProfile.roles.sku) die zijn opgegeven in het model/de sjabloon, het aantal rollenexemplaren en de VM-grootte moeten overschrijven die zijn opgegeven in respectievelijk de .cscfg en .csdef. De standaardwaarde is false.
configuration

string

Hiermee geeft u de XML-serviceconfiguratie (.cscfg) voor de cloudservice op.
configurationUrl

string

Hiermee geeft u een URL op die verwijst naar de locatie van de serviceconfiguratie in de Blob-service. De URL van het servicepakket kan sas-URI (Shared Access Signature) zijn vanuit elk opslagaccount. Dit is een alleen-schrijven-eigenschap en wordt niet geretourneerd in GET-aanroepen.
extensionProfile

CloudServiceExtensionProfile

Beschrijft een profiel voor cloudservice-extensies.
networkProfile

CloudServiceNetworkProfile

Netwerkprofiel voor de cloudservice.
osProfile

CloudServiceOsProfile

Beschrijft het besturingssysteemprofiel voor de cloudservice.
packageUrl

string

Hiermee geeft u een URL op die verwijst naar de locatie van het servicepakket in de Blob-service. De URL van het servicepakket kan sas-URI (Shared Access Signature) zijn vanuit elk opslagaccount. Dit is een alleen-schrijven-eigenschap en wordt niet geretourneerd in GET-aanroepen.
provisioningState

string

De inrichtingsstatus, die alleen in het antwoord wordt weergegeven.
roleProfile

CloudServiceRoleProfile

Beschrijft het rolprofiel voor de cloudservice.
startCloudService

boolean

(Optioneel) Hiermee wordt aangegeven of de cloudservice direct nadat deze is gemaakt, moet worden gestart. De standaardwaarde is true. Als dit onwaar is, wordt het servicemodel nog steeds geïmplementeerd, maar wordt de code niet onmiddellijk uitgevoerd. In plaats daarvan is de service PoweredOff totdat u Start aanroept, waarna de service wordt gestart. Voor een geïmplementeerde service worden nog steeds kosten in rekening gebracht, zelfs als deze wordt uitgeschakeld.
uniqueId

string

De unieke ID voor de cloudservice.
upgradeMode

CloudServiceUpgradeMode

Updatemodus voor de cloudservice. Rolinstanties worden toegewezen aan updatedomeinen wanneer de service wordt geïmplementeerd. Updates kunnen handmatig worden gestart in elk updatedomein of automatisch worden gestart in alle updatedomeinen. Mogelijke waarden zijn

Auto

Handmatig

gelijktijdige

Als dit niet is opgegeven, is de standaardwaarde Automatisch. Als deze optie is ingesteld op Handmatig, moet PUT UpdateDomain worden aangeroepen om de update toe te passen. Als deze optie is ingesteld op Automatisch, wordt de update automatisch toegepast op elk updatedomein in volgorde.

CloudServiceRoleProfile

Object

Beschrijft het rolprofiel voor de cloudservice.

Name Type Description
roles

CloudServiceRoleProfileProperties[]

Lijst met rollen voor de cloudservice.

CloudServiceRoleProfileProperties

Object

Beschrijft de roleigenschappen.

Name Type Description
name

string

Resourcenaam.
sku

CloudServiceRoleSku

Hierin wordt de SKU van de cloudservicerol beschreven.

CloudServiceRoleSku

Object

Hierin wordt de SKU van de cloudservicerol beschreven.

Name Type Description
capacity

integer (int64)

Hiermee geeft u het aantal rolinstanties in de cloudservice op.
name

string

De SKU-naam. OPMERKING: Als de nieuwe SKU niet wordt ondersteund op de hardware waarop de cloudservice zich momenteel bevindt, moet u de cloudservice verwijderen en opnieuw maken of terugkeren naar de oude SKU.
tier

string

Hiermee geeft u de laag van de cloudservice. Mogelijke waarden zijn

Standard

Basic

CloudServiceSlotType

Opsomming

Sitetype voor de cloudservice. Mogelijke waarden zijn

Production-

faserings

Als dit niet is opgegeven, is de standaardwaarde Productie.

Waarde Description
Production
Staging

CloudServiceUpgradeMode

Opsomming

Updatemodus voor de cloudservice. Rolinstanties worden toegewezen aan updatedomeinen wanneer de service wordt geïmplementeerd. Updates kunnen handmatig worden gestart in elk updatedomein of automatisch worden gestart in alle updatedomeinen. Mogelijke waarden zijn

Auto

Handmatig

gelijktijdige

Als dit niet is opgegeven, is de standaardwaarde Automatisch. Als deze optie is ingesteld op Handmatig, moet PUT UpdateDomain worden aangeroepen om de update toe te passen. Als deze optie is ingesteld op Automatisch, wordt de update automatisch toegepast op elk updatedomein in volgorde.

Waarde Description
Auto
Manual
Simultaneous

CloudServiceVaultAndSecretReference

Object

Beveiligde instellingen voor de extensie, waarnaar wordt verwezen met KeyVault, die zijn versleuteld voordat ze naar het rolexemplaren worden verzonden.

Name Type Description
secretUrl

string

Geheime URL die de beveiligde instellingen van de extensie bevat
sourceVault

SubResource

De ARM-resource-id van de sleutelkluis

CloudServiceVaultCertificate

Object

Beschrijft één certificaatverwijzing in een sleutelkluis en waar het certificaat zich op het rolexemplaar moet bevinden.

Name Type Description
certificateUrl

string

Dit is de URL van een certificaat dat als geheim is geüpload naar Key Vault.
isBootstrapCertificate

boolean

Vlag die aangeeft of het opgegeven certificaat een bootstrapcertificaat is dat moet worden gebruikt door de Key Vault-extensie om de resterende certificaten op te halen.

CloudServiceVaultSecretGroup

Object

Beschrijft een set certificaten die zich allemaal in dezelfde Key Vault bevinden.

Name Type Description
sourceVault

SubResource

De relatieve URL van de Sleutelkluis met alle certificaten in VaultCertificates.
vaultCertificates

CloudServiceVaultCertificate[]

De lijst met sleutelkluisverwijzingen in SourceVault die certificaten bevatten.

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde Description
User
Application
ManagedIdentity
Key

Extension

Object

Beschrijft een cloudservice-extensie.

Name Type Description
name

string

De naam van de extensie.
properties

CloudServiceExtensionProperties

Extensie-eigenschappen.

InnerError

Object

Interne foutdetails.

Name Type Description
errordetail

string

De interne foutmelding of uitzonderingsdump.
exceptiontype

string

Het uitzonderingstype.

LoadBalancerConfiguration

Object

Beschrijft de configuratie van de load balancer.

Name Type Description
id

string

Resource-id
name

string

De naam van de load balancer
properties

LoadBalancerConfigurationProperties

Eigenschappen van de configuratie van de load balancer.

LoadBalancerConfigurationProperties

Object

Beschrijft de eigenschappen van de configuratie van de load balancer.

Name Type Description
frontendIpConfigurations

LoadBalancerFrontendIpConfiguration[]

Hiermee geeft u het front-end-IP-adres moet worden gebruikt voor de load balancer. Alleen IPv4-front-end-IP-adres wordt ondersteund. Elke load balancer-configuratie moet precies één front-end-IP-configuratie hebben.

LoadBalancerFrontendIpConfiguration

Object

Hiermee geeft u het front-end-IP-adres moet worden gebruikt voor de load balancer. Alleen IPv4-front-end-IP-adres wordt ondersteund. Elke load balancer-configuratie moet precies één front-end-IP-configuratie hebben.

Name Type Description
name

string

De naam van de resource die uniek is binnen de set front-end-IP-configuraties die door de load balancer worden gebruikt. Deze naam kan worden gebruikt voor toegang tot de resource.
properties

LoadBalancerFrontendIpConfigurationProperties

Eigenschappen van front-end-IP-configuratie van load balancer.

LoadBalancerFrontendIpConfigurationProperties

Object

Beschrijft een IP-configuratie van een cloudservice

Name Type Description
privateIPAddress

string

Het privé-IP-adres van het virtuele netwerk van de IP-configuratie.
publicIPAddress

SubResource

De verwijzing naar de openbare IP-adresresource.
subnet

SubResource

De verwijzing naar de subnetresource van het virtuele netwerk.

SubResource

Object
Name Type Description
id

string

Resource-id

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name Type Description
createdAt

string (date-time)

De tijdstempel van het maken van resources (UTC).
createdBy

string

De identiteit waarmee de resource is gemaakt.
createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt

string (date-time)

De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy

string

De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType

createdByType

Het type identiteit dat de resource voor het laatst heeft gewijzigd.