Cloud Services - List

Usługa:: Compute

Wersja interfejsu API:: 2024-11-04

Pobiera listę wszystkich usług w chmurze w grupie zasobów. Użyj właściwości nextLink w odpowiedzi, aby uzyskać następną stronę Cloud Services. Rób to, dopóki nextLink nie będzie miał wartości null, aby pobrać wszystkie usługi w chmurze.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CloudServiceListResult	OK
Other Status Codes	CloudError	Error

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List Cloud Services in a Resource Group

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwa	Opis
ApiError	Błąd API.
ApiErrorBase	Baza błędów API.
CloudError	Odpowiedź na błąd z usługi obliczeniowej.
CloudService	Opisuje usługę w chmurze.
CloudServiceExtensionProfile	Opisuje profil rozszerzenia usługi w chmurze.
CloudServiceExtensionProperties	Właściwości rozszerzenia.
CloudServiceListResult	Wynik operacji listy.
CloudServiceNetworkProfile	Profil sieciowy dla usługi w chmurze.
CloudServiceOsProfile	Opisuje profil systemu operacyjnego dla usługi w chmurze.
CloudServiceProperties	Właściwości usługi w chmurze
CloudServiceRoleProfile	Opisuje profil roli usługi w chmurze.
CloudServiceRoleProfileProperties	Opisuje właściwości roli.
CloudServiceRoleSku	Opisuje jednostkę SKU roli usługi w chmurze.
CloudServiceSlotType	Typ miejsca dla usługi w chmurze. Możliwe wartości to produkcyjne przemieszczania Jeśli nie zostanie określony, wartość domyślna to Produkcja.
CloudServiceUpgradeMode	Tryb aktualizacji dla usługi w chmurze. Wystąpienia ról są przydzielane do aktualizowania domen podczas wdrażania usługi. Aktualizacje można inicjować ręcznie w każdej domenie aktualizacji lub inicjować automatycznie we wszystkich domenach aktualizacji. Możliwe wartości to Automatycznie Instrukcja równoczesne Jeśli nie zostanie określony, wartość domyślna to Auto. W przypadku ustawienia ręcznego należy wywołać parametr PUT UpdateDomain, aby zastosować aktualizację. W przypadku ustawienia automatycznego aktualizacja jest automatycznie stosowana do każdej domeny aktualizacji w sekwencji.
CloudServiceVaultAndSecretReference	Ustawienia chronione dla rozszerzenia, do których odwołuje się funkcja KeyVault, które są szyfrowane przed wysłaniem do wystąpienia roli.
CloudServiceVaultCertificate	Opisuje pojedyncze odwołanie do certyfikatu w Key Vault oraz miejsce, w którym certyfikat powinien znajdować się w wystąpieniu roli.
CloudServiceVaultSecretGroup	Opisuje zestaw certyfikatów, które znajdują się w tym samym magazynie kluczy.
createdByType	Typ tożsamości, która utworzyła zasób.
Extension	W tym artykule opisano rozszerzenie usługi w chmurze.
InnerError	Szczegóły błędu wewnętrznego.
LoadBalancerConfiguration	Opisuje konfigurację modułu równoważenia obciążenia.
LoadBalancerConfigurationProperties	Opisuje właściwości konfiguracji modułu równoważenia obciążenia.
LoadBalancerFrontendIpConfiguration	Określa adres IP frontonu, który ma być używany dla modułu równoważenia obciążenia. Obsługiwany jest tylko adres IP frontonu IPv4. Każda konfiguracja modułu równoważenia obciążenia musi mieć dokładnie jedną konfigurację adresu IP frontonu.
LoadBalancerFrontendIpConfigurationProperties	Opisuje konfigurację adresu IP usługi w chmurze
SubResource
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

ApiError

Objekt

Błąd API.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	ApiErrorBase[]	Szczegóły błędu interfejsu API
innererror	InnerError	Wewnętrzny błąd interfejsu API
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

