Cloud Services - List

Layanan:: Compute

Versi API:: 2024-11-04

Mendapatkan daftar semua layanan cloud di bawah grup sumber daya. Gunakan properti nextLink dalam respons untuk mendapatkan halaman Cloud Services berikutnya. Lakukan ini hingga nextLink null untuk mengambil semua Layanan Cloud.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya.
subscriptionId	path	True	string	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi Api Klien.

Respons

Nama	Jenis	Deskripsi
200 OK	CloudServiceListResult	OK
Other Status Codes	CloudError	Kesalahan

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

List Cloud Services in a Resource Group

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 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"
      }
    }
  ]
}

Definisi

Nama	Deskripsi
ApiError	Kesalahan API.
ApiErrorBase	Basis kesalahan API.
CloudError	Respons kesalahan dari layanan Komputasi.
CloudService	Menjelaskan layanan awan.
CloudServiceExtensionProfile	Menjelaskan profil ekstensi layanan cloud.
CloudServiceExtensionProperties	Properti Ekstensi.
CloudServiceListResult	Hasil operasi daftar.
CloudServiceNetworkProfile	Profil Jaringan untuk layanan cloud.
CloudServiceOsProfile	Menjelaskan profil OS untuk layanan cloud.
CloudServiceProperties	Properti layanan cloud
CloudServiceRoleProfile	Menjelaskan profil peran untuk layanan awan.
CloudServiceRoleProfileProperties	Menjelaskan properti peran.
CloudServiceRoleSku	Menjelaskan sku peran layanan awan.
CloudServiceSlotType	Jenis slot untuk layanan awan. Nilai yang mungkin adalah Produksi Penahapan Jika tidak ditentukan, nilai defaultnya adalah Produksi.
CloudServiceUpgradeMode	Mode pembaruan untuk layanan awan. Instans peran dialokasikan untuk memperbarui domain saat layanan disebarkan. Pembaruan dapat dimulai secara manual di setiap domain pembaruan atau dimulai secara otomatis di semua domain pembaruan. Nilai yang Mungkin adalah Auto Manual Simultan Jika tidak ditentukan, nilai defaultnya adalah Otomatis. Jika diatur ke Manual, PUT UpdateDomain harus dipanggil untuk menerapkan pembaruan. Jika diatur ke Otomatis, pembaruan secara otomatis diterapkan ke setiap domain pembaruan secara berurutan.
CloudServiceVaultAndSecretReference	Pengaturan yang dilindungi untuk ekstensi, direferensikan menggunakan KeyVault yang dienkripsi sebelum dikirim ke instans peran.
CloudServiceVaultCertificate	Menjelaskan referensi sertifikat tunggal di Key Vault, dan di mana sertifikat harus berada pada instans peran.
CloudServiceVaultSecretGroup	Menjelaskan sekumpulan sertifikat yang semuanya berada di Key Vault yang sama.
createdByType	Jenis identitas yang membuat sumber daya.
Extension	Menjelaskan Ekstensi layanan cloud.
InnerError	Detail kesalahan dalam.
LoadBalancerConfiguration	Menjelaskan konfigurasi penyeimbang beban.
LoadBalancerConfigurationProperties	Menjelaskan properti konfigurasi penyeimbang beban.
LoadBalancerFrontendIpConfiguration	Menentukan IP frontend yang akan digunakan untuk load balancer. Hanya alamat IP frontend IPv4 yang didukung. Setiap konfigurasi load balancer harus memiliki tepat satu konfigurasi IP frontend.
LoadBalancerFrontendIpConfigurationProperties	Menjelaskan Konfigurasi IP layanan cloud
SubResource
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

ApiError

Objek

Kesalahan API.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
details	ApiErrorBase[]	Detail kesalahan Api
innererror	InnerError	Kesalahan dalam Api
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

ApiErrorBase

Objek

Basis kesalahan API.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

CloudError

Objek

Respons kesalahan dari layanan Komputasi.

Nama	Jenis	Deskripsi
error	ApiError	Kesalahan API.

CloudService

Objek

Menjelaskan layanan awan.

Nama	Jenis	Deskripsi
id	string	Id Sumber Daya.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties	CloudServiceProperties	Properti layanan cloud
systemData	systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya.
zones	string[]	Daftar zona ketersediaan logis sumber daya. Daftar hanya boleh berisi 1 zona tempat layanan awan harus disediakan. Bidang ini bersifat opsional.

