Dela via


Cloud Services - List

Hämtar en lista över alla molntjänster under en resursgrupp. Använd egenskapen nextLink i svaret för att hämta nästa sida i Cloud Services. Gör detta tills nextLink är null för att hämta alla Cloud Services.

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
path True

string

Resursgruppens namn.

subscriptionId
path True

string

Autentiseringsuppgifter för prenumeration som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.

api-version
query True

string

Klient-API-version.

Svar

Name Typ Description
200 OK

CloudServiceListResult

OK

Other Status Codes

CloudError

Fel

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

List Cloud Services in a Resource Group

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
ApiError

API-fel.

ApiErrorBase

Api-felbas.

CloudError

Ett felsvar från Beräkningstjänsten.

CloudService

Beskriver molntjänsten.

CloudServiceExtensionProfile

Beskriver en profil för molntjänsttillägg.

CloudServiceExtensionProperties

Tilläggsegenskaper.

CloudServiceListResult

Resultatet av liståtgärden.

CloudServiceNetworkProfile

Nätverksprofil för molntjänsten.

CloudServiceOsProfile

Beskriver os-profilen för molntjänsten.

CloudServiceProperties

Molntjänstegenskaper

CloudServiceRoleProfile

Beskriver rollprofilen för molntjänsten.

CloudServiceRoleProfileProperties

Beskriver rollegenskaperna.

CloudServiceRoleSku

Beskriver molntjänstrollens SKU.

CloudServiceSlotType

Facktyp för molntjänsten. Möjliga värden är

Produktion

Mellanlagring

Om inget värde anges är standardvärdet Produktion.

CloudServiceUpgradeMode

Uppdateringsläge för molntjänsten. Rollinstanser allokeras för att uppdatera domäner när tjänsten distribueras. Uppdateringar kan initieras manuellt i varje uppdateringsdomän eller initieras automatiskt i alla uppdateringsdomäner. Möjliga värden är

Automatisk

Manuell

Samtidiga

Om det inte anges är standardvärdet Auto. Om inställningen är Manuell måste PUT UpdateDomain anropas för att tillämpa uppdateringen. Om inställningen är Automatisk tillämpas uppdateringen automatiskt på varje uppdateringsdomän i följd.

CloudServiceVaultAndSecretReference

Skyddade inställningar för tillägget, som refereras med KeyVault som krypteras innan de skickas till rollinstansen.

CloudServiceVaultCertificate

Beskriver en enda certifikatreferens i en Key Vault och var certifikatet ska finnas på rollinstansen.

CloudServiceVaultSecretGroup

Beskriver en uppsättning certifikat som alla finns i samma Key Vault.

Extension

Beskriver ett molntjänsttillägg.

InnerError

Inre felinformation.

LoadBalancerConfiguration

Beskriver lastbalanserarens konfiguration.

LoadBalancerConfigurationProperties

Beskriver egenskaperna för lastbalanserarens konfiguration.

LoadBalancerFrontendIpConfiguration

Anger klientdelens IP-adress som ska användas för lastbalanseraren. Endast IP-adressen för IPv4-klientdelen stöds. Varje konfiguration av lastbalanseraren måste ha exakt en IP-konfiguration för klientdelen.

LoadBalancerFrontendIpConfigurationProperties

Beskriver en IP-konfiguration för molntjänsten

SubResource
SystemData

Systemmetadata som relaterar till den här resursen.

ApiError

API-fel.

Name Typ Description
code

string

Felkoden.

details

ApiErrorBase[]

Api-felinformationen

innererror

InnerError

Api:ets inre fel

message

string

Felmeddelandet.

target

string

Målet för det specifika felet.

ApiErrorBase

Api-felbas.

Name Typ Description
code

string

Felkoden.

message

string

Felmeddelandet.

target

string

Målet för det specifika felet.

CloudError

Ett felsvar från Beräkningstjänsten.

Name Typ Description
error

ApiError

API-fel.

CloudService

Beskriver molntjänsten.

Name Typ Description
id

string

Resurs-ID.

location

string

Resursplats.

name

string

Resursnamn.

