Cloud Services - Get

Referensi

Service:: Compute

API Version:: 2022-04-04

Menampilkan informasi tentang layanan awan.

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

Parameter URI

Name	In	Required	Type	Description
cloudServiceName	path	True	string	Nama layanan awan.
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

Name	Type	Description
200 OK	CloudService	OK
Other Status Codes	CloudError	Kesalahan

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

Get Cloud Service with Multiple Roles and RDP Extension

Sample Request

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

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/compute/resource-manager/Microsoft.Compute/stable/2022-04-04/CloudServiceRP/examples/CloudService_Get_WithMultiRoleAndRDP.json
func ExampleCloudServicesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armcompute.NewCloudServicesClient("{subscription-id}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"ConstosoRG",
		"{cs-name}",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Display information about a cloud service.
 *
 * @summary Display information about a cloud service.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/stable/2022-04-04/CloudServiceRP/examples/CloudService_Get_WithMultiRoleAndRDP.json
 */
async function getCloudServiceWithMultipleRolesAndRdpExtension() {
  const subscriptionId = "{subscription-id}";
  const resourceGroupName = "ConstosoRG";
  const cloudServiceName = "{cs-name}";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.cloudServices.get(resourceGroupName, cloudServiceName);
  console.log(result);
}

getCloudServiceWithMultipleRolesAndRdpExtension().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 200

{
  "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"
  },
  "systemData": {
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedAt": "2020-01-01T17:18:19.1234567Z"
  }
}

Definisi

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.
CloudServiceNetworkProfile	Profil Jaringan untuk layanan cloud.
CloudServiceOsProfile	Menjelaskan profil OS untuk layanan awan.
CloudServiceProperties	Properti layanan awan
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. Updates 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 dalam Key Vault, dan di mana sertifikat harus berada pada instans peran.
CloudServiceVaultSecretGroup	Menjelaskan sekumpulan sertifikat yang semuanya berada dalam Key Vault yang sama.
Extension	Menjelaskan Ekstensi layanan cloud.
InnerError	Detail kesalahan dalam.
LoadBalancerConfiguration	Menjelaskan konfigurasi load balancer.
LoadBalancerConfigurationProperties	Menjelaskan properti konfigurasi load balancer.
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 awan
SubResource
SystemData	Data meta sistem yang berkaitan dengan sumber daya ini.

ApiError

Kesalahan api.

Name	Type	Description
code	string	Kode kesalahan.
details	ApiErrorBase[]	Detail kesalahan Api
innererror	InnerError	Kesalahan dalam Api
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

ApiErrorBase

Basis kesalahan api.

Name	Type	Description
code	string	Kode kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

CloudError

Respons kesalahan dari layanan Komputasi.

Name	Type	Description
error	ApiError	Kesalahan api.

CloudService

Menjelaskan layanan awan.

Name	Type	Description
id	string	Id Sumber Daya.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties	CloudServiceProperties	Properti layanan awan
systemData	SystemData	Data meta sistem yang berkaitan dengan sumber daya ini.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya

CloudServiceExtensionProfile

Menjelaskan profil ekstensi layanan cloud.

Name	Type	Description
extensions	Extension[]	Daftar ekstensi untuk layanan awan.

CloudServiceExtensionProperties

Properti Ekstensi.

Name	Type	Description
autoUpgradeMinorVersion	boolean	Tentukan secara eksplisit apakah platform dapat secara otomatis meningkatkan typeHandlerVersion ke versi minor yang lebih tinggi saat tersedia.
forceUpdateTag	string	Tag untuk memaksa menerapkan pengaturan publik dan terproteksi yang disediakan. Mengubah nilai tag memungkinkan untuk menjalankan kembali ekstensi tanpa mengubah pengaturan publik atau terlindungi. Jika forceUpdateTag tidak diubah, pembaruan untuk pengaturan publik atau terproteksi masih akan diterapkan oleh handler. Jika tidak ada forceUpdateTag atau pengaturan publik atau terproteksi yang berubah, ekstensi akan mengalir ke instans peran dengan nomor urutan 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 penyediaan, 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.

CloudServiceNetworkProfile

Profil Jaringan untuk layanan cloud.

Name	Type	Description
loadBalancerConfigurations	LoadBalancerConfiguration[]	Daftar konfigurasi Load balancer. Layanan cloud dapat memiliki hingga dua konfigurasi load balancer, 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

Menjelaskan profil OS untuk layanan awan.

Name	Type	Description
secrets	CloudServiceVaultSecretGroup[]	Menentukan sekumpulan sertifikat yang harus diinstal ke instans peran.

