Standby Virtual Machine Pools - Create Or Update

Skapa en StandbyVirtualMachinePoolResource

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

standbyVirtualMachinePoolName
path True

string

pattern: ^[a-zA-Z0-9-]{3,24}$

Namnet på den virtuella väntelägespoolen

subscriptionId
path True

string (uuid)

ID för målprenumerationen. Värdet måste vara ett UUID.

api-version
query True

string

minLength: 1

Den API-version som ska användas för den här åtgärden.

Begärandetext

Name Obligatorisk Typ Description
location True

string

Den geo-plats där resursen finns

properties.virtualMachineState True

VirtualMachineState

Anger önskat tillstånd för virtuella datorer i poolen.

properties.attachedVirtualMachineScaleSetId

string (arm-id)

Anger det fullständigt kvalificerade resurs-ID:t för en vm-skalningsuppsättning som poolen är kopplad till.

properties.elasticityProfile

StandbyVirtualMachinePoolElasticityProfile

Anger elasticitetsprofilen för poolerna för virtuella väntelägesdatorer.

properties.vmStateDistribution

VmStateDistribution

Specificerar fördelningen av virtuella maskintillstånd i poolen när virtualMachineState sätts till Mix.

tags

object

Resursetiketter.

Svar

Name Typ Description
200 OK

StandbyVirtualMachinePoolResource

Uppdateringsåtgärden "StandbyVirtualMachinePoolResource" har slutförts

201 Created

StandbyVirtualMachinePoolResource

Resursen "StandbyVirtualMachinePoolResource" har skapats

Sidhuvuden

Retry-After: integer

Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

StandbyVirtualMachinePools_CreateOrUpdate
StandbyVirtualMachinePools_CreateOrUpdate_MixState

StandbyVirtualMachinePools_CreateOrUpdate

Exempelbegäran

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

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

Exempelsvar

{
  "properties": {
    "elasticityProfile": {
      "maxReadyCapacity": 304,
      "minReadyCapacity": 300,
      "postProvisioningDelay": "PT2S",
      "dynamicSizing": {
        "enabled": true
      }
    },
    "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"
  }
}
Azure-AsyncOperation: https://contoso.com/operationstatus
{
  "properties": {
    "elasticityProfile": {
      "maxReadyCapacity": 304,
      "minReadyCapacity": 300,
      "postProvisioningDelay": "PT2S",
      "dynamicSizing": {
        "enabled": true
      }
    },
    "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"
  }
}

StandbyVirtualMachinePools_CreateOrUpdate_MixState

Exempelbegäran

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

{
  "properties": {
    "elasticityProfile": {
      "maxReadyCapacity": 304,
      "minReadyCapacity": 300,
      "postProvisioningDelay": "PT2S",
      "dynamicSizing": {
        "enabled": true
      }
    },
    "virtualMachineState": "Mix",
    "vmStateDistribution": {
      "runningPercent": 20,
      "deallocatedPercent": 80,
      "hibernatedPercent": 0
    },
    "attachedVirtualMachineScaleSetId": "/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss"
  },
  "tags": {},
  "location": "West US"
}

Exempelsvar

{
  "properties": {
    "elasticityProfile": {
      "maxReadyCapacity": 304,
      "minReadyCapacity": 300,
      "postProvisioningDelay": "PT2S",
      "dynamicSizing": {
        "enabled": true
      }
    },
    "virtualMachineState": "Mix",
    "vmStateDistribution": {
      "runningPercent": 20,
      "deallocatedPercent": 80,
      "hibernatedPercent": 0
    },
    "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"
  }
}
Azure-AsyncOperation: https://contoso.com/operationstatus
{
  "properties": {
    "elasticityProfile": {
      "maxReadyCapacity": 304,
      "minReadyCapacity": 300,
      "postProvisioningDelay": "PT2S",
      "dynamicSizing": {
        "enabled": true
      }
    },
    "virtualMachineState": "Mix",
    "vmStateDistribution": {
      "runningPercent": 20,
      "deallocatedPercent": 80,
      "hibernatedPercent": 0
    },
    "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"
  }
}

Definitioner

Name Description
createdByType

Den typ av identitet som skapade resursen.

DynamicSizing

Anger konfigurationen för dynamisk storlek.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

ProvisioningState

Tillhandahållandestatus

