Standby Virtual Machine Pools - Create Or Update

Referencia

Servicio:: Standby Pools

Versión de la API:: 2023-12-01-preview

Creación de un objeto StandbyVirtualMachinePoolResource

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
standbyVirtualMachinePoolName	path	True	string	Nombre del grupo de máquinas virtuales en espera Patrón de Regex: `^[a-zA-Z0-9-]{3,24}$`
subscriptionId	path	True	string uuid	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
location	True	string	Ubicación geográfica donde reside el recurso
properties.virtualMachineState	True	VirtualMachineState	Especifica el estado deseado de las máquinas virtuales del grupo.
properties.attachedVirtualMachineScaleSetId		string	Especifica el identificador de recurso completo de un conjunto de escalado de máquinas virtuales al que está asociado el grupo.
properties.elasticityProfile		StandbyVirtualMachinePoolElasticityProfile	Especifica el perfil de elasticidad de los grupos de máquinas virtuales en espera.
tags		object	Etiquetas del recurso.

Respuestas

Nombre	Tipo	Description
200 OK	StandbyVirtualMachinePoolResource	Operación de actualización "StandbyVirtualMachinePoolResource" del recurso correcta
201 Created	StandbyVirtualMachinePoolResource	La operación de creación "StandbyVirtualMachinePoolResource" del recurso se realizó correctamente Encabezados Retry-After: integer
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Nombre

Tipo

Description

200 OK

StandbyVirtualMachinePoolResource

Operación de actualización "StandbyVirtualMachinePoolResource" del recurso correcta

201 Created

StandbyVirtualMachinePoolResource

La operación de creación "StandbyVirtualMachinePoolResource" del recurso se realizó correctamente

Encabezados

Retry-After: integer

Other Status Codes

ErrorResponse

Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

StandbyVirtualMachinePools_CreateOrUpdate

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/8CC31D61-82D7-4B2B-B9DC-6B924DE7D229/resourceGroups/rgstandbypool/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/pool?api-version=2023-12-01-preview

{
  "properties": {
    "elasticityProfile": {
      "maxReadyCapacity": 304
    },
    "virtualMachineState": "Running",
    "attachedVirtualMachineScaleSetId": "/subscriptions/8CC31D61-82D7-4B2B-B9DC-6B924DE7D229/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss"
  },
  "tags": {},
  "location": "West US"
}