CloudServiceExtensionProfile

Objek

Menjelaskan profil ekstensi layanan cloud.

Nama	Jenis	Deskripsi
extensions	Extension[]	Daftar ekstensi untuk layanan awan.

CloudServiceExtensionProperties

Objek

Properti Ekstensi.

Nama	Jenis	Deskripsi
autoUpgradeMinorVersion	boolean	Tentukan secara eksplisit apakah platform dapat secara otomatis meningkatkan typeHandlerVersion ke versi minor yang lebih tinggi saat tersedia.
forceUpdateTag	string	Tag untuk menerapkan paksa pengaturan publik dan terproteksi yang disediakan. Mengubah nilai tag memungkinkan untuk menjalankan kembali ekstensi tanpa mengubah pengaturan publik atau terproteksi apa pun. Jika forceUpdateTag tidak diubah, pembaruan pada pengaturan publik atau terproteksi masih akan diterapkan oleh handler. Jika baik forceUpdateTag maupun pengaturan publik atau terlindungi tidak berubah, ekstensi akan mengalir ke instans peran dengan nomor urut yang sama, dan terserah implementasi handler apakah akan menjalankannya kembali atau tidak
protectedSettings	object	Pengaturan yang dilindungi untuk ekstensi yang dienkripsi sebelum dikirim ke instans peran.
protectedSettingsFromKeyVault	CloudServiceVaultAndSecretReference	Pengaturan yang dilindungi untuk ekstensi, direferensikan menggunakan KeyVault yang dienkripsi sebelum dikirim ke instans peran.
provisioningState	string	Status provisi, yang hanya muncul dalam respons.
publisher	string	Nama penerbit handler ekstensi.
rolesAppliedTo	string[]	Daftar peran opsional untuk menerapkan ekstensi ini. Jika properti tidak ditentukan atau '*' ditentukan, ekstensi diterapkan ke semua peran dalam layanan cloud.
settings	object	Pengaturan publik untuk ekstensi. Untuk ekstensi JSON, ini adalah pengaturan JSON untuk ekstensi. Untuk Ekstensi XML (seperti RDP), ini adalah pengaturan XML untuk ekstensi.
type	string	Menentukan jenis ekstensi.
typeHandlerVersion	string	Menentukan versi ekstensi. Menentukan versi ekstensi. Jika elemen ini tidak ditentukan atau tanda bintang (*) digunakan sebagai nilai, versi terbaru ekstensi digunakan. Jika nilai ditentukan dengan nomor versi utama dan tanda bintang sebagai nomor versi minor (X.), versi minor terbaru dari versi utama yang ditentukan dipilih. Jika nomor versi utama dan nomor versi minor ditentukan (X.Y), versi ekstensi tertentu dipilih. Jika versi ditentukan, peningkatan otomatis dilakukan pada instans peran.

CloudServiceListResult

Objek

Hasil operasi daftar.

Nama	Jenis	Deskripsi
nextLink	string	URI untuk mengambil halaman sumber daya berikutnya. Gunakan ini untuk mendapatkan halaman sumber daya berikutnya. Lakukan ini sampai nextLink null untuk mengambil semua sumber daya.
value	CloudService[]	Daftar sumber daya.

CloudServiceNetworkProfile

Objek

Profil Jaringan untuk layanan cloud.

Nama	Jenis	Deskripsi
loadBalancerConfigurations	LoadBalancerConfiguration[]	Daftar konfigurasi Load balancer. Layanan cloud dapat memiliki hingga dua konfigurasi load balancer, yang sesuai dengan Load Balancer Publik dan Load Balancer Internal.
slotType	CloudServiceSlotType	Jenis slot untuk layanan awan. Nilai yang mungkin adalah Produksi Penahapan Jika tidak ditentukan, nilai defaultnya adalah Produksi.
swappableCloudService	SubResource	Referensi id layanan cloud yang berisi IP target tempat layanan cloud subjek dapat melakukan pertukaran. Properti ini tidak dapat diperbarui setelah diatur. Layanan cloud yang dapat ditukar yang dirujuk oleh id ini harus ada jika tidak, kesalahan akan dilemparkan.

CloudServiceOsProfile

Objek

Menjelaskan profil OS untuk layanan cloud.

Nama	Jenis	Deskripsi
secrets	CloudServiceVaultSecretGroup[]	Menentukan sekumpulan sertifikat yang harus diinstal ke instans peran.