StandbyVirtualMachinePoolElasticityProfile

Detaljer om elasticitetsprofilen.

StandbyVirtualMachinePoolResource

En StandbyVirtualMachinePoolResource.

systemData

Metadata som rör skapande och senaste ändring av resursen.

VirtualMachineState

Tillstånd för virtuella datorer i vänteläge

VmStateDistribution

Specificerar fördelningen av virtuella maskintillstånd i poolen.

createdByType

Den typ av identitet som skapade resursen.

Värde Description
User
Application
ManagedIdentity
Key

DynamicSizing

Anger konfigurationen för dynamisk storlek.

Name Typ Description
enabled

boolean

Anger om dynamisk storleksändring är aktiverat för väntelägespoolen.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

ProvisioningState

Tillhandahållandestatus

Värde Description
Succeeded

Resursen har skapats.

Failed

Det gick inte att skapa resurser.

Canceled

Resursskapandet avbröts.

Deleting

Resursen tas bort.

StandbyVirtualMachinePoolElasticityProfile

Detaljer om elasticitetsprofilen.

Name Typ Description
dynamicSizing

DynamicSizing

Anger konfigurationen för dynamisk storlek.

maxReadyCapacity

integer (int64)

minimum: 0

Anger det maximala antalet virtuella datorer i poolen för virtuella datorer i vänteläge.

minReadyCapacity

integer (int64)

minimum: 0

Anger det önskade minsta antalet virtuella datorer i poolen för virtuella datorer i vänteläge. MinReadyCapacity får inte överskrida MaxReadyCapacity.

postProvisioningDelay

string

Anger hur lång tid det tar att vänta efter etablering av den virtuella datorn innan den virtuella datorn blir tillgänglig för användning. Varaktigheten ska anges i ISO 8601-format (t.ex. PT2S i 2 sekunder).

StandbyVirtualMachinePoolResource

En StandbyVirtualMachinePoolResource.

Name Typ Description
id

string (arm-id)

Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

location

string

Den geo-plats där resursen finns

name

string

Namnet på resursen

properties.attachedVirtualMachineScaleSetId

string (arm-id)

Anger det fullständigt kvalificerade resurs-ID:t för en vm-skalningsuppsättning som poolen är kopplad till.

properties.elasticityProfile

StandbyVirtualMachinePoolElasticityProfile

Anger elasticitetsprofilen för poolerna för virtuella väntelägesdatorer.

properties.provisioningState

ProvisioningState

Status för den senaste åtgärden.

properties.virtualMachineState

VirtualMachineState

Anger önskat tillstånd för virtuella datorer i poolen.

properties.vmStateDistribution

VmStateDistribution

Specificerar fördelningen av virtuella maskintillstånd i poolen när virtualMachineState sätts till Mix.

systemData

systemData

Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.

tags

object

Resursetiketter.

type

string

Resurstypen. T.ex. "Microsoft. Compute/virtualMachines" eller "Microsoft. Storage/storageAccounts"

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string (date-time)

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string (date-time)

Tidsstämpeln för senaste ändring av resurs (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.

VirtualMachineState

Tillstånd för virtuella datorer i vänteläge

Värde Description
Running

Den virtuella datorn är igång.

Deallocated

Den virtuella datorn har släppt lånet på den underliggande maskinvaran och stängs av.

Hibernated

Den virtuella datorn har släppt lånet på den underliggande maskinvaran och stängs av. Minnesinnehållet i den virtuella datorn lagras på OS-disken. När du startar igen återupptas program och processer som tidigare kördes på den virtuella datorn från tillståndet före viloläget.

Mix

Poolen innehåller en blandning av virtuella maskiner i olika tillstånd, enligt egenskapen vmStateDistribution.

VmStateDistribution

Specificerar fördelningen av virtuella maskintillstånd i poolen.

Name Typ Description
deallocatedPercent

integer (int32)

minimum: 0
maximum: 100

Specificerar andelen virtuella maskiner i det avfördelade tillståndet i standby-poolen.

hibernatedPercent

integer (int32)

minimum: 0
maximum: 100

Specificerar andelen virtuella maskiner i viloläge i standby-poolen.

runningPercent

integer (int32)

minimum: 0
maximum: 100

Specificerar procentandelen virtuella maskiner i Running-läget i standby-poolen.