from typing import Any, IO, Union

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="8CC31D61-82D7-4B2B-B9DC-6B924DE7D229",
    )

    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/8CC31D61-82D7-4B2B-B9DC-6B924DE7D229/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss",
                "elasticityProfile": {"maxReadyCapacity": 304},
                "virtualMachineState": "Running",
            },
            "tags": {},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/standbypool/resource-manager/Microsoft.StandbyPool/preview/2023-12-01-preview/examples/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

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: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/standbypool/resource-manager/Microsoft.StandbyPool/preview/2023-12-01-preview/examples/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("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewStandbyVirtualMachinePoolsClient().BeginCreateOrUpdate(ctx, "rgstandbypool", "pool", armstandbypool.StandbyVirtualMachinePoolResource{
		Location: to.Ptr("West US"),
		Tags:     map[string]*string{},
		Properties: &armstandbypool.StandbyVirtualMachinePoolResourceProperties{
			AttachedVirtualMachineScaleSetID: to.Ptr("/subscriptions/8CC31D61-82D7-4B2B-B9DC-6B924DE7D229/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss"),
			ElasticityProfile: &armstandbypool.StandbyVirtualMachinePoolElasticityProfile{
				MaxReadyCapacity: to.Ptr[int64](304),
			},
			VirtualMachineState: to.Ptr(armstandbypool.VirtualMachineStateRunning),
		},
	}, 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.StandbyVirtualMachinePoolResource = armstandbypool.StandbyVirtualMachinePoolResource{
	// 	Name: to.Ptr("pool"),
	// 	Type: to.Ptr("Microsoft.StandbyPool/standbyVirtualMachinePools"),
	// 	ID: to.Ptr("/subscriptions/8CC31D61-82D7-4B2B-B9DC-6B924DE7D229/resourceGroups/rgstandbypool/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/pool"),
	// 	SystemData: &armstandbypool.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-09-07T16:33:22.210Z"); return t}()),
	// 		CreatedBy: to.Ptr("pooluser@microsoft.com"),
	// 		CreatedByType: to.Ptr(armstandbypool.CreatedByTypeUser),
	// 		LastModifiedAt: 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),
	// 	},
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armstandbypool.StandbyVirtualMachinePoolResourceProperties{
	// 		AttachedVirtualMachineScaleSetID: to.Ptr("/subscriptions/8CC31D61-82D7-4B2B-B9DC-6B924DE7D229/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss"),
	// 		ElasticityProfile: &armstandbypool.StandbyVirtualMachinePoolElasticityProfile{
	// 			MaxReadyCapacity: to.Ptr[int64](304),
	// 		},
	// 		ProvisioningState: to.Ptr(armstandbypool.ProvisioningStateSucceeded),
	// 		VirtualMachineState: to.Ptr(armstandbypool.VirtualMachineStateRunning),
	// 	},
	// }
}

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

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: specification/standbypool/resource-manager/Microsoft.StandbyPool/preview/2023-12-01-preview/examples/StandbyVirtualMachinePools_CreateOrUpdate.json
 */
async function standbyVirtualMachinePoolsCreateOrUpdate() {
  const subscriptionId =
    process.env["STANDBYPOOL_SUBSCRIPTION_ID"] || "8CC31D61-82D7-4B2B-B9DC-6B924DE7D229";
  const resourceGroupName = process.env["STANDBYPOOL_RESOURCE_GROUP"] || "rgstandbypool";
  const standbyVirtualMachinePoolName = "pool";
  const resource = {
    location: "West US",
    properties: {
      attachedVirtualMachineScaleSetId:
        "/subscriptions/8CC31D61-82D7-4B2B-B9DC-6B924DE7D229/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss",
      elasticityProfile: { maxReadyCapacity: 304 },
      virtualMachineState: "Running",
    },
    tags: {},
  };
  const credential = new DefaultAzureCredential();
  const client = new StandbyPoolManagementClient(credential, subscriptionId);
  const result = await client.standbyVirtualMachinePools.beginCreateOrUpdateAndWait(
    resourceGroupName,
    standbyVirtualMachinePoolName,
    resource,
  );
  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

Respuesta de muestra

status code:: 200

{
  "properties": {
    "elasticityProfile": {
      "maxReadyCapacity": 304
    },
    "virtualMachineState": "Running",
    "attachedVirtualMachineScaleSetId": "/subscriptions/8CC31D61-82D7-4B2B-B9DC-6B924DE7D229/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss",
    "provisioningState": "Succeeded"
  },
  "tags": {},
  "location": "West US",
  "id": "/subscriptions/8CC31D61-82D7-4B2B-B9DC-6B924DE7D229/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
    },
    "virtualMachineState": "Running",
    "attachedVirtualMachineScaleSetId": "/subscriptions/8CC31D61-82D7-4B2B-B9DC-6B924DE7D229/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss",
    "provisioningState": "Succeeded"
  },
  "tags": {},
  "location": "West US",
  "id": "/subscriptions/8CC31D61-82D7-4B2B-B9DC-6B924DE7D229/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"
  }
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ProvisioningState	Estado de aprovisionamiento
StandbyVirtualMachinePoolElasticityProfile	Detalles del perfil de elasticidad.
StandbyVirtualMachinePoolResource	A StandbyVirtualMachinePoolResource.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
VirtualMachineState	Estado de las máquinas virtuales en espera

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ProvisioningState

Estado de aprovisionamiento

Nombre	Tipo	Description
Canceled	string	Se canceló la creación de recursos.
Deleting	string	Se está eliminando el recurso.
Failed	string	Error en la creación de recursos.
Succeeded	string	Se ha creado el recurso.

StandbyVirtualMachinePoolElasticityProfile

Detalles del perfil de elasticidad.

Nombre	Tipo	Description
maxReadyCapacity	integer	Especifica el número máximo de máquinas virtuales en el grupo de máquinas virtuales en espera.

StandbyVirtualMachinePoolResource

A StandbyVirtualMachinePoolResource.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso.
properties.attachedVirtualMachineScaleSetId	string	Especifica el identificador de recurso completo de un conjunto de escalado de máquinas virtuales al que está asociado el grupo.
properties.elasticityProfile	StandbyVirtualMachinePoolElasticityProfile	Especifica el perfil de elasticidad de los grupos de máquinas virtuales en espera.
properties.provisioningState	ProvisioningState	Estado de la última operación.
properties.virtualMachineState	VirtualMachineState	Especifica el estado deseado de las máquinas virtuales del grupo.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.
tags	object	Etiquetas del recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

VirtualMachineState

Estado de las máquinas virtuales en espera

Nombre	Tipo	Description
Deallocated	string	La máquina virtual ha liberado la concesión en el hardware subyacente y está apagada.
Running	string	La máquina virtual está en funcionamiento.

Compartir a través de

Standby Virtual Machine Pools - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

StandbyVirtualMachinePools_CreateOrUpdate

Solicitud de ejemplo

Respuesta de muestra

Definiciones

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningState

StandbyVirtualMachinePoolElasticityProfile

StandbyVirtualMachinePoolResource

systemData

VirtualMachineState

Recursos adicionales