Capacity Reservations - Get

Dienst:: Compute

API-Version:: 2026-03-01

Der Vorgang, der Informationen zur Kapazitätsreservierung abruft.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}?api-version=2026-03-01

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}?api-version=2026-03-01&$expand=instanceView

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
capacityReservationGroupName	path	True	string	Der Name der Kapazitätsreservierungsgruppe.
capacityReservationName	path	True	string	Der Name der Kapazitätsreservierung.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
$expand	query		CapacityReservationInstanceViewTypes	Der erweiterungsausdruck, der für den Vorgang angewendet werden soll. "InstanceView" ruft eine Momentaufnahme der Laufzeiteigenschaften der Kapazitätsreservierung ab, die von der Plattform verwaltet wird, und kann sich außerhalb der Steuerungsebenenvorgänge ändern.

Antworten

Name	Typ	Beschreibung
200 OK	CapacityReservation	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	CloudError	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Sich als Ihr Benutzerkonto ausgeben

Beispiele

Get a block capacity reservation.

Get a capacity reservation.

Get a targeted capacity reservation.

Get a block capacity reservation.

Beispielanforderung

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/blockCapacityReservationGroup/capacityReservations/blockCapacityReservation?api-version=2026-03-01&$expand=instanceView


import com.azure.resourcemanager.compute.models.CapacityReservationInstanceViewTypes;

/**
 * Samples for CapacityReservations Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-03-01/capacityReservationExamples/BlockCapacityReservation_Get.json
     */
    /**
     * Sample code: Get a block capacity reservation.
     * 
     * @param manager Entry point to ComputeManager.
     */
    public static void getABlockCapacityReservation(com.azure.resourcemanager.compute.ComputeManager manager) {
        manager.serviceClient().getCapacityReservations().getWithResponse("myResourceGroup",
            "blockCapacityReservationGroup", "blockCapacityReservation",
            CapacityReservationInstanceViewTypes.INSTANCE_VIEW, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python block_capacity_reservation_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.capacity_reservations.get(
        resource_group_name="myResourceGroup",
        capacity_reservation_group_name="blockCapacityReservationGroup",
        capacity_reservation_name="blockCapacityReservation",
    )
    print(response)


# x-ms-original-file: 2026-03-01/capacityReservationExamples/BlockCapacityReservation_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: 2026-03-01/capacityReservationExamples/BlockCapacityReservation_Get.json
func ExampleCapacityReservationsClient_Get_getABlockCapacityReservation() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("{subscriptionId}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCapacityReservationsClient().Get(ctx, "myResourceGroup", "blockCapacityReservationGroup", "blockCapacityReservation", &armcompute.CapacityReservationsClientGetOptions{
		Expand: to.Ptr(armcompute.CapacityReservationInstanceViewTypesInstanceView)})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armcompute.CapacityReservationsClientGetResponse{
	// 	CapacityReservation: armcompute.CapacityReservation{
	// 		ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/blockCapacityReservationGroup/capacityReservations/blockCapacityReservation"),
	// 		Properties: &armcompute.CapacityReservationProperties{
	// 			PlatformFaultDomainCount: to.Ptr[int32](3),
	// 			ReservationID: to.Ptr("{GUID}"),
	// 			ProvisioningTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-27T01:02:38.3138469+00:00"); return t}()),
	// 			VirtualMachinesAssociated: []*armcompute.SubResourceReadOnly{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1"),
	// 				},
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2"),
	// 				},
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM3"),
	// 				},
	// 			},
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			InstanceView: &armcompute.CapacityReservationInstanceView{
	// 				UtilizationInfo: &armcompute.CapacityReservationUtilization{
	// 					CurrentCapacity: to.Ptr[int32](5),
	// 					VirtualMachinesAllocated: []*armcompute.SubResourceReadOnly{
	// 						{
	// 							ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1"),
	// 						},
	// 						{
	// 							ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2"),
	// 						},
	// 					},
	// 				},
	// 				Statuses: []*armcompute.InstanceViewStatus{
	// 					{
	// 						Code: to.Ptr("ProvisioningState/succeeded"),
	// 						Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 						DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 					},
	// 				},
	// 			},
	// 			ScheduleProfile: &armcompute.ScheduleProfile{
	// 				Start: to.Ptr("2025-08-01T12:00:00Z"),
	// 				End: to.Ptr("2025-08-02T11:30:00Z"),
	// 			},
	// 			TimeCreated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-27T01:02:38.3138469+00:00"); return t}()),
	// 		},
	// 		Location: to.Ptr("westus"),
	// 		Tags: map[string]*string{
	// 			"department": to.Ptr("HR"),
	// 		},
	// 		SKU: &armcompute.SKU{
	// 			Name: to.Ptr("Standard_ND96isr_H100_v5"),
	// 			Capacity: to.Ptr[int64](1),
	// 		},
	// 		Zones: []*string{
	// 			to.Ptr("1"),
	// 		},
	// 		Name: to.Ptr("blockCapacityReservation"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

/**
 * This sample demonstrates how to the operation that retrieves information about the capacity reservation.
 *
 * @summary the operation that retrieves information about the capacity reservation.
 * x-ms-original-file: 2026-03-01/capacityReservationExamples/BlockCapacityReservation_Get.json
 */
async function getABlockCapacityReservation() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "{subscriptionId}";
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.capacityReservations.get(
    "myResourceGroup",
    "blockCapacityReservationGroup",
    "blockCapacityReservation",
    { expand: "instanceView" },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/blockCapacityReservationGroup/capacityReservations/blockCapacityReservation",
  "properties": {
    "platformFaultDomainCount": 3,
    "reservationId": "{GUID}",
    "provisioningTime": "2021-06-27T01:02:38.3138469+00:00",
    "virtualMachinesAssociated": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1"
      },
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2"
      },
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM3"
      }
    ],
    "provisioningState": "Succeeded",
    "instanceView": {
      "utilizationInfo": {
        "currentCapacity": 5,
        "virtualMachinesAllocated": [
          {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1"
          },
          {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2"
          }
        ]
      },
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded"
        }
      ]
    },
    "scheduleProfile": {
      "start": "2025-08-01T12:00:00Z",
      "end": "2025-08-02T11:30:00Z"
    },
    "timeCreated": "2021-06-27T01:02:38.3138469+00:00"
  },
  "location": "westus",
  "tags": {
    "department": "HR"
  },
  "sku": {
    "name": "Standard_ND96isr_H100_v5",
    "capacity": 1
  },
  "zones": [
    "1"
  ],
  "name": "blockCapacityReservation"
}

