azure.mgmt.standbypool.models module

class azure.mgmt.standbypool.models.ActionType(*values)[source]

Bases: str, Enum

Extensible enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs.

INTERNAL = 'Internal': Actions are for internal-only APIs.

class azure.mgmt.standbypool.models.ContainerGroupInstanceCountSummary(*args: Any, **kwargs: Any)[source]

Bases: Model

Displays the counts of container groups in each state, as known by the StandbyPool resource provider.

Variables:

zone (int) – The zone that the provided counts are in. It will not have a value if zones are not enabled.
instance_counts_by_state (list[PoolContainerGroupStateCount]) – The count of pooled container groups in each state for the given zone. Required.

instance_counts_by_state: List[_models.PoolContainerGroupStateCount]: The count of pooled container groups in each state for the given zone. Required.

zone: int | None: The zone that the provided counts are in. It will not have a value if zones are not enabled.

class azure.mgmt.standbypool.models.ContainerGroupProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

Details of the ContainerGroupProfile.

Variables:

id (str) – Specifies container group profile id of standby container groups. Required.
revision (int) – Specifies revision of container group profile.

id: str: Specifies container group profile id of standby container groups. Required.

revision: int | None: Specifies revision of container group profile.

class azure.mgmt.standbypool.models.ContainerGroupProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

Details of the ContainerGroupProperties.

Variables:

container_group_profile (ContainerGroupProfile) – Specifies container group profile of standby container groups. Required.
subnet_ids (list[Subnet]) – Specifies subnet Ids for container group.

container_group_profile: _models.ContainerGroupProfile: Specifies container group profile of standby container groups. Required.

subnet_ids: List[_models.Subnet] | None: Specifies subnet Ids for container group.

class azure.mgmt.standbypool.models.CreatedByType(*values)[source]

Bases: str, Enum

The kind of entity that created the resource.

APPLICATION = 'Application': The entity was created by an application.

KEY = 'Key': The entity was created by a key.

MANAGED_IDENTITY = 'ManagedIdentity': The entity was created by a managed identity.

USER = 'User': The entity was created by a user.

class azure.mgmt.standbypool.models.ErrorAdditionalInfo(*args: Any, **kwargs: Any)[source]

Bases: Model

The resource management error additional info.

Variables:

type (str) – The additional info type.
info (any) – The additional info.

info: Any | None: The additional info.

type: str | None: The additional info type.

class azure.mgmt.standbypool.models.ErrorDetail(*args: Any, **kwargs: Any)[source]

Bases: Model

The error detail.

Variables:

