Standby Virtual Machine Pools - Create Or Update

Service:

Standby Pools

API Version:

2024-03-01

Create a StandbyVirtualMachinePoolResource

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/{standbyVirtualMachinePoolName}?api-version=2024-03-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
standbyVirtualMachinePoolName	path	True	string	Name of the standby virtual machine pool Regex pattern: ^[a-zA-Z0-9-]{3,24}$
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	The geo-location where the resource lives
properties.virtualMachineState	True	VirtualMachineState	Specifies the desired state of virtual machines in the pool.
properties.attachedVirtualMachineScaleSetId		string	Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
properties.elasticityProfile		StandbyVirtualMachinePoolElasticityProfile	Specifies the elasticity profile of the standby virtual machine pools.
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	StandbyVirtualMachinePoolResource	Resource 'StandbyVirtualMachinePoolResource' update operation succeeded
201 Created	StandbyVirtualMachinePoolResource	Resource 'StandbyVirtualMachinePoolResource' create operation succeeded Headers Retry-After: integer
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

StandbyVirtualMachinePools_CreateOrUpdate

Sample request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/pool?api-version=2024-03-01

{
  "properties": {
    "elasticityProfile": {
      "maxReadyCapacity": 304,
      "minReadyCapacity": 300
    },
    "virtualMachineState": "Running",
    "attachedVirtualMachineScaleSetId": "/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss"
  },
  "tags": {},
  "location": "West US"
}

Java

import com.azure.resourcemanager.standbypool.models.StandbyVirtualMachinePoolElasticityProfile;
import com.azure.resourcemanager.standbypool.models.StandbyVirtualMachinePoolResourceProperties;
import com.azure.resourcemanager.standbypool.models.VirtualMachineState;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for StandbyVirtualMachinePools CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2024-03-01/StandbyVirtualMachinePools_CreateOrUpdate.json
     */
    /**
     * Sample code: StandbyVirtualMachinePools_CreateOrUpdate.
     * 
     * @param manager Entry point to StandbyPoolManager.
     */
    public static void
        standbyVirtualMachinePoolsCreateOrUpdate(com.azure.resourcemanager.standbypool.StandbyPoolManager manager) {
        manager.standbyVirtualMachinePools().define("pool").withRegion("West US")
            .withExistingResourceGroup("rgstandbypool").withTags(mapOf())
            .withProperties(new StandbyVirtualMachinePoolResourceProperties()
                .withElasticityProfile(new StandbyVirtualMachinePoolElasticityProfile().withMaxReadyCapacity(304L)
                    .withMinReadyCapacity(300L))
                .withVirtualMachineState(VirtualMachineState.RUNNING).withAttachedVirtualMachineScaleSetId(
                    "/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss"))
            .create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.standbypool import StandbyPoolMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-standbypool
# USAGE
    python standby_virtual_machine_pools_create_or_update.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 = StandbyPoolMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.standby_virtual_machine_pools.begin_create_or_update(
        resource_group_name="rgstandbypool",
        standby_virtual_machine_pool_name="pool",
        resource={
            "location": "West US",
            "properties": {
                "attachedVirtualMachineScaleSetId": "/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss",
                "elasticityProfile": {"maxReadyCapacity": 304, "minReadyCapacity": 300},
                "virtualMachineState": "Running",
            },
            "tags": {},
        },
    ).result()
    print(response)


# x-ms-original-file: 2024-03-01/StandbyVirtualMachinePools_CreateOrUpdate.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

Go

package armstandbypool_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/standbypool/armstandbypool"
)