Get a capacity reservation.

Beispielanforderung

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation?api-version=2026-03-01&$expand=instanceView


import com.azure.resourcemanager.compute.models.CapacityReservationInstanceViewTypes;

/**
 * Samples for CapacityReservations Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-03-01/capacityReservationExamples/CapacityReservation_Get.json
     */
    /**
     * Sample code: Get a capacity reservation.
     * 
     * @param manager Entry point to ComputeManager.
     */
    public static void getACapacityReservation(com.azure.resourcemanager.compute.ComputeManager manager) {
        manager.serviceClient().getCapacityReservations().getWithResponse("myResourceGroup",
            "myCapacityReservationGroup", "myCapacityReservation", CapacityReservationInstanceViewTypes.INSTANCE_VIEW,
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python capacity_reservation_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.capacity_reservations.get(
        resource_group_name="myResourceGroup",
        capacity_reservation_group_name="myCapacityReservationGroup",
        capacity_reservation_name="myCapacityReservation",
    )
    print(response)


# x-ms-original-file: 2026-03-01/capacityReservationExamples/CapacityReservation_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: 2026-03-01/capacityReservationExamples/CapacityReservation_Get.json
func ExampleCapacityReservationsClient_Get_getACapacityReservation() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("{subscriptionId}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCapacityReservationsClient().Get(ctx, "myResourceGroup", "myCapacityReservationGroup", "myCapacityReservation", &armcompute.CapacityReservationsClientGetOptions{
		Expand: to.Ptr(armcompute.CapacityReservationInstanceViewTypesInstanceView)})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armcompute.CapacityReservationsClientGetResponse{
	// 	CapacityReservation: armcompute.CapacityReservation{
	// 		ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation"),
	// 		Properties: &armcompute.CapacityReservationProperties{
	// 			PlatformFaultDomainCount: to.Ptr[int32](3),
	// 			ReservationID: to.Ptr("{GUID}"),
	// 			ProvisioningTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-27T01:02:38.3138469+00:00"); return t}()),
	// 			VirtualMachinesAssociated: []*armcompute.SubResourceReadOnly{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1"),
	// 				},
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2"),
	// 				},
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM3"),
	// 				},
	// 			},
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			InstanceView: &armcompute.CapacityReservationInstanceView{
	// 				UtilizationInfo: &armcompute.CapacityReservationUtilization{
	// 					CurrentCapacity: to.Ptr[int32](5),
	// 					VirtualMachinesAllocated: []*armcompute.SubResourceReadOnly{
	// 						{
	// 							ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1"),
	// 						},
	// 						{
	// 							ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2"),
	// 						},
	// 					},
	// 				},
	// 				Statuses: []*armcompute.InstanceViewStatus{
	// 					{
	// 						Code: to.Ptr("ProvisioningState/succeeded"),
	// 						Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 						DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 					},
	// 				},
	// 			},
	// 			TimeCreated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-27T01:02:38.3138469+00:00"); return t}()),
	// 		},
	// 		Location: to.Ptr("westus"),
	// 		Tags: map[string]*string{
	// 			"department": to.Ptr("HR"),
	// 		},
	// 		SKU: &armcompute.SKU{
	// 			Name: to.Ptr("Standard_DS1_v2"),
	// 			Capacity: to.Ptr[int64](4),
	// 		},
	// 		Zones: []*string{
	// 			to.Ptr("1"),
	// 		},
	// 		Name: to.Ptr("myCapacityReservation"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

/**
 * This sample demonstrates how to the operation that retrieves information about the capacity reservation.
 *
 * @summary the operation that retrieves information about the capacity reservation.
 * x-ms-original-file: 2026-03-01/capacityReservationExamples/CapacityReservation_Get.json
 */
async function getACapacityReservation() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "{subscriptionId}";
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.capacityReservations.get(
    "myResourceGroup",
    "myCapacityReservationGroup",
    "myCapacityReservation",
    { expand: "instanceView" },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation",
  "properties": {
    "platformFaultDomainCount": 3,
    "reservationId": "{GUID}",
    "provisioningTime": "2021-06-27T01:02:38.3138469+00:00",
    "virtualMachinesAssociated": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1"
      },
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2"
      },
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM3"
      }
    ],
    "provisioningState": "Succeeded",
    "instanceView": {
      "utilizationInfo": {
        "currentCapacity": 5,
        "virtualMachinesAllocated": [
          {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1"
          },
          {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2"
          }
        ]
      },
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded"
        }
      ]
    },
    "timeCreated": "2021-06-27T01:02:38.3138469+00:00"
  },
  "location": "westus",
  "tags": {
    "department": "HR"
  },
  "sku": {
    "name": "Standard_DS1_v2",
    "capacity": 4
  },
  "zones": [
    "1"
  ],
  "name": "myCapacityReservation"
}