properties

CloudServiceProperties

Molntjänstegenskaper

systemData

SystemData

Systemmetadata som relaterar till den här resursen.

tags

object

Resurstaggar.

type

string

Resurstyp.

zones

string[]

Lista över resursens logiska tillgänglighetszon. Listan bör endast innehålla 1 zon där molntjänsten ska etableras. Det här fältet är valfritt.

CloudServiceExtensionProfile

Beskriver en profil för molntjänsttillägg.

Name Typ Description
extensions

Extension[]

Lista över tillägg för molntjänsten.

CloudServiceExtensionProperties

Tilläggsegenskaper.

Name Typ Description
autoUpgradeMinorVersion

boolean

Ange uttryckligen om plattformen automatiskt kan uppgradera typeHandlerVersion till högre delversioner när de blir tillgängliga.

forceUpdateTag

string

Tagg för att framtvinga de angivna offentliga och skyddade inställningarna. Om du ändrar taggvärdet kan du köra tillägget igen utan att ändra någon av de offentliga eller skyddade inställningarna. Om forceUpdateTag inte ändras tillämpas uppdateringar av offentliga eller skyddade inställningar fortfarande av hanteraren. Om varken forceUpdateTag eller någon av de offentliga eller skyddade inställningarna ändras flödar tillägget till rollinstansen med samma sekvensnummer, och det är upp till hanterarimplementeringen om den ska köras igen eller inte

protectedSettings

object

Skyddade inställningar för tillägget som krypteras innan de skickas till rollinstansen.

protectedSettingsFromKeyVault

CloudServiceVaultAndSecretReference

Skyddade inställningar för tillägget, som refereras med KeyVault som krypteras innan de skickas till rollinstansen.

provisioningState

string

Etableringstillståndet, som bara visas i svaret.

publisher

string

Namnet på tilläggshanterarutgivaren.

rolesAppliedTo

string[]

Valfri lista över roller för att tillämpa det här tillägget. Om egenskapen inte har angetts eller om *har angetts tillämpas tillägget på alla roller i molntjänsten.

settings

object

Offentliga inställningar för tillägget. För JSON-tillägg är detta JSON-inställningarna för tillägget. För XML-tillägg (till exempel RDP) är detta XML-inställningen för tillägget.

type

string

Anger filnamnstilläggets typ.

typeHandlerVersion

string

Anger versionen av tillägget. Anger versionen av tillägget. Om det här elementet inte har angetts eller om en asterisk (*) används som värde används den senaste versionen av tillägget. Om värdet anges med ett huvudversionsnummer och en asterisk som delversionsnummer (X) väljs den senaste delversionen av den angivna huvudversionen. Om ett huvudversionsnummer och ett lägre versionsnummer anges (X.Y) väljs den specifika tilläggsversionen. Om en version anges utförs en automatisk uppgradering på rollinstansen.

CloudServiceListResult

Resultatet av liståtgärden.

Name Typ Description
nextLink

string

URI:n för att hämta nästa sida med resurser. Använd detta för att hämta nästa sida med resurser. Gör detta tills nextLink är null för att hämta alla resurser.

value

CloudService[]

Listan över resurser.

CloudServiceNetworkProfile

Nätverksprofil för molntjänsten.

Name Typ Description
loadBalancerConfigurations

LoadBalancerConfiguration[]

Lista över konfigurationer för lastbalanserare. Molntjänsten kan ha upp till två lastbalanseringskonfigurationer som motsvarar en offentlig Load Balancer och en intern Load Balancer.

slotType

CloudServiceSlotType

Facktyp för molntjänsten. Möjliga värden är

Produktion

Mellanlagring

Om det inte anges är standardvärdet Produktion.

swappableCloudService

SubResource

ID-referensen för molntjänsten som innehåller mål-IP-adressen som ämnesmolntjänsten kan utföra en växling med. Det går inte att uppdatera den här egenskapen när den har angetts. Den utbytbara molntjänsten som det här ID:t refererar till måste finnas, annars utlöses ett fel.

CloudServiceOsProfile

