Delen via


Cloud Services - List

Hiermee haalt u een lijst op met alle cloudservices onder een resourcegroep. Gebruik de eigenschap nextLink in het antwoord om de volgende pagina van Cloud Services op te halen. Doe dit totdat nextLink null is om alle Cloud Services op te halen.

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

URI-parameters

Name In Vereist Type Description
resourceGroupName
path True

string

De naam van de resourcegroep.

subscriptionId
path True

string

Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.

api-version
query True

string

Client-API-versie.

Antwoorden

Name Type Description
200 OK

CloudServiceListResult

OK

Other Status Codes

CloudError

Fout

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

List Cloud Services in a Resource Group

Voorbeeldaanvraag

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

Voorbeeldrespons

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

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 een cloudservice-extensie.

CloudServiceExtensionProperties

Extensie-eigenschappen.

CloudServiceListResult

Het resultaat van de lijstbewerking.

CloudServiceNetworkProfile

Netwerkprofiel voor de cloudservice.

CloudServiceOsProfile

Beschrijft het besturingssysteemprofiel voor de cloudservice.

CloudServiceProperties

Eigenschappen van cloudservice

CloudServiceRoleProfile

Beschrijft het rolprofiel voor de cloudservice.

CloudServiceRoleProfileProperties

Hierin worden de roleigenschappen beschreven.

CloudServiceRoleSku

Beschrijft de SKU van de cloudservicerol.

CloudServiceSlotType

Sitetype voor de cloudservice. Mogelijke waarden zijn

Productie

Staging

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 kan handmatig worden gestart in elk updatedomein of automatisch worden gestart in alle updatedomeinen. Mogelijke waarden zijn

Automatisch

Handmatig

Gelijktijdige

Als dit niet is opgegeven, is de standaardwaarde Auto. Als dit 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 de volgorde.

CloudServiceVaultAndSecretReference

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

CloudServiceVaultCertificate

Beschrijft één certificaatreferentie in een Key Vault en waar het certificaat zich in het rolexemplaren moet bevinden.

CloudServiceVaultSecretGroup

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

Extension

Beschrijft een cloudservice-extensie.

InnerError

Details van interne fout.

LoadBalancerConfiguration

Beschrijft de configuratie van de load balancer.

LoadBalancerConfigurationProperties

Beschrijft de eigenschappen van de configuratie van de load balancer.

LoadBalancerFrontendIpConfiguration

Hiermee geeft u het ip-adres van de front-end 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

De systeemmetagegevens met betrekking tot deze resource.

ApiError

API-fout.

Name Type Description
code

string

De foutcode.

details

ApiErrorBase[]

De API-foutdetails

innererror

InnerError

De interne api-fout

message

string

Het foutbericht.

target

string

Het doel van de specifieke fout.

ApiErrorBase

API-foutbasis.

Name Type Description
code

string

De foutcode.

message

string

Het foutbericht.

target

string

Het doel van de specifieke fout.

CloudError

Een foutreactie van de Compute-service.

Name Type Description
error

ApiError

API-fout.

CloudService

Beschrijft de cloudservice.

Name Type Description
id

string

Resource-id.

location

string

Resourcelocatie.

name

string

Resourcenaam.

properties

CloudServiceProperties

Eigenschappen van cloudservice

systemData

SystemData

De systeemmetagegevens met betrekking tot deze resource.

tags

object

Resourcetags.

type

string

Resourcetype.

zones

string[]

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

CloudServiceExtensionProfile

Beschrijft een profiel voor een cloudservice-extensie.

Name Type Description
extensions

Extension[]

Lijst met extensies voor de cloudservice.

CloudServiceExtensionProperties

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 de opgegeven openbare en beveiligde instellingen geforceerd 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 van openbare of beveiligde instellingen nog steeds toegepast door de handler. Als forceUpdateTag noch een van de openbare of beveiligde instellingen wordt gewijzigd, wordt de extensie met hetzelfde volgnummer naar het rolexemplementatie geleid en is het aan de handler-implementatie of deze opnieuw moet worden uitgevoerd of niet

protectedSettings

object

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

protectedSettingsFromKeyVault

CloudServiceVaultAndSecretReference

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

provisioningState

string

De inrichtingsstatus, die alleen wordt weergegeven in het antwoord.

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 waarde een sterretje (*) wordt gebruikt, wordt de meest recente versie van de extensie gebruikt. Als de waarde is opgegeven met een primair 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 een automatische upgrade uitgevoerd op het rolexemplaren.

CloudServiceListResult

Het resultaat van de lijstbewerking.

Name Type Description
nextLink

string

De URI om de volgende pagina met resources op te halen. Gebruik dit om de volgende pagina met resources op te halen. Doe dit totdat nextLink null is om alle resources op te halen.

value

CloudService[]

De lijst met resources.

CloudServiceNetworkProfile

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

Productie

Staging