Get a targeted capacity reservation.

Beispielanforderung

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/targetedCapacityReservationGroup/capacityReservations/targetedCapacityReservation?api-version=2026-03-01&$expand=instanceView


import com.azure.resourcemanager.compute.models.CapacityReservationInstanceViewTypes;

/**
 * Samples for CapacityReservations Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-03-01/capacityReservationExamples/TargetedCapacityReservation_Get.json
     */
    /**
     * Sample code: Get a targeted capacity reservation.
     * 
     * @param manager Entry point to ComputeManager.
     */
    public static void getATargetedCapacityReservation(com.azure.resourcemanager.compute.ComputeManager manager) {
        manager.serviceClient().getCapacityReservations().getWithResponse("myResourceGroup",
            "targetedCapacityReservationGroup", "targetedCapacityReservation",
            CapacityReservationInstanceViewTypes.INSTANCE_VIEW, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python targeted_capacity_reservation_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.capacity_reservations.get(
        resource_group_name="myResourceGroup",
        capacity_reservation_group_name="targetedCapacityReservationGroup",
        capacity_reservation_name="targetedCapacityReservation",
    )
    print(response)


# x-ms-original-file: 2026-03-01/capacityReservationExamples/TargetedCapacityReservation_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: 2026-03-01/capacityReservationExamples/TargetedCapacityReservation_Get.json
func ExampleCapacityReservationsClient_Get_getATargetedCapacityReservation() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("{subscriptionId}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCapacityReservationsClient().Get(ctx, "myResourceGroup", "targetedCapacityReservationGroup", "targetedCapacityReservation", &armcompute.CapacityReservationsClientGetOptions{
		Expand: to.Ptr(armcompute.CapacityReservationInstanceViewTypesInstanceView)})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armcompute.CapacityReservationsClientGetResponse{
	// 	CapacityReservation: armcompute.CapacityReservation{
	// 		ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/targetedCapacityReservationGroup/capacityReservations/targetedCapacityReservation"),
	// 		Properties: &armcompute.CapacityReservationProperties{
	// 			PlatformFaultDomainCount: to.Ptr[int32](3),
	// 			ReservationID: to.Ptr("{GUID}"),
	// 			ProvisioningTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-27T01:02:38.3138469+00:00"); return t}()),
	// 			VirtualMachinesAssociated: []*armcompute.SubResourceReadOnly{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1"),
	// 				},
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2"),
	// 				},
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM3"),
	// 				},
	// 			},
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			InstanceView: &armcompute.CapacityReservationInstanceView{
	// 				UtilizationInfo: &armcompute.CapacityReservationUtilization{
	// 					CurrentCapacity: to.Ptr[int32](5),
	// 					VirtualMachinesAllocated: []*armcompute.SubResourceReadOnly{
	// 						{
	// 							ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1"),
	// 						},
	// 						{
	// 							ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2"),
	// 						},
	// 					},
	// 				},
	// 				Statuses: []*armcompute.InstanceViewStatus{
	// 					{
	// 						Code: to.Ptr("ProvisioningState/succeeded"),
	// 						Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 						DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 					},
	// 				},
	// 			},
	// 			TimeCreated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-27T01:02:38.3138469+00:00"); return t}()),
	// 		},
	// 		Location: to.Ptr("westus"),
	// 		Tags: map[string]*string{
	// 			"department": to.Ptr("HR"),
	// 		},
	// 		SKU: &armcompute.SKU{
	// 			Name: to.Ptr("Standard_DS1_v2"),
	// 			Capacity: to.Ptr[int64](4),
	// 		},
	// 		Zones: []*string{
	// 			to.Ptr("1"),
	// 		},
	// 		Name: to.Ptr("targetedCapacityReservation"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

/**
 * This sample demonstrates how to the operation that retrieves information about the capacity reservation.
 *
 * @summary the operation that retrieves information about the capacity reservation.
 * x-ms-original-file: 2026-03-01/capacityReservationExamples/TargetedCapacityReservation_Get.json
 */
async function getATargetedCapacityReservation() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "{subscriptionId}";
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.capacityReservations.get(
    "myResourceGroup",
    "targetedCapacityReservationGroup",
    "targetedCapacityReservation",
    { expand: "instanceView" },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/targetedCapacityReservationGroup/capacityReservations/targetedCapacityReservation",
  "properties": {
    "platformFaultDomainCount": 3,
    "reservationId": "{GUID}",
    "provisioningTime": "2021-06-27T01:02:38.3138469+00:00",
    "virtualMachinesAssociated": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1"
      },
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2"
      },
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM3"
      }
    ],
    "provisioningState": "Succeeded",
    "instanceView": {
      "utilizationInfo": {
        "currentCapacity": 5,
        "virtualMachinesAllocated": [
          {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1"
          },
          {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2"
          }
        ]
      },
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded"
        }
      ]
    },
    "timeCreated": "2021-06-27T01:02:38.3138469+00:00"
  },
  "location": "westus",
  "tags": {
    "department": "HR"
  },
  "sku": {
    "name": "Standard_DS1_v2",
    "capacity": 4
  },
  "zones": [
    "1"
  ],
  "name": "targetedCapacityReservation"
}