Beskriver os-profilen för molntjänsten.

Name Typ Description
secrets

CloudServiceVaultSecretGroup[]

Anger en uppsättning certifikat som ska installeras på rollinstanserna.

CloudServiceProperties

Molntjänstegenskaper

Name Typ Description
allowModelOverride

boolean

(Valfritt) Anger om roll-sku-egenskaperna (roleProfile.roles.sku) som anges i modellen/mallen ska åsidosätta antalet rollinstanser och vm-storleken som anges i .cscfg respektive .csdef. Standardvärdet är false.

configuration

string

Anger XML-tjänstkonfigurationen (.cscfg) för molntjänsten.

configurationUrl

string

Anger en URL som refererar till platsen för tjänstkonfigurationen i Blob-tjänsten. Url:en för tjänstpaket kan vara SAS-URI (Signatur för delad åtkomst) från valfritt lagringskonto. Det här är en skrivskyddad egenskap och returneras inte i GET-anrop.

extensionProfile

CloudServiceExtensionProfile

Beskriver en profil för molntjänsttillägg.

networkProfile

CloudServiceNetworkProfile

Nätverksprofil för molntjänsten.

osProfile

CloudServiceOsProfile

Beskriver os-profilen för molntjänsten.

packageUrl

string

Anger en URL som refererar till platsen för tjänstpaketet i Blob-tjänsten. Url:en för tjänstpaket kan vara SAS-URI (Signatur för delad åtkomst) från valfritt lagringskonto. Det här är en skrivskyddad egenskap och returneras inte i GET-anrop.

provisioningState

string

Etableringstillståndet, som bara visas i svaret.

roleProfile

CloudServiceRoleProfile

Beskriver rollprofilen för molntjänsten.

startCloudService

boolean

(Valfritt) Anger om molntjänsten ska startas omedelbart efter att den har skapats. Standardvärdet är true. Om det är falskt distribueras fortfarande tjänstmodellen, men koden körs inte omedelbart. I stället är tjänsten PoweredOff tills du anropar Start, då tjänsten startas. En distribuerad tjänst debiteras fortfarande, även om den är avstängd.

uniqueId

string

Den unika identifieraren för molntjänsten.

upgradeMode

CloudServiceUpgradeMode

Uppdateringsläge för molntjänsten. Rollinstanser allokeras för att uppdatera domäner när tjänsten distribueras. Uppdateringar kan initieras manuellt i varje uppdateringsdomän eller initieras automatiskt i alla uppdateringsdomäner. Möjliga värden är

Automatisk

Manuell

Samtidiga

Om det inte anges är standardvärdet Auto. Om inställningen är Manuell måste PUT UpdateDomain anropas för att tillämpa uppdateringen. Om inställningen är Automatisk tillämpas uppdateringen automatiskt på varje uppdateringsdomän i följd.

CloudServiceRoleProfile

Beskriver rollprofilen för molntjänsten.

Name Typ Description
roles

CloudServiceRoleProfileProperties[]

Lista över roller för molntjänsten.

CloudServiceRoleProfileProperties

Beskriver rollegenskaperna.

Name Typ Description
name

string

Resursnamn.

sku

CloudServiceRoleSku

Beskriver molntjänstrollens SKU.

CloudServiceRoleSku

Beskriver molntjänstrollens SKU.

Name Typ Description
capacity

integer

Anger antalet rollinstanser i molntjänsten.

name

string

SKU-namnet. Obs! Om den nya SKU:n inte stöds på maskinvaran som molntjänsten för närvarande är på, måste du ta bort och återskapa molntjänsten eller gå tillbaka till den gamla SKU:n.

tier

string

Anger molntjänstens nivå. Möjliga värden är

Standard

Basic

CloudServiceSlotType

Facktyp för molntjänsten. Möjliga värden är

Produktion

Mellanlagring

Om inget värde anges är standardvärdet Produktion.

Name Typ Description
Production

string

Staging

string

CloudServiceUpgradeMode