CloudServiceProperties

Properti layanan awan

Name	Type	Description
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 masing-masing. 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 blob service. URL paket layanan dapat menjadi 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 awan.
packageUrl	string	Menentukan URL yang mengacu pada lokasi paket layanan di blob service. URL paket layanan dapat menjadi 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 cloud 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 layanan akan dimulai. Layanan yang disebarkan masih dikenakan biaya, bahkan jika itu dimatikan.
uniqueId	string	Pengidentifikasi unik untuk layanan cloud.
upgradeMode	CloudServiceUpgradeMode	Mode pembaruan untuk layanan awan. Instans peran dialokasikan untuk memperbarui domain saat layanan disebarkan. Updates 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

Menjelaskan profil peran untuk layanan awan.

Name	Type	Description
roles	CloudServiceRoleProfileProperties[]	Daftar peran untuk layanan awan.

CloudServiceRoleProfileProperties

Menjelaskan properti peran.

Name	Type	Description
name	string	Nama sumber daya.
sku	CloudServiceRoleSku	Menjelaskan sku peran layanan awan.

CloudServiceRoleSku

Menjelaskan sku peran layanan awan.

Name	Type	Description
capacity	integer	Menentukan jumlah instans peran di layanan cloud.
name	string	Nama sku. CATATAN: Jika SKU baru tidak didukung pada perangkat keras tempat layanan cloud saat ini aktif, Anda perlu menghapus dan membuat ulang layanan cloud atau pindah kembali ke sku lama.
tier	string	Menentukan tingkat layanan cloud. Nilai yang Mungkin adalah Standard Dasar

CloudServiceSlotType

Jenis slot untuk layanan awan. Nilai yang mungkin adalah

Produksi

Penahapan

Jika tidak ditentukan, nilai defaultnya adalah Produksi.

Name	Type	Description
Production	string
Staging	string

CloudServiceUpgradeMode

Mode pembaruan untuk layanan awan. Instans peran dialokasikan untuk memperbarui domain saat layanan disebarkan. Updates 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.

Name	Type	Description
Auto	string
Manual	string
Simultaneous	string

CloudServiceVaultAndSecretReference

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

Name	Type	Description
secretUrl	string	URL Rahasia yang berisi pengaturan ekstensi yang dilindungi
sourceVault	SubResource	ID Sumber Daya ARM dari Key Vault

CloudServiceVaultCertificate

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

Name	Type	Description
certificateUrl	string	Ini adalah URL sertifikat yang telah diunggah ke Key Vault sebagai rahasia.

CloudServiceVaultSecretGroup

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

Name	Type	Description
sourceVault	SubResource	URL relatif Key Vault yang berisi semua sertifikat di VaultCertificates.
vaultCertificates	CloudServiceVaultCertificate[]	Daftar referensi brankas kunci di SourceVault yang berisi sertifikat.

Extension

Menjelaskan Ekstensi layanan cloud.

Name	Type	Description
name	string	Nama ekstensi.
properties	CloudServiceExtensionProperties	Properti Ekstensi.

InnerError

Detail kesalahan dalam.

Name	Type	Description
errordetail	string	Pesan kesalahan internal atau cadangan pengecualian.
exceptiontype	string	Jenis pengecualian.

LoadBalancerConfiguration

Menjelaskan konfigurasi load balancer.

Name	Type	Description
id	string	ID sumber daya
name	string	Nama Load balancer
properties	LoadBalancerConfigurationProperties	Properti konfigurasi load balancer.

LoadBalancerConfigurationProperties

Menjelaskan properti konfigurasi load balancer.

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

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.

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

Menjelaskan Konfigurasi IP layanan awan

Name	Type	Description
privateIPAddress	string	Alamat IP privat jaringan virtual dari konfigurasi IP.
publicIPAddress	SubResource	Referensi ke sumber daya alamat IP publik.
subnet	SubResource	Referensi ke sumber daya subnet jaringan virtual.

SubResource

Name	Type	Description
id	string	ID sumber daya

SystemData

Data meta sistem yang berkaitan dengan sumber daya ini.

Name	Type	Description
createdAt	string	Menentukan waktu dalam UTC tempat sumber daya Cloud Service (dukungan diperpanjang) dibuat. Versi api minimum: 2022-04-04.
lastModifiedAt	string	Menentukan waktu dalam UTC di mana sumber daya Cloud Service (dukungan yang diperluas) terakhir diubah. Versi api minimum: 2022-04-04.