Definitionen

Name	Beschreibung
ApiError	API-Fehler.
ApiErrorBase	API-Fehlerbasis.
CapacityReservation	Gibt Informationen zur Kapazitätsreservierung an.
CapacityReservationInstanceView	Die Instanzansicht einer Kapazitätsreservierung, die als Momentaufnahme der Laufzeiteigenschaften der Kapazitätsreservierung bereitgestellt wird, die von der Plattform verwaltet wird, und kann sich außerhalb der Steuerungsebenenvorgänge ändern.
CapacityReservationInstanceViewTypes
CapacityReservationUtilization	Stellt die Kapazitätsreservierungsauslastung in Bezug auf zugeordnete Ressourcen dar.
CloudError	Eine Fehlerantwort vom Compute-Dienst.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
InnerError	Innere Fehlerdetails.
InstanceViewStatus	Instanzansichtsstatus.
ScheduleProfile	Definiert den Zeitplan für Kapazitätsreservierungen vom Typ Block. Gibt den Zeitplan an, während dessen die Kapazitätsreservierung aktiv ist und eine VM oder VMSS-Ressource mithilfe der Reservierung zugeordnet werden kann. Diese Eigenschaft ist erforderlich und wird nur unterstützt, wenn der Kapazitätsreservierungsgruppentyp "Block" ist. Die Felder scheduleProfile, start und end sind nach der Erstellung unveränderlich. Minimale API-Version: 2025-04-01. Weitere Informationen finden Sie unter https://aka.ms/blockcapacityreservation.
Sku	Beschreibt eine VM-Skalierungssatz-SKU. HINWEIS: Wenn die neue VM-SKU auf der Hardware, auf der der Skalierungssatz derzeit installiert ist, nicht unterstützt wird, müssen Sie die virtuellen Computer im Skalierungssatz umstellen, bevor Sie den SKU-Namen ändern.
StatusLevelTypes	Der Ebenencode.
SubResourceReadOnly
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

