Virtual Machine Scale Sets - Get OS Upgrade History

Referensi

Service:: Compute

API Version:: 2022-03-01

Mendapatkan daftar peningkatan OS pada instans set skala VM.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osUpgradeHistory?api-version=2022-03-01

Parameter URI

Name	In	Required	Type	Description
resourceGroupName	path	True	string	Nama grup sumber daya.
subscriptionId	path	True	string	Info masuk langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
vmScaleSetName	path	True	string	Nama set skala VM.
api-version	query	True	string	Versi Api Klien.

Respons

Name	Type	Description
200 OK	VirtualMachineScaleSetListOSUpgradeHistory	OK
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

VirtualMachineScaleSets_GetOSUpgradeHistory_MaximumSet_Gen

VirtualMachineScaleSets_GetOSUpgradeHistory_MinimumSet_Gen

VirtualMachineScaleSets_GetOSUpgradeHistory_MaximumSet_Gen

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaa/osUpgradeHistory?api-version=2022-03-01

import com.azure.core.util.Context;

/** Samples for VirtualMachineScaleSets GetOSUpgradeHistory. */
public final class Main {
    /*
     * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/stable/2022-03-01/ComputeRP/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetOSUpgradeHistory_MaximumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineScaleSets_GetOSUpgradeHistory_MaximumSet_Gen.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualMachineScaleSetsGetOSUpgradeHistoryMaximumSetGen(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .virtualMachines()
            .manager()
            .serviceClient()
            .getVirtualMachineScaleSets()
            .getOSUpgradeHistory("rgcompute", "aaaaaa", Context.NONE);
    }
}

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

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-03-01/ComputeRP/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetOSUpgradeHistory_MaximumSet_Gen.json
func ExampleVirtualMachineScaleSetsClient_NewGetOSUpgradeHistoryPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armcompute.NewVirtualMachineScaleSetsClient("{subscription-id}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewGetOSUpgradeHistoryPager("rgcompute",
		"aaaaaa",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

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 Gets list of OS upgrades on a VM scale set instance.
 *
 * @summary Gets list of OS upgrades on a VM scale set instance.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/stable/2022-03-01/ComputeRP/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetOSUpgradeHistory_MaximumSet_Gen.json
 */
async function virtualMachineScaleSetsGetOSUpgradeHistoryMaximumSetGen() {
  const subscriptionId = "{subscription-id}";
  const resourceGroupName = "rgcompute";
  const vmScaleSetName = "aaaaaa";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.virtualMachineScaleSets.listOSUpgradeHistory(
    resourceGroupName,
    vmScaleSetName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

virtualMachineScaleSetsGetOSUpgradeHistoryMaximumSetGen().catch(console.error);

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "runningStatus": {
          "code": "RollingForward",
          "startTime": "2021-11-30T13:05:40.442Z",
          "endTime": "2021-11-30T13:05:40.443Z"
        },
        "progress": {
          "successfulInstanceCount": 6,
          "failedInstanceCount": 25,
          "inProgressInstanceCount": 20,
          "pendingInstanceCount": 27
        },
        "error": {
          "details": [
            {
              "code": "aaaaaaaaaaaaaaaaaaaaaaaa",
              "target": "aaaa",
              "message": "aa"
            }
          ],
          "innererror": {
            "exceptiontype": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "errordetail": "aaaaaaaaaaaaaaaaaaaaaaaa"
          },
          "code": "aaaaaaa",
          "target": "aaaaaaa",
          "message": "aaaaaaaaa"
        },
        "startedBy": "Unknown",
        "targetImageReference": {
          "sku": "2016-Datacenter",
          "publisher": "MicrosoftWindowsServer",
          "version": "latest",
          "offer": "WindowsServer",
          "exactVersion": "aaaaaaa",
          "sharedGalleryImageId": "aaaaaa",
          "id": "aaaaaaaaaaaaaaaaaaa"
        },
        "rollbackInfo": {
          "successfullyRolledbackInstanceCount": 12,
          "failedRolledbackInstanceCount": 2,
          "rollbackError": {
            "details": [
              {
                "code": "aaaaaaaaaaaaaaaaaaaaaaaa",
                "target": "aaaa",
                "message": "aa"
              }
            ],
            "innererror": {
              "exceptiontype": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
              "errordetail": "aaaaaaaaaaaaaaaaaaaaaaaa"
            },
            "code": "aaaaaaa",
            "target": "aaaaaaa",
            "message": "aaaaaaaaa"
          }
        }
      },
      "type": "aaaaaaaaaaaaaaaaaaa",
      "location": "aaaaaaaaaaaaa"
    }
  ],
  "nextLink": "aaaaaaaaa"
}