CloudServiceProperties

Objek

Properti layanan cloud

Nama	Jenis	Deskripsi
allowModelOverride	boolean	(Opsional) Menunjukkan apakah properti sku peran (roleProfile.roles.sku) yang ditentukan dalam model/templat harus mengambil alih jumlah instans peran dan ukuran vm yang ditentukan dalam .cscfg dan .csdef. Nilai defaultnya adalah `false`.
configuration	string	Menentukan konfigurasi layanan XML (.cscfg) untuk layanan cloud.
configurationUrl	string	Menentukan URL yang mengacu pada lokasi konfigurasi layanan di layanan Blob. URL paket layanan dapat berupa URI Tanda Tangan Akses Bersama (SAS) dari akun penyimpanan apa pun. Ini adalah properti tulis-saja dan tidak dikembalikan dalam panggilan GET.
extensionProfile	CloudServiceExtensionProfile	Menjelaskan profil ekstensi layanan cloud.
networkProfile	CloudServiceNetworkProfile	Profil Jaringan untuk layanan cloud.
osProfile	CloudServiceOsProfile	Menjelaskan profil OS untuk layanan cloud.
packageUrl	string	Menentukan URL yang mengacu pada lokasi paket layanan di layanan Blob. URL paket layanan dapat berupa URI Tanda Tangan Akses Bersama (SAS) dari akun penyimpanan apa pun. Ini adalah properti tulis-saja dan tidak dikembalikan dalam panggilan GET.
provisioningState	string	Status provisi, yang hanya muncul dalam respons.
roleProfile	CloudServiceRoleProfile	Menjelaskan profil peran untuk layanan awan.
startCloudService	boolean	(Opsional) Menunjukkan apakah akan memulai layanan awan segera setelah dibuat. Nilai defaultnya adalah `true`. Jika false, model layanan masih disebarkan, tetapi kode tidak segera dijalankan. Sebagai gantinya, layanan ini Adalah PoweredOff sampai Anda memanggil Mulai, pada saat itu layanan akan dimulai. Layanan yang disebarkan masih dikenakan biaya, bahkan jika itu poweredoff.
uniqueId	string	Pengidentifikasi unik untuk layanan cloud.
upgradeMode	CloudServiceUpgradeMode	Mode pembaruan untuk layanan awan. Instans peran dialokasikan untuk memperbarui domain saat layanan disebarkan. Pembaruan dapat dimulai secara manual di setiap domain pembaruan atau dimulai secara otomatis di semua domain pembaruan. Nilai yang Mungkin adalah Auto Manual Simultan Jika tidak ditentukan, nilai defaultnya adalah Otomatis. Jika diatur ke Manual, PUT UpdateDomain harus dipanggil untuk menerapkan pembaruan. Jika diatur ke Otomatis, pembaruan secara otomatis diterapkan ke setiap domain pembaruan secara berurutan.

CloudServiceRoleProfile

Objek

Menjelaskan profil peran untuk layanan awan.

Nama	Jenis	Deskripsi
roles	CloudServiceRoleProfileProperties[]	Daftar peran untuk layanan awan.

CloudServiceRoleProfileProperties

Objek

Menjelaskan properti peran.

Nama	Jenis	Deskripsi
name	string	Nama sumber daya.
sku	CloudServiceRoleSku	Menjelaskan sku peran layanan awan.

CloudServiceRoleSku

Objek

Menjelaskan sku peran layanan awan.

Nama	Jenis	Deskripsi
capacity	integer (int64)	Menentukan jumlah instans peran di layanan awan.
name	string	Nama SKU. CATATAN: Jika SKU baru tidak didukung pada perangkat keras yang saat ini aktif, Anda perlu menghapus dan membuat ulang layanan cloud atau pindah kembali ke sku lama.
tier	string	Menentukan tingkat layanan awan. Nilai yang Mungkin adalah Standar Basic

CloudServiceSlotType

Enumerasi

Jenis slot untuk layanan awan. Nilai yang mungkin adalah

Produksi

Penahapan

Jika tidak ditentukan, nilai defaultnya adalah Produksi.

Nilai	Deskripsi
Production
Staging

CloudServiceUpgradeMode

Enumerasi

Mode pembaruan untuk layanan awan. Instans peran dialokasikan untuk memperbarui domain saat layanan disebarkan. Pembaruan dapat dimulai secara manual di setiap domain pembaruan atau dimulai secara otomatis di semua domain pembaruan. Nilai yang Mungkin adalah