ApiErrorBase

Objekt

Baza błędów API.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

CloudError

Objekt

Odpowiedź na błąd z usługi obliczeniowej.

Nazwa	Typ	Opis
error	ApiError	Błąd API.

CloudService

Objekt

Opisuje usługę w chmurze.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu.
properties	CloudServiceProperties	Właściwości usługi w chmurze
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
tags	object	Tagi zasobów.
type	string	Typ zasobu.
zones	string[]	Lista logicznej strefy dostępności zasobu. Lista powinna zawierać tylko 1 strefę, w której należy aprowizować usługę w chmurze. To pole jest opcjonalne.

CloudServiceExtensionProfile

Objekt

Opisuje profil rozszerzenia usługi w chmurze.

Nazwa	Typ	Opis
extensions	Extension[]	Lista rozszerzeń dla usługi w chmurze.

CloudServiceExtensionProperties

Objekt

Właściwości rozszerzenia.

Nazwa	Typ	Opis
autoUpgradeMinorVersion	boolean	Jawnie określ, czy platforma może automatycznie uaktualnić typeHandlerVersion do wyższych wersji pomocniczych, gdy staną się dostępne.
forceUpdateTag	string	Tag w celu wymuszenia zastosowania podanych ustawień publicznych i chronionych. Zmiana wartości tagu umożliwia ponowne uruchomienie rozszerzenia bez zmiany żadnego z ustawień publicznych lub chronionych. Jeśli element forceUpdateTag nie zostanie zmieniony, aktualizacje ustawień publicznych lub chronionych będą nadal stosowane przez program obsługi. Jeśli ani forceUpdateTag, ani żadne z ustawień publicznych lub chronionych nie ulegną zmianie, rozszerzenie będzie przepływać do instancji roli o tym samym numerze sekwencyjnym i to od implementacji programu obsługi zależy, czy uruchomić je ponownie, czy nie
protectedSettings	object	Ustawienia chronione dla rozszerzenia, które są szyfrowane przed wysłaniem do wystąpienia roli.
protectedSettingsFromKeyVault	CloudServiceVaultAndSecretReference	Ustawienia chronione dla rozszerzenia, do których odwołuje się funkcja KeyVault, które są szyfrowane przed wysłaniem do wystąpienia roli.
provisioningState	string	Stan aprowizacji, który pojawia się tylko w odpowiedzi.
publisher	string	Nazwa wydawcy programu obsługi rozszerzeń.
rolesAppliedTo	string[]	Opcjonalna lista ról do zastosowania tego rozszerzenia. Jeśli właściwość nie zostanie określona lub zostanie określona wartość "*", rozszerzenie jest stosowane do wszystkich ról w usłudze w chmurze.
settings	object	Ustawienia publiczne rozszerzenia. W przypadku rozszerzeń JSON jest to ustawienia JSON dla rozszerzenia. W przypadku rozszerzenia XML (na przykład RDP) jest to ustawienie XML dla rozszerzenia.
type	string	Określa typ rozszerzenia.
typeHandlerVersion	string	Określa wersję rozszerzenia. Określa wersję rozszerzenia. Jeśli ten element nie jest określony lub gwiazdka (*) jest używana jako wartość, zostanie użyta najnowsza wersja rozszerzenia. Jeśli wartość jest określona z numerem wersji głównej i gwiazdką jako numer wersji pomocniczej (X.), zostanie wybrana najnowsza wersja pomocnicza określonej wersji głównej. Jeśli określono numer wersji głównej i numer wersji pomocniczej (X.Y), wybrano określoną wersję rozszerzenia. Jeśli określono wersję, automatyczne uaktualnianie jest wykonywane w wystąpieniu roli.

CloudServiceListResult

Objekt

Wynik operacji listy.

Nazwa	Typ	Opis
nextLink	string	Identyfikator URI umożliwiający pobranie następnej strony zasobów. Użyj tego, aby uzyskać następną stronę z zasobami. Rób to, dopóki nextLink nie ma wartości null, aby pobrać wszystkie zasoby.
value	CloudService[]	Lista zasobów.