Als dit niet is opgegeven, is de standaardwaarde Productie.

swappableCloudService

SubResource

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

CloudServiceOsProfile

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

Eigenschappen van cloudservice

Name Type Description
allowModelOverride

boolean

(Optioneel) Geeft aan of de rol-SKU-eigenschappen (roleProfile.roles.sku) die zijn opgegeven in het model/sjabloon, het aantal rolinstanties en de vm-grootte die zijn opgegeven in respectievelijk de .cscfg en .csdef, moeten overschrijven. 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 een SAS-URI (Shared Access Signature) zijn van elk opslagaccount. Dit is een eigenschap alleen-schrijven en wordt niet geretourneerd in GET-aanroepen.

extensionProfile

CloudServiceExtensionProfile

Beschrijft een profiel voor een cloudservice-extensie.

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 een SAS-URI (Shared Access Signature) zijn van elk opslagaccount. Dit is een eigenschap alleen-schrijven en wordt niet geretourneerd in GET-aanroepen.

provisioningState

string

De inrichtingsstatus, die alleen wordt weergegeven in het antwoord.

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 het 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. Op dat moment wordt de service gestart. Voor een geïmplementeerde service worden nog steeds kosten in rekening gebracht, zelfs als deze uitgeschakeld is.

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 kan handmatig worden gestart in elk updatedomein of automatisch worden gestart in alle updatedomeinen. Mogelijke waarden zijn

Automatisch

Handmatig

Gelijktijdige

Als dit niet is opgegeven, is de standaardwaarde Auto. Als dit 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 de volgorde.

CloudServiceRoleProfile

Beschrijft het rolprofiel voor de cloudservice.

Name Type Description
roles

CloudServiceRoleProfileProperties[]

Lijst met rollen voor de cloudservice.

CloudServiceRoleProfileProperties

Hierin worden de roleigenschappen beschreven.

Name Type Description
name

string

Resourcenaam.

sku

CloudServiceRoleSku

Beschrijft de SKU van de cloudservicerol.

CloudServiceRoleSku

Beschrijft de SKU van de cloudservicerol.

Name Type Description
capacity

integer

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 op. Mogelijke waarden zijn

Standard

Basic

CloudServiceSlotType

Sitetype voor de cloudservice. Mogelijke waarden zijn

Productie

Staging

Als dit niet is opgegeven, is de standaardwaarde Productie.

Name Type Description
Production

string

Staging

string

CloudServiceUpgradeMode

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

Automatisch

Handmatig

Gelijktijdige

Als dit niet is opgegeven, is de standaardwaarde Auto. Als dit 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 de volgorde.

Name Type Description
Auto

string

Manual

string

Simultaneous

string

CloudServiceVaultAndSecretReference

Beveiligde instellingen voor de extensie, waarnaar wordt verwezen met Behulp van 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 Key Vault

CloudServiceVaultCertificate

Beschrijft één certificaatreferentie in een Key Vault en waar het certificaat zich in het rolexemplaren moet bevinden.

Name Type Description
certificateUrl

string

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

CloudServiceVaultSecretGroup

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

Name Type Description
sourceVault

SubResource

De relatieve URL van de Key Vault met alle certificaten in VaultCertificates.

vaultCertificates

CloudServiceVaultCertificate[]

De lijst met sleutelkluisverwijzingen in SourceVault die certificaten bevatten.

Extension

Beschrijft een cloudservice-extensie.

Name Type Description
name

string

De naam van de extensie.

properties

CloudServiceExtensionProperties

Extensie-eigenschappen.

InnerError

Details van interne fout.

Name Type Description
errordetail

string

Het interne foutbericht of de uitzonderingsdump.

exceptiontype

string

Het uitzonderingstype.

LoadBalancerConfiguration

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

Beschrijft de eigenschappen van de configuratie van de load balancer.

Name Type Description
frontendIpConfigurations

LoadBalancerFrontendIpConfiguration[]

Hiermee geeft u het ip-adres van de front-end 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

Hiermee geeft u het ip-adres van de front-end 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 wordt gebruikt. Deze naam kan worden gebruikt voor toegang tot de resource.

properties

LoadBalancerFrontendIpConfigurationProperties

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

LoadBalancerFrontendIpConfigurationProperties

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 resource van het openbare IP-adres.

subnet

SubResource

De verwijzing naar de subnetresource van het virtuele netwerk.

SubResource

Name Type Description
id

string

Resource-id

SystemData

De systeemmetagegevens met betrekking tot deze resource.

Name Type Description
createdAt

string

Hiermee geeft u de tijd in UTC op waarop de cloudserviceresource (uitgebreide ondersteuning) is gemaakt.
Minimale API-versie: 2022-04-04.

lastModifiedAt

string

Hiermee geeft u de tijd in UTC op waarop de cloudserviceresource (uitgebreide ondersteuning) voor het laatst is gewijzigd.
Minimale API-versie: 2022-04-04.