code (str) – The error code.
message (str) – The error message.
target (str) – The error target.
details (list[ErrorDetail]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.

additional_info: List[_models.ErrorAdditionalInfo] | None: The error additional info.

code: str | None: The error code.

details: List[_models.ErrorDetail] | None: The error details.

message: str | None: The error message.

target: str | None: The error target.

class azure.mgmt.standbypool.models.ErrorResponse(*args: Any, **kwargs: Any)[source]

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

Variables:: error (ErrorDetail) – The error object.

error: _models.ErrorDetail | None: The error object.

class azure.mgmt.standbypool.models.HealthStateCode(*values)[source]

Bases: str, Enum

StandbyPool health state.

DEGRADED = 'HealthState/degraded': StandbyPool is in degraded state.

HEALTHY = 'HealthState/healthy': StandbyPool is in healthy state.

class azure.mgmt.standbypool.models.Operation(*args: Any, **kwargs: Any)[source]

Bases: Model

Details of a REST API operation, returned from the Resource Provider Operations API.

Variables:

name (str) – The name of the operation, as per Resource-Based Access Control (RBAC). Examples: “Microsoft.Compute/virtualMachines/write”, “Microsoft.Compute/virtualMachines/capture/action”.
is_data_action (bool) – Whether the operation applies to data-plane. This is “true” for data-plane operations and “false” for Azure Resource Manager/control-plane operations.
display (OperationDisplay) – Localized display information for this particular operation.
origin (str or Origin) – The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”. Known values are: “user”, “system”, and “user,system”.
action_type (str or ActionType) – Extensible enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs. “Internal”

action_type: str | _models.ActionType | None: Extensible enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs. “Internal”

display: _models.OperationDisplay | None: Localized display information for this particular operation.

is_data_action: bool | None: Whether the operation applies to data-plane. This is “true” for data-plane operations and “false” for Azure Resource Manager/control-plane operations.

name: str | None: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: “Microsoft.Compute/virtualMachines/write”, “Microsoft.Compute/virtualMachines/capture/action”.

origin: str | _models.Origin | None: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”. Known values are: “user”, “system”, and “user,system”.

class azure.mgmt.standbypool.models.OperationDisplay(*args: Any, **kwargs: Any)[source]

Bases: Model

Localized display information for and operation.

Variables:

provider (str) – The localized friendly form of the resource provider name, e.g. “Microsoft Monitoring Insights” or “Microsoft Compute”.
resource (str) – The localized friendly name of the resource type related to this operation. E.g. “Virtual Machines” or “Job Schedule Collections”.
operation (str) – The concise, localized friendly name for the operation; suitable for dropdowns. E.g. “Create or Update Virtual Machine”, “Restart Virtual Machine”.
description (str) – The short, localized friendly description of the operation; suitable for tool tips and detailed views.

description: str | None: The short, localized friendly description of the operation; suitable for tool tips and detailed views.

operation: str | None: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. “Create or Update Virtual Machine”, “Restart Virtual Machine”.

provider: str | None: The localized friendly form of the resource provider name, e.g. “Microsoft Monitoring Insights” or “Microsoft Compute”.

resource: str | None: The localized friendly name of the resource type related to this operation. E.g. “Virtual Machines” or “Job Schedule Collections”.

class azure.mgmt.standbypool.models.Origin(*values)[source]

Bases: str, Enum

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”.

SYSTEM = 'system': Indicates the operation is initiated by a system.

USER = 'user': Indicates the operation is initiated by a user.

USER_SYSTEM = 'user,system': Indicates the operation is initiated by a user or system.

class azure.mgmt.standbypool.models.PoolContainerGroupState(*values)[source]

Bases: str, Enum

The state of the pooled container groups.

CREATING = 'Creating': The container group is creating.

DELETING = 'Deleting': The container group is deleting.

RUNNING = 'Running': The container group is up and running.

class azure.mgmt.standbypool.models.PoolContainerGroupStateCount(*args: Any, **kwargs: Any)[source]

Bases: Model

Displays the counts of pooled container groups in each state, as known by the StandbyPool resource provider.

Variables:

state (str or PoolContainerGroupState) – The state that the pooled container groups count is for. Required. Known values are: “Running”, “Creating”, and “Deleting”.
count (int) – The count of pooled container groups in the given state. Required.

count: int: The count of pooled container groups in the given state. Required.

state: str | _models.PoolContainerGroupState: The state that the pooled container groups count is for. Required. Known values are: “Running”, “Creating”, and “Deleting”.

class azure.mgmt.standbypool.models.PoolStatus(*args: Any, **kwargs: Any)[source]

Bases: Model

Displays StandbyPool status.

Variables:

code (str or HealthStateCode) – Displays the healthy state of the StandbyPool. Required. Known values are: “HealthState/healthy” and “HealthState/degraded”.
message (str) – Displays the StandbyPool health state details.

code: str | _models.HealthStateCode: Displays the healthy state of the StandbyPool. Required. Known values are: “HealthState/healthy” and “HealthState/degraded”.

message: str | None: Displays the StandbyPool health state details.

class azure.mgmt.standbypool.models.PoolVirtualMachineState(*values)[source]

Bases: str, Enum

The state of the pooled virtual machines.

CREATING = 'Creating': The virtual machine is creating.

DEALLOCATED = 'Deallocated': The virtual machine has released the lease on the underlying hardware and is powered off.

DEALLOCATING = 'Deallocating': The virtual machine is releasing the lease on the underlying hardware and is powered off.

DELETING = 'Deleting': The virtual machine is deleting.

HIBERNATED = 'Hibernated': The virtual machine has released the lease on the underlying hardware and is powered off. Memory contents of the VM are stored in the OS disk. When started again, applications and processes that were previously running in your VM resume from the state prior to hibernation.

HIBERNATING = 'Hibernating': The virtual machine is hibernating.

RUNNING = 'Running': The virtual machine is up and running.

STARTING = 'Starting': The virtual machine is starting.

class azure.mgmt.standbypool.models.PoolVirtualMachineStateCount(*args: Any, **kwargs: Any)[source]

Bases: Model

Displays the counts of pooled virtual machines in each state, as known by the StandbyPool resource provider.

Variables:

state (str or PoolVirtualMachineState) – The state that the pooled virtual machines count is for. Required. Known values are: “Running”, “Creating”, “Starting”, “Deleting”, “Deallocated”, “Deallocating”, “Hibernated”, and “Hibernating”.
count (int) – The count of pooled virtual machines in the given state. Required.

count: int: The count of pooled virtual machines in the given state. Required.

state: str | _models.PoolVirtualMachineState: The state that the pooled virtual machines count is for. Required. Known values are: “Running”, “Creating”, “Starting”, “Deleting”, “Deallocated”, “Deallocating”, “Hibernated”, and “Hibernating”.

class azure.mgmt.standbypool.models.ProvisioningState(*values)[source]

Bases: str, Enum

Provisioning state.

CANCELED = 'Canceled': Resource creation was canceled.

DELETING = 'Deleting': Resource is being deleted.

FAILED = 'Failed': Resource creation failed.

SUCCEEDED = 'Succeeded': Resource has been created.

class azure.mgmt.standbypool.models.ProxyResource(*args: Any, **kwargs: Any)[source]

Bases: Resource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.standbypool.models.RefillPolicy(*values)[source]

Bases: str, Enum

Refill policy of standby pool.

ALWAYS = 'always': A refill policy that standby pool is automatically refilled to maintain maxReadyCapacity.

class azure.mgmt.standbypool.models.Resource(*args: Any, **kwargs: Any)[source]

Bases: Model

Common fields that are returned in the response for all Azure Resource Manager resources.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

id: str | None: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

name: str | None: The name of the resource.

system_data: _models.SystemData | None: Azure Resource Manager metadata containing createdBy and modifiedBy information.

type: str | None: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

class azure.mgmt.standbypool.models.StandbyContainerGroupPoolElasticityProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

Specifies the elasticity profile of the standby container group pools.

Variables:

max_ready_capacity (int) – Specifies maximum number of standby container groups in the standby pool. Required.
refill_policy (str or RefillPolicy) – Specifies refill policy of the pool. “always”

max_ready_capacity: int: Specifies maximum number of standby container groups in the standby pool. Required.

refill_policy: str | _models.RefillPolicy | None: Specifies refill policy of the pool. “always”

class azure.mgmt.standbypool.models.StandbyContainerGroupPoolForecastValues(*args: Any, **kwargs: Any)[source]

Bases: Model

Displays the forecast information of the standby pool.

Variables:: instances_requested_count (list[int]) – Displays the predicted count of instances to be requested from the standby pool. Required.

instances_requested_count: List[int]: Displays the predicted count of instances to be requested from the standby pool. Required.

class azure.mgmt.standbypool.models.StandbyContainerGroupPoolPrediction(*args: Any, **kwargs: Any)[source]

Bases: Model

Displays prediction information of the standby pool.

Variables:

forecast_values (StandbyContainerGroupPoolForecastValues) – Displays the forecast information of the standby pool. Required.
forecast_start_time (datetime) – Displays the UTC timestamp of when the prediction was retrieved for the standby pool. Required.
forecast_info (str) – Displays additional information for the prediction of the standby pool. Required.

forecast_info: str: Displays additional information for the prediction of the standby pool. Required.

forecast_start_time: datetime: Displays the UTC timestamp of when the prediction was retrieved for the standby pool. Required.

forecast_values: _models.StandbyContainerGroupPoolForecastValues: Displays the forecast information of the standby pool. Required.

class azure.mgmt.standbypool.models.StandbyContainerGroupPoolResource(*args: Any, **kwargs: Any)[source]

Bases: TrackedResource

A StandbyContainerGroupPoolResource.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives. Required.
properties (StandbyContainerGroupPoolResourceProperties) – The resource-specific properties for this resource.

properties: _models.StandbyContainerGroupPoolResourceProperties | None: The resource-specific properties for this resource.

class azure.mgmt.standbypool.models.StandbyContainerGroupPoolResourceProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

Details of the StandbyContainerGroupPool.

Variables:

elasticity_profile (StandbyContainerGroupPoolElasticityProfile) – Specifies elasticity profile of standby container group pools. Required.
container_group_properties (ContainerGroupProperties) – Specifies container group properties of standby container group pools. Required.
zones (list[str]) – Specifies zones of standby container group pools.
provisioning_state (str or ProvisioningState) – The status of the last operation. Known values are: “Succeeded”, “Failed”, “Canceled”, and “Deleting”.

container_group_properties: _models.ContainerGroupProperties: Specifies container group properties of standby container group pools. Required.

elasticity_profile: _models.StandbyContainerGroupPoolElasticityProfile: Specifies elasticity profile of standby container group pools. Required.

provisioning_state: str | _models.ProvisioningState | None

“Succeeded”, “Failed”, “Canceled”, and “Deleting”.

Type:: The status of the last operation. Known values are

zones: List[str] | None: Specifies zones of standby container group pools.

class azure.mgmt.standbypool.models.StandbyContainerGroupPoolResourceUpdate(*args: Any, **kwargs: Any)[source]

Bases: Model

The type used for update operations of the StandbyContainerGroupPoolResource.

Variables:

tags (dict[str, str]) – Resource tags.
properties (StandbyContainerGroupPoolResourceUpdateProperties) – The resource-specific properties for this resource.

properties: _models.StandbyContainerGroupPoolResourceUpdateProperties | None: The resource-specific properties for this resource.

tags: Dict[str, str] | None: Resource tags.

class azure.mgmt.standbypool.models.StandbyContainerGroupPoolResourceUpdateProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

The updatable properties of the StandbyContainerGroupPoolResource.

Variables:

elasticity_profile (StandbyContainerGroupPoolElasticityProfile) – Specifies elasticity profile of standby container group pools.
container_group_properties (ContainerGroupProperties) – Specifies container group properties of standby container group pools.
zones (list[str]) – Specifies zones of standby container group pools.

container_group_properties: _models.ContainerGroupProperties | None: Specifies container group properties of standby container group pools.

elasticity_profile: _models.StandbyContainerGroupPoolElasticityProfile | None: Specifies elasticity profile of standby container group pools.

zones: List[str] | None: Specifies zones of standby container group pools.

class azure.mgmt.standbypool.models.StandbyContainerGroupPoolRuntimeViewResource(*args: Any, **kwargs: Any)[source]

Bases: ProxyResource

Contains information about a standby container group pool as last known by the StandbyPool resource provider.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
properties (StandbyContainerGroupPoolRuntimeViewResourceProperties) – The resource-specific properties for this resource.

properties: _models.StandbyContainerGroupPoolRuntimeViewResourceProperties | None: The resource-specific properties for this resource.

class azure.mgmt.standbypool.models.StandbyContainerGroupPoolRuntimeViewResourceProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

Contains information about a standby pool as last known by the StandbyPool resource provider.

Variables:

instance_count_summary (list[ContainerGroupInstanceCountSummary]) – A list containing the counts of container groups in each possible state, as known by the StandbyPool resource provider. Required.
status (PoolStatus) – Display status of the standby pool.
provisioning_state (str or ProvisioningState) – Displays the provisioning state of the standby pool. Known values are: “Succeeded”, “Failed”, “Canceled”, and “Deleting”.
prediction (StandbyContainerGroupPoolPrediction) – Displays prediction information of the standby pool.

instance_count_summary: List[_models.ContainerGroupInstanceCountSummary]: A list containing the counts of container groups in each possible state, as known by the StandbyPool resource provider. Required.

prediction: _models.StandbyContainerGroupPoolPrediction | None: Displays prediction information of the standby pool.

provisioning_state: str | _models.ProvisioningState | None

“Succeeded”, “Failed”, “Canceled”, and “Deleting”.

Type:: Displays the provisioning state of the standby pool. Known values are

status: _models.PoolStatus | None: Display status of the standby pool.

class azure.mgmt.standbypool.models.StandbyVirtualMachinePoolElasticityProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

Details of the elasticity profile.

Variables:

max_ready_capacity (int) – Specifies the maximum number of virtual machines in the standby virtual machine pool. Required.
min_ready_capacity (int) – Specifies the desired minimum number of virtual machines in the standby virtual machine pool. MinReadyCapacity cannot exceed MaxReadyCapacity.

max_ready_capacity: int: Specifies the maximum number of virtual machines in the standby virtual machine pool. Required.

min_ready_capacity: int | None: Specifies the desired minimum number of virtual machines in the standby virtual machine pool. MinReadyCapacity cannot exceed MaxReadyCapacity.

class azure.mgmt.standbypool.models.StandbyVirtualMachinePoolForecastValues(*args: Any, **kwargs: Any)[source]

Bases: Model

Displays the forecast information of the standby pool.

Variables:: instances_requested_count (list[int]) – Displays the predicted count of instances to be requested from the standby pool. Required.

instances_requested_count: List[int]: Displays the predicted count of instances to be requested from the standby pool. Required.

class azure.mgmt.standbypool.models.StandbyVirtualMachinePoolPrediction(*args: Any, **kwargs: Any)[source]

Bases: Model

Displays prediction information of the standby pool.

Variables:

forecast_values (StandbyVirtualMachinePoolForecastValues) – Displays the forecast information of the standby pool. Required.
forecast_start_time (datetime) – Displays the UTC timestamp of when the prediction was retrieved for the standby pool. Required.
forecast_info (str) – Displays additional information for the prediction of the standby pool. Required.

forecast_info: str: Displays additional information for the prediction of the standby pool. Required.

forecast_start_time: datetime: Displays the UTC timestamp of when the prediction was retrieved for the standby pool. Required.

forecast_values: _models.StandbyVirtualMachinePoolForecastValues: Displays the forecast information of the standby pool. Required.

class azure.mgmt.standbypool.models.StandbyVirtualMachinePoolResource(*args: Any, **kwargs: Any)[source]

Bases: TrackedResource

A StandbyVirtualMachinePoolResource.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives. Required.
properties (StandbyVirtualMachinePoolResourceProperties) – The resource-specific properties for this resource.

properties: _models.StandbyVirtualMachinePoolResourceProperties | None: The resource-specific properties for this resource.

class azure.mgmt.standbypool.models.StandbyVirtualMachinePoolResourceProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

Details of the StandbyVirtualMachinePool.

Variables:

elasticity_profile (StandbyVirtualMachinePoolElasticityProfile) – Specifies the elasticity profile of the standby virtual machine pools.
virtual_machine_state (str or VirtualMachineState) – Specifies the desired state of virtual machines in the pool. Required. Known values are: “Running”, “Deallocated”, and “Hibernated”.
attached_virtual_machine_scale_set_id (str) – Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
provisioning_state (str or ProvisioningState) – The status of the last operation. Known values are: “Succeeded”, “Failed”, “Canceled”, and “Deleting”.

attached_virtual_machine_scale_set_id: str | None: Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.

elasticity_profile: _models.StandbyVirtualMachinePoolElasticityProfile | None: Specifies the elasticity profile of the standby virtual machine pools.

provisioning_state: str | _models.ProvisioningState | None

“Succeeded”, “Failed”, “Canceled”, and “Deleting”.

Type:: The status of the last operation. Known values are

virtual_machine_state: str | _models.VirtualMachineState: Specifies the desired state of virtual machines in the pool. Required. Known values are: “Running”, “Deallocated”, and “Hibernated”.

class azure.mgmt.standbypool.models.StandbyVirtualMachinePoolResourceUpdate(*args: Any, **kwargs: Any)[source]

Bases: Model

The type used for update operations of the StandbyVirtualMachinePoolResource.

Variables:

tags (dict[str, str]) – Resource tags.
properties (StandbyVirtualMachinePoolResourceUpdateProperties) – The resource-specific properties for this resource.

properties: _models.StandbyVirtualMachinePoolResourceUpdateProperties | None: The resource-specific properties for this resource.

tags: Dict[str, str] | None: Resource tags.

class azure.mgmt.standbypool.models.StandbyVirtualMachinePoolResourceUpdateProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

The updatable properties of the StandbyVirtualMachinePoolResource.

Variables:

elasticity_profile (StandbyVirtualMachinePoolElasticityProfile) – Specifies the elasticity profile of the standby virtual machine pools.
virtual_machine_state (str or VirtualMachineState) – Specifies the desired state of virtual machines in the pool. Known values are: “Running”, “Deallocated”, and “Hibernated”.
attached_virtual_machine_scale_set_id (str) – Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.

attached_virtual_machine_scale_set_id: str | None: Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.

elasticity_profile: _models.StandbyVirtualMachinePoolElasticityProfile | None: Specifies the elasticity profile of the standby virtual machine pools.

virtual_machine_state: str | _models.VirtualMachineState | None

“Running”, “Deallocated”, and “Hibernated”.

Type:: Specifies the desired state of virtual machines in the pool. Known values are

class azure.mgmt.standbypool.models.StandbyVirtualMachinePoolRuntimeViewResource(*args: Any, **kwargs: Any)[source]

Bases: ProxyResource

Contains information about a standby virtual machine pool as last known by the StandbyPool resource provider.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
properties (StandbyVirtualMachinePoolRuntimeViewResourceProperties) – The resource-specific properties for this resource.

properties: _models.StandbyVirtualMachinePoolRuntimeViewResourceProperties | None: The resource-specific properties for this resource.

class azure.mgmt.standbypool.models.StandbyVirtualMachinePoolRuntimeViewResourceProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

Contains information about a standby pool as last known by the StandbyPool resource provider.

Variables:

instance_count_summary (list[VirtualMachineInstanceCountSummary]) – A list containing the counts of virtual machines in each possible power state for each zone if enabled, as known by the StandbyPool resource provider. If zones are not enabled on the attached VMSS, the list will contain a single entry without zone values. Note: any resources in the Running state may still be installing extensions / not fully provisioned. Required.
status (PoolStatus) – Display status of the standby pool.
provisioning_state (str or ProvisioningState) – Displays the provisioning state of the standby pool. Known values are: “Succeeded”, “Failed”, “Canceled”, and “Deleting”.
prediction (StandbyVirtualMachinePoolPrediction) – Displays prediction information of the standby pool.

instance_count_summary: List[_models.VirtualMachineInstanceCountSummary]: A list containing the counts of virtual machines in each possible power state for each zone if enabled, as known by the StandbyPool resource provider. If zones are not enabled on the attached VMSS, the list will contain a single entry without zone values. Note: any resources in the Running state may still be installing extensions / not fully provisioned. Required.

prediction: _models.StandbyVirtualMachinePoolPrediction | None: Displays prediction information of the standby pool.

provisioning_state: str | _models.ProvisioningState | None

“Succeeded”, “Failed”, “Canceled”, and “Deleting”.

Type:: Displays the provisioning state of the standby pool. Known values are

status: _models.PoolStatus | None: Display status of the standby pool.

class azure.mgmt.standbypool.models.StandbyVirtualMachineResource(*args: Any, **kwargs: Any)[source]

Bases: ProxyResource

Concrete proxy resource types can be created by aliasing this type using a specific property type.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
properties (StandbyVirtualMachineResourceProperties) – The resource-specific properties for this resource.

properties: _models.StandbyVirtualMachineResourceProperties | None: The resource-specific properties for this resource.

class azure.mgmt.standbypool.models.StandbyVirtualMachineResourceProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

Details of the StandbyVirtualMachine.

Variables:

virtual_machine_resource_id (str) – Resource id of the virtual machine. Required.
provisioning_state (str or ProvisioningState) – The status of the last operation. Known values are: “Succeeded”, “Failed”, “Canceled”, and “Deleting”.

provisioning_state: str | _models.ProvisioningState | None

“Succeeded”, “Failed”, “Canceled”, and “Deleting”.

Type:: The status of the last operation. Known values are

virtual_machine_resource_id: str: Resource id of the virtual machine. Required.

class azure.mgmt.standbypool.models.Subnet(*args: Any, **kwargs: Any)[source]

Bases: Model

Subnet of container group.

Variables:: id (str) – Specifies ARM resource id of the subnet. Required.

id: str: Specifies ARM resource id of the subnet. Required.

class azure.mgmt.standbypool.models.SystemData(*args: Any, **kwargs: Any)[source]

Bases: Model

Metadata pertaining to creation and last modification of the resource.

Variables:

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

created_at: datetime | None: The timestamp of resource creation (UTC).

created_by: str | None: The identity that created the resource.

created_by_type: str | _models.CreatedByType | None

“User”, “Application”, “ManagedIdentity”, and “Key”.

Type:: The type of identity that created the resource. Known values are

last_modified_at: datetime | None: The timestamp of resource last modification (UTC).

last_modified_by: str | None: The identity that last modified the resource.

last_modified_by_type: str | _models.CreatedByType | None

“User”, “Application”, “ManagedIdentity”, and “Key”.

Type:: The type of identity that last modified the resource. Known values are

class azure.mgmt.standbypool.models.TrackedResource(*args: Any, **kwargs: Any)[source]

Bases: Resource

The resource model definition for an Azure Resource Manager tracked top level resource which has ‘tags’ and a ‘location’.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives. Required.

location: str: The geo-location where the resource lives. Required.

tags: Dict[str, str] | None: Resource tags.

class azure.mgmt.standbypool.models.VirtualMachineInstanceCountSummary(*args: Any, **kwargs: Any)[source]

Bases: Model

Contains the counts of VMs in each power state in a given zone, fault domain, as known by the StandbyPool resource provider. Note: any resources in the Running state may still be installing extensions / not fully provisioned.

Variables:

zone (int) – The zone that the provided counts are in. It will not have a value if zones are not enabled on the attached VMSS.
instance_counts_by_state (list[PoolVirtualMachineStateCount]) – The count of pooled virtual machines in each state for the given zone. Required.

instance_counts_by_state: List[_models.PoolVirtualMachineStateCount]: The count of pooled virtual machines in each state for the given zone. Required.

zone: int | None: The zone that the provided counts are in. It will not have a value if zones are not enabled on the attached VMSS.

class azure.mgmt.standbypool.models.VirtualMachineState(*values)[source]

Bases: str, Enum

State of standby virtual machines.

DEALLOCATED = 'Deallocated': The virtual machine has released the lease on the underlying hardware and is powered off.

HIBERNATED = 'Hibernated': The virtual machine has released the lease on the underlying hardware and is powered off. Memory contents of the VM are stored in the OS disk. When started again, applications and processes that were previously running in your VM resume from the state prior to hibernation.

RUNNING = 'Running': The virtual machine is up and running.