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-04-04

URI-parametrar

Name In Required Type Description
resourceGroupName
path True
  • string

Resursgruppens namn.

subscriptionId
path True
  • string

Prenumerationsautentiseringsuppgifter 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 Type Description
200 OK

OK

Other Status Codes

Fel

Säkerhet

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 personifiera ditt användarkonto

Exempel

List Cloud Services in a Resource Group

Sample Request

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

Sample Response

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

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

Iscensättning

Om det inte anges är standardvärdet Produktion.

CloudServiceUpgradeMode

Uppdateringsläge för molntjänsten. Rollinstanser allokeras till uppdateringsdomä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 Automatiskt. Om värdet är Manuellt måste PUT UpdateDomain anropas för att tillämpa uppdateringen. Om den ställs in på Auto 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 lastbalanserares konfiguration måste ha exakt en IP-konfiguration för klientdelen.

LoadBalancerFrontendIPConfigurationProperties

Beskriver en IP-konfiguration för molntjänsten

SubResource
SystemData

Systemmetadata som är relaterade till den här resursen.

ApiError

API-fel.

Name Type Description
code
  • string

Felkoden.

details

Api-felinformationen

innererror

Api:ets inre fel

message
  • string

Felmeddelandet.

target
  • string

Målet för det specifika felet.

ApiErrorBase

Api-felbas.

Name Type 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 Type Description
error

API-fel.

CloudService

Beskriver molntjänsten.

Name Type Description
id
  • string

Resurs-ID.

location
  • string

Resursplats.

name
  • string

Resursnamn.

properties

Molntjänstegenskaper

systemData

Systemmetadata som är relaterade till den här resursen.

tags
  • object

Resurstaggar.

type
  • string

Resurstyp.

CloudServiceExtensionProfile

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

Name Type Description
extensions

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

CloudServiceExtensionProperties

Tilläggsegenskaper.

Name Type 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 på nytt eller inte

protectedSettings
  • object

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

protectedSettingsFromKeyVault

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äggshanterarens utgivare.

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 delversionsnummer 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 Type 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

Listan över resurser.

CloudServiceNetworkProfile

Nätverksprofil för molntjänsten.

Name Type Description
loadBalancerConfigurations

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

slotType

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

Produktion

Iscensättning

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

swappableCloudService

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

CloudServiceOsProfile

Beskriver os-profilen för molntjänsten.

Name Type Description
secrets

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

CloudServiceProperties

Molntjänstegenskaper

Name Type 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 Service. Url:en för tjänstpaketet kan vara URI för signatur för delad åtkomst (SAS) från valfritt lagringskonto. Det här är en skrivskyddad egenskap och returneras inte i GET-anrop.

extensionProfile

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

networkProfile

Nätverksprofil för molntjänsten.

osProfile

Beskriver os-profilen för molntjänsten.

packageUrl
  • string

Anger en URL som refererar till platsen för tjänstpaketet i Blob Service. Url:en för tjänstpaketet kan vara URI för signatur för delad åtkomst (SAS) 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

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 tjänstmodellen fortfarande, 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

Uppdateringsläge för molntjänsten. Rollinstanser allokeras till uppdateringsdomä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 Automatiskt. Om värdet är Manuellt måste PUT UpdateDomain anropas för att tillämpa uppdateringen. Om den ställs in på Auto tillämpas uppdateringen automatiskt på varje uppdateringsdomän i följd.

CloudServiceRoleProfile

Beskriver rollprofilen för molntjänsten.

Name Type Description
roles

Lista över roller för molntjänsten.

CloudServiceRoleProfileProperties

Beskriver rollegenskaperna.

Name Type Description
name
  • string

Resursnamn.

sku

Beskriver molntjänstrollens SKU.

CloudServiceRoleSku

Beskriver molntjänstrollens SKU.

Name Type Description
capacity
  • integer

Anger antalet rollinstanser i molntjänsten.

name
  • string

SKU-namnet. Obs! Om den nya SKU:n inte stöds på den maskinvara 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 nivån för molntjänsten. Möjliga värden är

Standard

Basic

CloudServiceSlotType

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

Produktion

Iscensättning

Om det inte anges är standardvärdet Produktion.

Name Type Description
Production
  • string
Staging
  • string

CloudServiceUpgradeMode

Uppdateringsläge för molntjänsten. Rollinstanser allokeras till uppdateringsdomä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 Automatiskt. Om värdet är Manuellt måste PUT UpdateDomain anropas för att tillämpa uppdateringen. Om den ställs in på Auto tillämpas uppdateringen automatiskt på varje uppdateringsdomän i följd.

Name Type 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 Type Description
secretUrl
  • string

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

sourceVault

ARM-resurs-ID för Key Vault

CloudServiceVaultCertificate

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

Name Type 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 Type Description
sourceVault

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

vaultCertificates

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

Extension

Beskriver ett molntjänsttillägg.

Name Type Description
name
  • string

Namnet på tillägget.

properties

Tilläggsegenskaper.

InnerError

Inre felinformation.

Name Type Description
errordetail
  • string

Det interna felmeddelandet eller undantagsdumpen.

exceptiontype
  • string

Undantagstypen.

LoadBalancerConfiguration

Beskriver lastbalanserarens konfiguration.

Name Type Description
id
  • string

Resurs-ID

name
  • string

Namnet på lastbalanseraren

properties

Egenskaper för lastbalanserarens konfiguration.

LoadBalancerConfigurationProperties

Beskriver egenskaperna för lastbalanserarens konfiguration.

Name Type Description
frontendIPConfigurations

Anger klientdelens IP-adress som ska användas för lastbalanseraren. Endast IP-adressen för IPv4-klientdelen stöds. Varje lastbalanserares konfiguration 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 lastbalanserares konfiguration måste ha exakt en IP-konfiguration för klientdelen.

Name Type Description
name
  • string

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

properties

Egenskaper för lastbalanserarens ip-konfiguration på klientdelen.

LoadBalancerFrontendIPConfigurationProperties

Beskriver en IP-konfiguration för molntjänsten

Name Type Description
privateIPAddress
  • string

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

publicIPAddress

Referensen till den offentliga IP-adressresursen.

subnet

Referensen till resursen för det virtuella nätverkets undernät.

SubResource

Name Type Description
id
  • string

Resurs-ID

SystemData

Systemmetadata som är relaterade till den här resursen.

Name Type 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.