// Generated from example definition: 2024-03-01/StandbyVirtualMachinePools_CreateOrUpdate.json
func ExampleStandbyVirtualMachinePoolsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstandbypool.NewClientFactory("00000000-0000-0000-0000-000000000009", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewStandbyVirtualMachinePoolsClient().BeginCreateOrUpdate(ctx, "rgstandbypool", "pool", armstandbypool.StandbyVirtualMachinePoolResource{
		Properties: &armstandbypool.StandbyVirtualMachinePoolResourceProperties{
			ElasticityProfile: &armstandbypool.StandbyVirtualMachinePoolElasticityProfile{
				MaxReadyCapacity: to.Ptr[int64](304),
				MinReadyCapacity: to.Ptr[int64](300),
			},
			VirtualMachineState:              to.Ptr(armstandbypool.VirtualMachineStateRunning),
			AttachedVirtualMachineScaleSetID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss"),
		},
		Tags:     map[string]*string{},
		Location: to.Ptr("West US"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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 = armstandbypool.StandbyVirtualMachinePoolsClientCreateOrUpdateResponse{
	// 	StandbyVirtualMachinePoolResource: &armstandbypool.StandbyVirtualMachinePoolResource{
	// 		Properties: &armstandbypool.StandbyVirtualMachinePoolResourceProperties{
	// 			ElasticityProfile: &armstandbypool.StandbyVirtualMachinePoolElasticityProfile{
	// 				MaxReadyCapacity: to.Ptr[int64](304),
	// 				MinReadyCapacity: to.Ptr[int64](300),
	// 			},
	// 			VirtualMachineState: to.Ptr(armstandbypool.VirtualMachineStateRunning),
	// 			AttachedVirtualMachineScaleSetID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss"),
	// 			ProvisioningState: to.Ptr(armstandbypool.ProvisioningStateSucceeded),
	// 		},
	// 		Tags: map[string]*string{
	// 		},
	// 		Location: to.Ptr("West US"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/pool"),
	// 		Name: to.Ptr("pool"),
	// 		Type: to.Ptr("Microsoft.StandbyPool/standbyVirtualMachinePools"),
	// 		SystemData: &armstandbypool.SystemData{
	// 			CreatedBy: to.Ptr("pooluser@microsoft.com"),
	// 			CreatedByType: to.Ptr(armstandbypool.CreatedByTypeUser),
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-09-07T16:33:22.210Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("pooluser@microsoft.com"),
	// 			LastModifiedByType: to.Ptr(armstandbypool.CreatedByTypeUser),
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-09-07T16:33:22.210Z"); return t}()),
	// 		},
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to create a StandbyVirtualMachinePoolResource
 *
 * @summary create a StandbyVirtualMachinePoolResource
 * x-ms-original-file: 2024-03-01/StandbyVirtualMachinePools_CreateOrUpdate.json
 */
async function standbyVirtualMachinePoolsCreateOrUpdate() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000009";
  const client = new StandbyPoolManagementClient(credential, subscriptionId);
  const result = await client.standbyVirtualMachinePools.createOrUpdate("rgstandbypool", "pool", {
    properties: {
      elasticityProfile: { maxReadyCapacity: 304, minReadyCapacity: 300 },
      virtualMachineState: "Running",
      attachedVirtualMachineScaleSetId:
        "/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss",
    },
    tags: {},
    location: "West US",
  });
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.StandbyPool.Models;
using Azure.ResourceManager.StandbyPool;

// Generated from example definition: specification/standbypool/resource-manager/Microsoft.StandbyPool/stable/2024-03-01/examples/StandbyVirtualMachinePools_CreateOrUpdate.json
// this example is just showing the usage of "StandbyVirtualMachinePools_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "00000000-0000-0000-0000-000000000009";
string resourceGroupName = "rgstandbypool";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this StandbyVirtualMachinePoolResource
StandbyVirtualMachinePoolCollection collection = resourceGroupResource.GetStandbyVirtualMachinePools();

// invoke the operation
string standbyVirtualMachinePoolName = "pool";
StandbyVirtualMachinePoolData data = new StandbyVirtualMachinePoolData(new AzureLocation("West US"))
{
    Properties = new StandbyVirtualMachinePoolProperties(StandbyVirtualMachineState.Running)
    {
        ElasticityProfile = new StandbyVirtualMachinePoolElasticityProfile(304)
        {
            MinReadyCapacity = 300,
        },
        AttachedVirtualMachineScaleSetId = new ResourceIdentifier("/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss"),
    },
    Tags =
    {
    },
};
ArmOperation<StandbyVirtualMachinePoolResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, standbyVirtualMachinePoolName, data);
StandbyVirtualMachinePoolResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
StandbyVirtualMachinePoolData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Sample response

Status code:

200

{
  "properties": {
    "elasticityProfile": {
      "maxReadyCapacity": 304,
      "minReadyCapacity": 300
    },
    "virtualMachineState": "Running",
    "attachedVirtualMachineScaleSetId": "/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss",
    "provisioningState": "Succeeded"
  },
  "tags": {},
  "location": "West US",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/pool",
  "name": "pool",
  "type": "Microsoft.StandbyPool/standbyVirtualMachinePools",
  "systemData": {
    "createdBy": "pooluser@microsoft.com",
    "createdByType": "User",
    "createdAt": "2023-09-07T16:33:22.210Z",
    "lastModifiedBy": "pooluser@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2023-09-07T16:33:22.210Z"
  }
}

Status code:

201

Azure-AsyncOperation: https://contoso.com/operationstatus

{
  "properties": {
    "elasticityProfile": {
      "maxReadyCapacity": 304,
      "minReadyCapacity": 300
    },
    "virtualMachineState": "Running",
    "attachedVirtualMachineScaleSetId": "/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss",
    "provisioningState": "Succeeded"
  },
  "tags": {},
  "location": "West US",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/pool",
  "name": "pool",
  "type": "Microsoft.StandbyPool/standbyVirtualMachinePools",
  "systemData": {
    "createdBy": "pooluser@microsoft.com",
    "createdByType": "User",
    "createdAt": "2023-09-07T16:33:22.210Z",
    "lastModifiedBy": "pooluser@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2023-09-07T16:33:22.210Z"
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ProvisioningState	Provisioning state
StandbyVirtualMachinePoolElasticityProfile	Details of the elasticity profile.
StandbyVirtualMachinePoolResource	A StandbyVirtualMachinePoolResource.
systemData	Metadata pertaining to creation and last modification of the resource.
VirtualMachineState	State of standby virtual machines

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ProvisioningState

Provisioning state

Name	Type	Description
Canceled	string	Resource creation was canceled.
Deleting	string	Resource is being deleted.
Failed	string	Resource creation failed.
Succeeded	string	Resource has been created.

StandbyVirtualMachinePoolElasticityProfile

Details of the elasticity profile.

Name	Type	Description
maxReadyCapacity	integer	Specifies the maximum number of virtual machines in the standby virtual machine pool.
minReadyCapacity	integer	Specifies the desired minimum number of virtual machines in the standby virtual machine pool. MinReadyCapacity cannot exceed MaxReadyCapacity.

StandbyVirtualMachinePoolResource

A StandbyVirtualMachinePoolResource.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.attachedVirtualMachineScaleSetId	string	Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
properties.elasticityProfile	StandbyVirtualMachinePoolElasticityProfile	Specifies the elasticity profile of the standby virtual machine pools.
properties.provisioningState	ProvisioningState	The status of the last operation.
properties.virtualMachineState	VirtualMachineState	Specifies the desired state of virtual machines in the pool.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

VirtualMachineState

State of standby virtual machines

Name	Type	Description
Deallocated	string	The virtual machine has released the lease on the underlying hardware and is powered off.
Running	string	The virtual machine is up and running.