CloudServiceNetworkProfile

Objekt

Profil sieciowy dla usługi w chmurze.

Nazwa	Typ	Opis
loadBalancerConfigurations	LoadBalancerConfiguration[]	Lista konfiguracji modułu równoważenia obciążenia. Usługa w chmurze może mieć maksymalnie dwie konfiguracje modułu równoważenia obciążenia odpowiadające publicznemu modułowi równoważenia obciążenia i wewnętrznemu modułowi równoważenia obciążenia.
slotType	CloudServiceSlotType	Typ miejsca dla usługi w chmurze. Możliwe wartości to produkcyjne przemieszczania Jeśli nie zostanie określony, wartość domyślna to Produkcja.
swappableCloudService	SubResource	Odwołanie identyfikatora usługi w chmurze zawierającego docelowy adres IP, z którym usługa w chmurze podmiotu może wykonać zamianę. Nie można zaktualizować tej właściwości po jej ustawieniu. Usługa w chmurze, do której odwołuje się ten identyfikator, musi być obecna. W przeciwnym razie zostanie zgłoszony błąd.

CloudServiceOsProfile

Objekt

Opisuje profil systemu operacyjnego dla usługi w chmurze.

Nazwa	Typ	Opis
secrets	CloudServiceVaultSecretGroup[]	Określa zestaw certyfikatów, które mają być zainstalowane w wystąpieniach roli.

CloudServiceProperties

Objekt

Właściwości usługi w chmurze

Nazwa	Typ	Opis
allowModelOverride	boolean	(Opcjonalnie) Wskazuje, czy właściwości jednostki SKU roli (roleProfile.roles.sku) określone w modelu/szablonie powinny zastąpić liczbę wystąpień roli i rozmiar maszyny wirtualnej określony odpowiednio w plikach .cscfg i .csdef. Domyślna wartość to `false`.
configuration	string	Określa konfigurację usługi XML (cscfg) dla usługi w chmurze.
configurationUrl	string	Określa adres URL odwołujący się do lokalizacji konfiguracji usługi w usłudze Blob Service. Adres URL pakietu usługi może być identyfikatorem URI sygnatury dostępu współdzielonego (SAS) z dowolnego konta magazynu. Jest to właściwość tylko do zapisu i nie jest zwracana w wywołaniach GET.
extensionProfile	CloudServiceExtensionProfile	Opisuje profil rozszerzenia usługi w chmurze.
networkProfile	CloudServiceNetworkProfile	Profil sieciowy dla usługi w chmurze.
osProfile	CloudServiceOsProfile	Opisuje profil systemu operacyjnego dla usługi w chmurze.
packageUrl	string	Określa adres URL odwołujący się do lokalizacji pakietu usługi w usłudze Blob Service. Adres URL pakietu usługi może być identyfikatorem URI sygnatury dostępu współdzielonego (SAS) z dowolnego konta magazynu. Jest to właściwość tylko do zapisu i nie jest zwracana w wywołaniach GET.
provisioningState	string	Stan aprowizacji, który pojawia się tylko w odpowiedzi.
roleProfile	CloudServiceRoleProfile	Opisuje profil roli usługi w chmurze.
startCloudService	boolean	(Opcjonalnie) Wskazuje, czy usługa w chmurze ma być uruchamiana natychmiast po jej utworzeniu. Domyślna wartość to `true`. Jeśli wartość false, model usługi jest nadal wdrażany, ale kod nie jest uruchamiany natychmiast. Zamiast tego usługa jest obsługiwana do momentu wywołania polecenia Start, w którym momencie usługa zostanie uruchomiona. Wdrożona usługa nadal ponosi opłaty, nawet jeśli jest włączona.
uniqueId	string	Unikatowy identyfikator usługi w chmurze.
upgradeMode	CloudServiceUpgradeMode	Tryb aktualizacji dla usługi w chmurze. Wystąpienia ról są przydzielane do aktualizowania domen podczas wdrażania usługi. Aktualizacje można inicjować ręcznie w każdej domenie aktualizacji lub inicjować automatycznie we wszystkich domenach aktualizacji. Możliwe wartości to Automatycznie Instrukcja równoczesne Jeśli nie zostanie określony, wartość domyślna to Auto. W przypadku ustawienia ręcznego należy wywołać parametr PUT UpdateDomain, aby zastosować aktualizację. W przypadku ustawienia automatycznego aktualizacja jest automatycznie stosowana do każdej domeny aktualizacji w sekwencji.