Uppdateringsläge för molntjänsten. Rollinstanser allokeras för att uppdatera domäner när tjänsten distribueras. Uppdateringar kan initieras manuellt i varje uppdateringsdomän eller initieras automatiskt i alla uppdateringsdomäner. Möjliga värden är

Automatisk

Manuell

Samtidiga

Om det inte anges är standardvärdet Auto. Om inställningen är Manuell måste PUT UpdateDomain anropas för att tillämpa uppdateringen. Om inställningen är Automatisk tillämpas uppdateringen automatiskt på varje uppdateringsdomän i följd.

Name Typ Description
Auto

string

Manual

string

Simultaneous

string

CloudServiceVaultAndSecretReference

Skyddade inställningar för tillägget, som refereras med KeyVault som krypteras innan de skickas till rollinstansen.

Name Typ Description
secretUrl

string

Hemlig URL som innehåller de skyddade inställningarna för tillägget

sourceVault

SubResource

ARM-resurs-ID för Key Vault

CloudServiceVaultCertificate

Beskriver en enda certifikatreferens i en Key Vault och var certifikatet ska finnas på rollinstansen.

Name Typ Description
certificateUrl

string

Det här är URL:en för ett certifikat som har laddats upp till Key Vault som en hemlighet.

CloudServiceVaultSecretGroup

Beskriver en uppsättning certifikat som alla finns i samma Key Vault.

Name Typ Description
sourceVault

SubResource

Den relativa URL:en för Key Vault som innehåller alla certifikat i VaultCertificates.

vaultCertificates

CloudServiceVaultCertificate[]

Listan över key vault-referenser i SourceVault som innehåller certifikat.

Extension

Beskriver ett molntjänsttillägg.

Name Typ Description
name

string

Namnet på tillägget.

properties

CloudServiceExtensionProperties

Tilläggsegenskaper.

InnerError

Inre felinformation.

Name Typ Description
errordetail

string

Det interna felmeddelandet eller undantagsdumpen.

exceptiontype

string

Undantagstypen.

LoadBalancerConfiguration

Beskriver lastbalanserarens konfiguration.

Name Typ Description
id

string

Resurs-ID

name

string

Namnet på lastbalanseraren

properties

LoadBalancerConfigurationProperties

Egenskaper för lastbalanserarens konfiguration.

LoadBalancerConfigurationProperties

Beskriver egenskaperna för lastbalanserarens konfiguration.

Name Typ Description
frontendIpConfigurations

LoadBalancerFrontendIpConfiguration[]

Anger klientdelens IP-adress som ska användas för lastbalanseraren. Endast IP-adressen för IPv4-klientdelen stöds. Varje konfiguration av lastbalanseraren måste ha exakt en IP-konfiguration för klientdelen.

LoadBalancerFrontendIpConfiguration

Anger klientdelens IP-adress som ska användas för lastbalanseraren. Endast IP-adressen för IPv4-klientdelen stöds. Varje konfiguration av lastbalanseraren måste ha exakt en IP-konfiguration för klientdelen.

Name Typ Description
name

string

Namnet på resursen som är unik inom uppsättningen ip-konfigurationer för klientdelen som används av lastbalanseraren. Det här namnet kan användas för att komma åt resursen.

properties

LoadBalancerFrontendIpConfigurationProperties

Egenskaper för ip-konfiguration för lastbalanserarens klientdel.

LoadBalancerFrontendIpConfigurationProperties

Beskriver en IP-konfiguration för molntjänsten

Name Typ Description
privateIPAddress

string

Det virtuella nätverkets privata IP-adress för IP-konfigurationen.

publicIPAddress

SubResource

Referensen till den offentliga IP-adressresursen.

subnet

SubResource

Referensen till undernätsresursen för det virtuella nätverket.

SubResource

Name Typ Description
id

string

Resurs-ID

SystemData

Systemmetadata som relaterar till den här resursen.

Name Typ Description
createdAt

string

Anger den tid i UTC då molntjänstresursen (utökad support) skapades.
Lägsta API-version: 2022-04-04.

lastModifiedAt

string

Anger den tid i UTC då molntjänstresursen (utökad support) senast ändrades.
Lägsta API-version: 2022-04-04.