Standby Virtual Machine Pools - Create Or Update

Service:

Standby Pools

API-versie:

2024-03-01

Een StandbyVirtualMachinePoolResource maken

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
standbyVirtualMachinePoolName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Naam van de stand-by-vm-pool
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
location	True	string	De geografische locatie waar de resource zich bevindt
properties.virtualMachineState	True	VirtualMachineState	Hiermee geeft u de gewenste status van virtuele machines in de pool.
properties.attachedVirtualMachineScaleSetId		string (arm-id)	Hiermee geeft u de volledig gekwalificeerde resource-id op van een virtuele-machineschaalset waaraan de pool is gekoppeld.
properties.elasticityProfile		StandbyVirtualMachinePoolElasticityProfile	Hiermee geeft u het elasticiteitsprofiel van de stand-by-vm-pools.
tags		object	Resourcetags.

Antwoorden

Name	Type	Description
200 OK	StandbyVirtualMachinePoolResource	Updatebewerking 'StandbyVirtualMachinePoolResource' is voltooid
201 Created	StandbyVirtualMachinePoolResource	De resource 'StandbyVirtualMachinePoolResource' is gemaakt Kopteksten Retry-After: integer
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

StandbyVirtualMachinePools_CreateOrUpdate

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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"
  }
}

Statuscode:

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"
  }
}

Definities

Name	Description
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
ProvisioningState	Inrichtingsstatus
StandbyVirtualMachinePoolElasticityProfile	Details van het elasticiteitsprofiel.
StandbyVirtualMachinePoolResource	Een StandbyVirtualMachinePoolResource.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
VirtualMachineState	Status van stand-by virtuele machines

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

ProvisioningState

Inventarisatie

Inrichtingsstatus

Waarde	Description
Canceled	Het maken van resources is geannuleerd.
Deleting	De resource wordt verwijderd.
Failed	Het maken van resources is mislukt.
Succeeded	De resource is gemaakt.

StandbyVirtualMachinePoolElasticityProfile

Object

Details van het elasticiteitsprofiel.

Name	Type	Description
maxReadyCapacity	integer (int64) minimum: 0 maximum: 2000	Hiermee geeft u het maximum aantal virtuele machines in de stand-by-vm-pool.
minReadyCapacity	integer (int64) minimum: 0 maximum: 2000	Hiermee geeft u het gewenste minimum aantal virtuele machines in de stand-by-vm-pool. MinReadyCapacity kan maxReadyCapacity niet overschrijden.

StandbyVirtualMachinePoolResource

Object

Een StandbyVirtualMachinePoolResource.

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.attachedVirtualMachineScaleSetId	string (arm-id)	Hiermee geeft u de volledig gekwalificeerde resource-id op van een virtuele-machineschaalset waaraan de pool is gekoppeld.
properties.elasticityProfile	StandbyVirtualMachinePoolElasticityProfile	Hiermee geeft u het elasticiteitsprofiel van de stand-by-vm-pools.
properties.provisioningState	ProvisioningState	De status van de laatste bewerking.
properties.virtualMachineState	VirtualMachineState	Hiermee geeft u de gewenste status van virtuele machines in de pool.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
tags	object	Resourcetags.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

VirtualMachineState

Inventarisatie

Status van stand-by virtuele machines

Waarde	Description
Deallocated	De virtuele machine heeft de lease op de onderliggende hardware vrijgegeven en wordt uitgeschakeld.
Running	De virtuele machine is actief.