CloudServiceRoleProfile

Objekt

Opisuje profil roli usługi w chmurze.

Nazwa	Typ	Opis
roles	CloudServiceRoleProfileProperties[]	Lista ról dla usługi w chmurze.

CloudServiceRoleProfileProperties

Objekt

Opisuje właściwości roli.

Nazwa	Typ	Opis
name	string	Nazwa zasobu.
sku	CloudServiceRoleSku	Opisuje jednostkę SKU roli usługi w chmurze.

CloudServiceRoleSku

Objekt

Opisuje jednostkę SKU roli usługi w chmurze.

Nazwa	Typ	Opis
capacity	integer (int64)	Określa liczbę wystąpień ról w usłudze w chmurze.
name	string	Nazwa SKU. UWAGA: Jeśli nowa jednostka SKU nie jest obecnie obsługiwana na sprzęcie, usługa w chmurze jest obecnie włączona, musisz usunąć i ponownie utworzyć usługę w chmurze lub wrócić do starej jednostki SKU.
tier	string	Określa warstwę usługi w chmurze. Możliwe wartości to Standard Basic

CloudServiceSlotType

Wyliczenie

Typ miejsca dla usługi w chmurze. Możliwe wartości to

produkcyjne

przemieszczania

Jeśli nie zostanie określony, wartość domyślna to Produkcja.

Wartość	Opis
Production
Staging

CloudServiceUpgradeMode

Wyliczenie

Tryb aktualizacji dla usługi w chmurze. Wystąpienia ról są przydzielane do aktualizowania domen podczas wdrażania usługi. Aktualizacje można inicjować ręcznie w każdej domenie aktualizacji lub inicjować automatycznie we wszystkich domenach aktualizacji. Możliwe wartości to

Automatycznie

Instrukcja

równoczesne

Jeśli nie zostanie określony, wartość domyślna to Auto. W przypadku ustawienia ręcznego należy wywołać parametr PUT UpdateDomain, aby zastosować aktualizację. W przypadku ustawienia automatycznego aktualizacja jest automatycznie stosowana do każdej domeny aktualizacji w sekwencji.

Wartość	Opis
Auto
Manual
Simultaneous

CloudServiceVaultAndSecretReference

Objekt

Ustawienia chronione dla rozszerzenia, do których odwołuje się funkcja KeyVault, które są szyfrowane przed wysłaniem do wystąpienia roli.

Nazwa	Typ	Opis
secretUrl	string	Tajny adres URL zawierający chronione ustawienia rozszerzenia
sourceVault	SubResource	Identyfikator zasobu usługi ARM usługi Key Vault

CloudServiceVaultCertificate

Objekt

Opisuje pojedyncze odwołanie do certyfikatu w Key Vault oraz miejsce, w którym certyfikat powinien znajdować się w wystąpieniu roli.

Nazwa	Typ	Opis
certificateUrl	string	Jest to adres URL certyfikatu przekazanego do usługi Key Vault jako wpisu tajnego.
isBootstrapCertificate	boolean	Flaga wskazująca, czy podany certyfikat jest certyfikatem uruchamiania używanym przez rozszerzenie usługi Key Vault w celu pobrania pozostałych certyfikatów.