ApiError

Objekt

API-Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	ApiErrorBase[]	Die Details zum API-Fehler
innererror	InnerError	Der innere API-Fehler
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

ApiErrorBase

Objekt

API-Fehlerbasis.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

CapacityReservation

Objekt

Gibt Informationen zur Kapazitätsreservierung an.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.instanceView	CapacityReservationInstanceView	Die Ansicht der Kapazitätsreservierungsinstanz.
properties.platformFaultDomainCount	integer (int32)	Gibt den Wert der Fehlerdomänenanzahl an, die die Kapazitätsreservierung für die angeforderte VM-Größe unterstützt. Hinweis: Die für eine Ressource angegebene Fehlerdomänenanzahl (z. B. skalierungssatz virtueller Computer) muss kleiner oder gleich diesem Wert sein, wenn er mithilfe der Kapazitätsreservierung bereitgestellt wird. Mindest-API-Version: 2022-08-01.
properties.provisioningState	string	Der Bereitstellungsstatus, der nur in der Antwort angezeigt wird.
properties.provisioningTime	string (date-time)	Datum, zu dem die Kapazitätsreservierung zuletzt aktualisiert wurde.
properties.reservationId	string	Eine eindeutige ID, die von der Plattform generiert und der Kapazitätsreservierung zugewiesen wird, die sich während der gesamten Lebensdauer der Ressource nicht ändert.
properties.scheduleProfile	ScheduleProfile	Definiert den Zeitplan für Kapazitätsreservierungen vom Typ Block. Gibt den Zeitplan an, während dessen die Kapazitätsreservierung aktiv ist und eine VM oder VMSS-Ressource mithilfe der Reservierung zugeordnet werden kann. Diese Eigenschaft ist erforderlich und wird nur unterstützt, wenn der Kapazitätsreservierungsgruppentyp "Block" ist. Die Felder scheduleProfile, start und end sind nach der Erstellung unveränderlich. Minimale API-Version: 2025-04-01. Weitere Informationen finden Sie unter https://aka.ms/blockcapacityreservation.
properties.timeCreated	string (date-time)	Gibt den Zeitpunkt an, zu dem die Kapazitätsreservierungsressource erstellt wurde. Mindest-API-Version: 2021-11-01.
properties.virtualMachinesAssociated	SubResourceReadOnly[]	Eine Liste aller RESSOURCEN-IDs des virtuellen Computers, die der Kapazitätsreservierung zugeordnet sind.
sku	Sku	SKU der Ressource, für die Kapazität reserviert werden muss. Der SKU-Name und die Kapazität müssen festgelegt werden. Für Blockkapazitätsreservierungen kann sku.capacity nur die Werte 1, 2, 4, 8, 16, 32, 64 akzeptieren. Derzeit werden VM-Skus mit der Funktion "CapacityReservationSupported" auf "true" festgelegt. Wenn "CapacityReservationSupported" auf "true" festgelegt ist, gibt die SKU-Funktion auch "SupportedCapacityReservationTypes" an, in dem die Typen von Kapazitätsreservierungen (z. B. "Targeting" oder "Block") aufgeführt sind, die von der SKU unterstützt werden. Informationen zu unterstützten Werten finden Sie unter "Auflisten von Microsoft.Compute-SKUs in einer Region (https://docs.microsoft.com/rest/api/compute/resourceskus/list).
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object	Ressourcenkennzeichnungen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"
zones	string[]	Die Verfügbarkeitszonen.