Auto

Manual

Simultan

Jika tidak ditentukan, nilai defaultnya adalah Otomatis. Jika diatur ke Manual, PUT UpdateDomain harus dipanggil untuk menerapkan pembaruan. Jika diatur ke Otomatis, pembaruan secara otomatis diterapkan ke setiap domain pembaruan secara berurutan.

Nilai	Deskripsi
Auto
Manual
Simultaneous

CloudServiceVaultAndSecretReference

Objek

Pengaturan yang dilindungi untuk ekstensi, direferensikan menggunakan KeyVault yang dienkripsi sebelum dikirim ke instans peran.

Nama	Jenis	Deskripsi
secretUrl	string	URL Rahasia yang berisi pengaturan ekstensi yang dilindungi
sourceVault	SubResource	ID Sumber Daya ARM dari Key Vault

CloudServiceVaultCertificate

Objek

Menjelaskan referensi sertifikat tunggal di Key Vault, dan di mana sertifikat harus berada pada instans peran.

Nama	Jenis	Deskripsi
certificateUrl	string	Ini adalah URL sertifikat yang telah diunggah ke Key Vault sebagai rahasia.
isBootstrapCertificate	boolean	Bendera yang menunjukkan apakah sertifikat yang disediakan adalah sertifikat bootstrap yang akan digunakan oleh Ekstensi Key Vault untuk mengambil sertifikat yang tersisa.

CloudServiceVaultSecretGroup

Objek

Menjelaskan sekumpulan sertifikat yang semuanya berada di Key Vault yang sama.

Nama	Jenis	Deskripsi
sourceVault	SubResource	URL relatif Key Vault yang berisi semua sertifikat di VaultCertificates.
vaultCertificates	CloudServiceVaultCertificate[]	Daftar referensi brankas kunci di SourceVault yang berisi sertifikat.

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

Extension

Objek

Menjelaskan Ekstensi layanan cloud.

Nama	Jenis	Deskripsi
name	string	Nama ekstensi.
properties	CloudServiceExtensionProperties	Properti Ekstensi.

InnerError

Objek

Detail kesalahan dalam.

Nama	Jenis	Deskripsi
errordetail	string	Pesan kesalahan internal atau dump pengecualian.
exceptiontype	string	Jenis pengecualian.

LoadBalancerConfiguration

Objek

Menjelaskan konfigurasi penyeimbang beban.

Nama	Jenis	Deskripsi
id	string	Id Sumber Daya
name	string	Nama Load balancer
properties	LoadBalancerConfigurationProperties	Properti konfigurasi load balancer.

LoadBalancerConfigurationProperties

Objek

Menjelaskan properti konfigurasi penyeimbang beban.

Nama	Jenis	Deskripsi
frontendIpConfigurations	LoadBalancerFrontendIpConfiguration[]	Menentukan IP frontend yang akan digunakan untuk load balancer. Hanya alamat IP frontend IPv4 yang didukung. Setiap konfigurasi load balancer harus memiliki tepat satu konfigurasi IP frontend.

LoadBalancerFrontendIpConfiguration

Objek

Menentukan IP frontend yang akan digunakan untuk load balancer. Hanya alamat IP frontend IPv4 yang didukung. Setiap konfigurasi load balancer harus memiliki tepat satu konfigurasi IP frontend.

Nama	Jenis	Deskripsi
name	string	Nama sumber daya yang unik dalam kumpulan konfigurasi IP frontend yang digunakan oleh load balancer. Nama ini dapat digunakan untuk mengakses sumber daya.
properties	LoadBalancerFrontendIpConfigurationProperties	Properti konfigurasi ip frontend load balancer.

LoadBalancerFrontendIpConfigurationProperties

Objek

Menjelaskan Konfigurasi IP layanan cloud

Nama	Jenis	Deskripsi
privateIPAddress	string	Alamat IP privat jaringan virtual konfigurasi IP.
publicIPAddress	SubResource	Referensi ke sumber daya alamat IP publik.
subnet	SubResource	Referensi ke sumber daya subnet jaringan virtual.

SubResource

Objek

Nama	Jenis	Deskripsi
id	string	Id Sumber Daya

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

Bagikan melalui

Cloud Services - List

Parameter URI

Respons

Keamanan

azure_auth

Cakupan

Contoh

List Cloud Services in a Resource Group

Permintaan sampel

Respon sampel

Definisi

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