CloudServiceVaultSecretGroup

Objekt

Opisuje zestaw certyfikatów, które znajdują się w tym samym magazynie kluczy.

Nazwa	Typ	Opis
sourceVault	SubResource	Względny adres URL usługi Key Vault zawierający wszystkie certyfikaty w usłudze VaultCertificates.
vaultCertificates	CloudServiceVaultCertificate[]	Lista odwołań do magazynu kluczy w usłudze SourceVault, które zawierają certyfikaty.

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

Extension

Objekt

W tym artykule opisano rozszerzenie usługi w chmurze.

Nazwa	Typ	Opis
name	string	Nazwa rozszerzenia.
properties	CloudServiceExtensionProperties	Właściwości rozszerzenia.

InnerError

Objekt

Szczegóły błędu wewnętrznego.

Nazwa	Typ	Opis
errordetail	string	Wewnętrzny komunikat o błędzie lub zrzut wyjątku.
exceptiontype	string	Typ wyjątku.

LoadBalancerConfiguration

Objekt

Opisuje konfigurację modułu równoważenia obciążenia.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu
name	string	Nazwa modułu równoważenia obciążenia
properties	LoadBalancerConfigurationProperties	Właściwości konfiguracji modułu równoważenia obciążenia.

LoadBalancerConfigurationProperties

Objekt

Opisuje właściwości konfiguracji modułu równoważenia obciążenia.

Nazwa	Typ	Opis
frontendIpConfigurations	LoadBalancerFrontendIpConfiguration[]	Określa adres IP frontonu, który ma być używany dla modułu równoważenia obciążenia. Obsługiwany jest tylko adres IP frontonu IPv4. Każda konfiguracja modułu równoważenia obciążenia musi mieć dokładnie jedną konfigurację adresu IP frontonu.

LoadBalancerFrontendIpConfiguration

Objekt

Określa adres IP frontonu, który ma być używany dla modułu równoważenia obciążenia. Obsługiwany jest tylko adres IP frontonu IPv4. Każda konfiguracja modułu równoważenia obciążenia musi mieć dokładnie jedną konfigurację adresu IP frontonu.

Nazwa	Typ	Opis
name	string	Nazwa zasobu, który jest unikatowy w zestawie konfiguracji adresów IP frontonu używanych przez moduł równoważenia obciążenia. Ta nazwa może służyć do uzyskiwania dostępu do zasobu.
properties	LoadBalancerFrontendIpConfigurationProperties	Właściwości konfiguracji adresu IP frontonu modułu równoważenia obciążenia.

LoadBalancerFrontendIpConfigurationProperties

Objekt

Opisuje konfigurację adresu IP usługi w chmurze

Nazwa	Typ	Opis
privateIPAddress	string	Prywatny adres IP sieci wirtualnej konfiguracji adresu IP.
publicIPAddress	SubResource	Odwołanie do zasobu publicznego adresu IP.
subnet	SubResource	Odwołanie do zasobu podsieci sieci wirtualnej.

SubResource

Objekt

Nazwa	Typ	Opis
id	string	Identyfikator zasobu

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij za pośrednictwem

Cloud Services - List

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

List Cloud Services in a Resource Group

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ApiError

ApiErrorBase

CloudError

CloudService

CloudServiceExtensionProfile

CloudServiceExtensionProperties

CloudServiceListResult

CloudServiceNetworkProfile

CloudServiceOsProfile

CloudServiceProperties

CloudServiceRoleProfile

CloudServiceRoleProfileProperties

CloudServiceRoleSku

CloudServiceSlotType

CloudServiceUpgradeMode

CloudServiceVaultAndSecretReference

CloudServiceVaultCertificate

CloudServiceVaultSecretGroup

createdByType

Extension

InnerError

LoadBalancerConfiguration

LoadBalancerConfigurationProperties

LoadBalancerFrontendIpConfiguration

LoadBalancerFrontendIpConfigurationProperties

SubResource

systemData