VirtualMachineScaleSets_GetOSUpgradeHistory_MinimumSet_Gen

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaaaaaa/osUpgradeHistory?api-version=2022-03-01

import com.azure.core.util.Context;

/** Samples for VirtualMachineScaleSets GetOSUpgradeHistory. */
public final class Main {
    /*
     * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/stable/2022-03-01/ComputeRP/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetOSUpgradeHistory_MinimumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineScaleSets_GetOSUpgradeHistory_MinimumSet_Gen.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualMachineScaleSetsGetOSUpgradeHistoryMinimumSetGen(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .virtualMachines()
            .manager()
            .serviceClient()
            .getVirtualMachineScaleSets()
            .getOSUpgradeHistory("rgcompute", "aaaaaaaaaaaaaaaaaaaaaaaaaa", Context.NONE);
    }
}

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 Gets list of OS upgrades on a VM scale set instance.
 *
 * @summary Gets list of OS upgrades on a VM scale set instance.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/stable/2022-03-01/ComputeRP/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetOSUpgradeHistory_MinimumSet_Gen.json
 */
async function virtualMachineScaleSetsGetOSUpgradeHistoryMinimumSetGen() {
  const subscriptionId = "{subscription-id}";
  const resourceGroupName = "rgcompute";
  const vmScaleSetName = "aaaaaaaaaaaaaaaaaaaaaaaaaa";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.virtualMachineScaleSets.listOSUpgradeHistory(
    resourceGroupName,
    vmScaleSetName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

virtualMachineScaleSetsGetOSUpgradeHistoryMinimumSetGen().catch(console.error);

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

Sample Response

Status code:: 200

{
  "value": [
    {}
  ]
}

Definisi

ApiError	Kesalahan api.
ApiErrorBase	Basis kesalahan api.
CloudError	Respons kesalahan dari layanan Komputasi.
ImageReference	Menentukan informasi tentang gambar yang akan digunakan. Anda dapat menentukan informasi tentang gambar platform, gambar marketplace, atau gambar komputer virtual. Elemen ini diperlukan ketika Anda ingin menggunakan gambar platform, gambar marketplace, atau gambar komputer virtual, tetapi tidak digunakan dalam operasi pembuatan lainnya. CATATAN: Penerbit dan penawaran referensi gambar hanya dapat diatur saat Anda membuat set skala.
InnerError	Detail kesalahan dalam.
RollbackStatusInfo	Informasi tentang pembatalan pada instans VM yang gagal setelah operasi Peningkatan OS.
RollingUpgradeProgressInfo	Informasi tentang jumlah instans komputer virtual di setiap status peningkatan.
UpgradeOperationHistoricalStatusInfo	Respons operasi Riwayat Peningkatan OS Set Skala Komputer Virtual.
UpgradeOperationHistoricalStatusInfoProperties	Menjelaskan setiap peningkatan OS pada Virtual Machine Scale Set.
UpgradeOperationHistoryStatus	Informasi tentang status peningkatan keseluruhan yang sedang berjalan saat ini.
UpgradeOperationInvoker	Pemanggil Operasi Peningkatan
UpgradeState	Kode yang menunjukkan status peningkatan saat ini.
VirtualMachineScaleSetListOSUpgradeHistory	Daftar respons operasi Riwayat Peningkatan OS Set Skala Komputer Virtual.

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.

ImageReference

Menentukan informasi tentang gambar yang akan digunakan. Anda dapat menentukan informasi tentang gambar platform, gambar marketplace, atau gambar komputer virtual. Elemen ini diperlukan ketika Anda ingin menggunakan gambar platform, gambar marketplace, atau gambar komputer virtual, tetapi tidak digunakan dalam operasi pembuatan lainnya. CATATAN: Penerbit dan penawaran referensi gambar hanya dapat diatur saat Anda membuat set skala.

Name	Type	Description
communityGalleryImageId	string	Menentukan id unik gambar galeri komunitas untuk penyebaran vm. Ini dapat diambil dari panggilan GET gambar galeri komunitas.
exactVersion	string	Menentukan angka desimal, versi gambar platform atau gambar marketplace yang digunakan untuk membuat komputer virtual. Bidang baca-saja ini berbeda dari 'versi', hanya jika nilai yang ditentukan dalam bidang 'versi' adalah 'terbaru'.
id	string	ID sumber daya
offer	string	Menentukan penawaran gambar platform atau gambar marketplace yang digunakan untuk membuat komputer virtual.
publisher	string	Penerbit gambar.
sharedGalleryImageId	string	Menentukan id unik gambar galeri bersama untuk penyebaran vm. Ini dapat diambil dari panggilan GET gambar galeri bersama.
sku	string	SKU gambar.
version	string	Menentukan versi gambar platform atau gambar marketplace yang digunakan untuk membuat komputer virtual. Format yang diizinkan adalah Major.Minor.Build atau 'latest'. Mayor, Minor, dan Build adalah angka desimal. Pilih 'terbaru' untuk menggunakan citra versi terbaru yang tersedia pada waktu penerapan. Bahkan jika Anda menggunakan 'terbaru', gambar VM tidak akan diperbarui secara otomatis setelah waktu penyebaran bahkan jika versi baru tersedia. Jangan gunakan bidang 'versi' untuk penyebaran gambar galeri, gambar galeri harus selalu menggunakan bidang 'id' untuk penyebaran, untuk menggunakan gambar galeri versi 'terbaru', cukup atur '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' di bidang 'id' tanpa input versi.

InnerError

Detail kesalahan dalam.

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

RollbackStatusInfo

Informasi tentang pembatalan pada instans VM yang gagal setelah operasi Peningkatan OS.

Name	Type	Description
failedRolledbackInstanceCount	integer	Jumlah instans yang gagal digulung balik.
rollbackError	ApiError	Detail kesalahan jika pembatalan OS gagal.
successfullyRolledbackInstanceCount	integer	Jumlah instans yang telah berhasil digulung balik.

RollingUpgradeProgressInfo

Informasi tentang jumlah instans komputer virtual di setiap status peningkatan.

Name	Type	Description
failedInstanceCount	integer	Jumlah instans yang gagal ditingkatkan dengan sukses.
inProgressInstanceCount	integer	Jumlah instans yang saat ini sedang ditingkatkan.
pendingInstanceCount	integer	Jumlah instans yang belum mulai ditingkatkan.
successfulInstanceCount	integer	Jumlah instans yang telah berhasil ditingkatkan.

UpgradeOperationHistoricalStatusInfo

Respons operasi Riwayat Peningkatan OS Set Skala Komputer Virtual.

Name	Type	Description
location	string	Lokasi sumber daya
properties	UpgradeOperationHistoricalStatusInfoProperties	Informasi tentang properti operasi peningkatan.
type	string	Jenis Sumber Daya

UpgradeOperationHistoricalStatusInfoProperties

Menjelaskan setiap peningkatan OS pada Virtual Machine Scale Set.

Name	Type	Description
error	ApiError	Detail Kesalahan untuk peningkatan ini jika ada.
progress	RollingUpgradeProgressInfo	Jumlah VM di setiap status.
rollbackInfo	RollbackStatusInfo	Informasi tentang pembatalan OS jika dilakukan
runningStatus	UpgradeOperationHistoryStatus	Informasi tentang status keseluruhan operasi peningkatan.
startedBy	UpgradeOperationInvoker	Pemanggil Operasi Peningkatan
targetImageReference	ImageReference	Detail Referensi Gambar

UpgradeOperationHistoryStatus

Informasi tentang status peningkatan keseluruhan yang sedang berjalan saat ini.

Name	Type	Description
code	UpgradeState	Kode yang menunjukkan status peningkatan saat ini.
endTime	string	Waktu akhir peningkatan.
startTime	string	Waktu mulai peningkatan.

UpgradeOperationInvoker

Pemanggil Operasi Peningkatan

Name	Type	Description
Platform	string
Unknown	string
User	string

UpgradeState

Kode yang menunjukkan status peningkatan saat ini.

Name	Type	Description
Cancelled	string
Completed	string
Faulted	string
RollingForward	string

VirtualMachineScaleSetListOSUpgradeHistory

Daftar respons operasi Riwayat Peningkatan OS Set Skala Komputer Virtual.

Name	Type	Description
nextLink	string	Uri untuk mengambil halaman berikutnya dari Riwayat Peningkatan OS. Panggil ListNext() dengan ini untuk mengambil halaman berikutnya dari riwayat peningkatan.
value	UpgradeOperationHistoricalStatusInfo[]	Daftar peningkatan OS yang dilakukan pada set skala komputer virtual.