CapacityReservationInstanceView

Objekt

Die Instanzansicht einer Kapazitätsreservierung, die als Momentaufnahme der Laufzeiteigenschaften der Kapazitätsreservierung bereitgestellt wird, die von der Plattform verwaltet wird, und kann sich außerhalb der Steuerungsebenenvorgänge ändern.

Name	Typ	Beschreibung
statuses	InstanceViewStatus[]	Die Ressourcenstatusinformationen.
utilizationInfo	CapacityReservationUtilization	Nicht genutzte Kapazität der Kapazitätsreservierung.

CapacityReservationInstanceViewTypes

Enumeration

Wert	Beschreibung
instanceView

CapacityReservationUtilization

Objekt

Stellt die Kapazitätsreservierungsauslastung in Bezug auf zugeordnete Ressourcen dar.

Name	Typ	Beschreibung
currentCapacity	integer (int32)	Der Wert stellt die aktuelle Kapazität der VM-Größe bereit, die erfolgreich reserviert wurde und für die der Kunde in Rechnung gestellt wird. Mindest-API-Version: 2022-08-01.
virtualMachinesAllocated	SubResourceReadOnly[]	Eine Liste aller ressourcen-IDs aller virtuellen Computer, die der Kapazitätsreservierung zugeordnet sind.

CloudError

Objekt

Eine Fehlerantwort vom Compute-Dienst.

Name	Typ	Beschreibung
error	ApiError	API-Fehler.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

InnerError

Objekt

Innere Fehlerdetails.

Name	Typ	Beschreibung
errordetail	string	Die interne Fehlermeldung oder der Ausnahmedump.
exceptiontype	string	Der Ausnahmetyp.

InstanceViewStatus

Objekt

Instanzansichtsstatus.

Name	Typ	Beschreibung
code	string	Der Statuscode.
displayStatus	string	Die kurze lokalisierbare Bezeichnung für den Status.
level	StatusLevelTypes	Der Ebenencode.
message	string	Die detaillierte Statusmeldung, einschließlich warnungen und Fehlermeldungen.
time	string (date-time)	Die Uhrzeit des Status.

ScheduleProfile

Objekt

Definiert den Zeitplan für Kapazitätsreservierungen vom Typ Block. Gibt den Zeitplan an, während dessen die Kapazitätsreservierung aktiv ist und eine VM oder VMSS-Ressource mithilfe der Reservierung zugeordnet werden kann. Diese Eigenschaft ist erforderlich und wird nur unterstützt, wenn der Kapazitätsreservierungsgruppentyp "Block" ist. Die Felder scheduleProfile, start und end sind nach der Erstellung unveränderlich. Minimale API-Version: 2025-04-01. Weitere Informationen finden Sie unter https://aka.ms/blockcapacityreservation.

Name	Typ	Beschreibung
end	string	Das erforderliche Enddatum für Blockkapazitätsreservierungen. Muss nach dem Startdatum liegen, mit einer Dauer von entweder 1-14 ganzen Tagen oder 3-26 ganzen Wochen. Beispiel: 28.06.2025.
start	string	Das erforderliche Startdatum für Blockkapazitätsreservierungen. Muss heute oder innerhalb von 56 Tagen in der Zukunft sein. Für die Planung am selben Tag müssen Anfragen vor 11:30 Uhr UTC eingereicht werden. Beispiel: 27.06.2025.

Sku

Objekt

Beschreibt eine VM-Skalierungssatz-SKU. HINWEIS: Wenn die neue VM-SKU auf der Hardware, auf der der Skalierungssatz derzeit installiert ist, nicht unterstützt wird, müssen Sie die virtuellen Computer im Skalierungssatz umstellen, bevor Sie den SKU-Namen ändern.

Name	Typ	Beschreibung
capacity	integer (int64)	Gibt die Anzahl der virtuellen Computer im Skalierungssatz an.
name	string	Der Sku-Name.
tier	string	Gibt die Ebene der virtuellen Computer in einem Skalierungssatz an. Mögliche Werte: Standard Basic

StatusLevelTypes

Enumeration

Der Ebenencode.

Wert	Beschreibung
Info
Warning
Error

SubResourceReadOnly

Objekt

Name	Typ	Beschreibung
id	string	Ressourcen-ID

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.