compute.azure.com/v1api20241101
APIVersion
| Value | Description |
|---|---|
| “2024-11-01” |
AvailabilitySet
Generator information: - Generated from: /compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/availabilitySet.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}
Used by: AvailabilitySetList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | AvailabilitySet_Spec Optional |
|
| status | AvailabilitySet_STATUS Optional |
AvailabilitySet_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| location | Resource location | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | AvailabilitySetOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| platformFaultDomainCount | Fault Domain count. | int Optional |
| platformUpdateDomainCount | Update Domain count. | int Optional |
| proximityPlacementGroup | Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01. | SubResource Optional |
| scheduledEventsPolicy | Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set. | ScheduledEventsPolicy Optional |
| sku | Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use Aligned for virtual machines with managed disks and Classic for virtual machines with unmanaged disks. Default value is Classic. |
Sku Optional |
| tags | Resource tags | map[string]string Optional |
AvailabilitySet_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Resource Id | string Optional |
| location | Resource location | string Optional |
| name | Resource name | string Optional |
| platformFaultDomainCount | Fault Domain count. | int Optional |
| platformUpdateDomainCount | Update Domain count. | int Optional |
| proximityPlacementGroup | Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01. | SubResource_STATUS Optional |
| scheduledEventsPolicy | Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set. | ScheduledEventsPolicy_STATUS Optional |
| sku | Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use Aligned for virtual machines with managed disks and Classic for virtual machines with unmanaged disks. Default value is Classic. |
Sku_STATUS Optional |
| statuses | The resource status information. | InstanceViewStatus_STATUS[] Optional |
| tags | Resource tags | map[string]string Optional |
| type | Resource type | string Optional |
| virtualMachines | A list of references to all virtual machines in the availability set. | SubResource_STATUS[] Optional |
| virtualMachineScaleSetMigrationInfo | Describes the migration properties on the Availability Set. | VirtualMachineScaleSetMigrationInfo_STATUS Optional |
AvailabilitySetList
Generator information: - Generated from: /compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/availabilitySet.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | AvailabilitySet[] Optional |
AvailabilitySet_Spec
Used by: AvailabilitySet.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| location | Resource location | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | AvailabilitySetOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| platformFaultDomainCount | Fault Domain count. | int Optional |
| platformUpdateDomainCount | Update Domain count. | int Optional |
| proximityPlacementGroup | Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01. | SubResource Optional |
| scheduledEventsPolicy | Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set. | ScheduledEventsPolicy Optional |
| sku | Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use Aligned for virtual machines with managed disks and Classic for virtual machines with unmanaged disks. Default value is Classic. |
Sku Optional |
| tags | Resource tags | map[string]string Optional |
AvailabilitySet_STATUS
Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure. Currently, a VM can only be added to an availability set at creation time. An existing VM cannot be added to an availability set.
Used by: AvailabilitySet.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Resource Id | string Optional |
| location | Resource location | string Optional |
| name | Resource name | string Optional |
| platformFaultDomainCount | Fault Domain count. | int Optional |
| platformUpdateDomainCount | Update Domain count. | int Optional |
| proximityPlacementGroup | Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01. | SubResource_STATUS Optional |
| scheduledEventsPolicy | Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set. | ScheduledEventsPolicy_STATUS Optional |
| sku | Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use Aligned for virtual machines with managed disks and Classic for virtual machines with unmanaged disks. Default value is Classic. |
Sku_STATUS Optional |
| statuses | The resource status information. | InstanceViewStatus_STATUS[] Optional |
| tags | Resource tags | map[string]string Optional |
| type | Resource type | string Optional |
| virtualMachines | A list of references to all virtual machines in the availability set. | SubResource_STATUS[] Optional |
| virtualMachineScaleSetMigrationInfo | Describes the migration properties on the Availability Set. | VirtualMachineScaleSetMigrationInfo_STATUS Optional |
AvailabilitySetOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: AvailabilitySet_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
InstanceViewStatus_STATUS
Instance view status.
Used by: AvailabilitySet_STATUS.
| Property | Description | Type |
|---|---|---|
| code | The status code. | string Optional |
| displayStatus | The short localizable label for the status. | string Optional |
| level | The level code. | InstanceViewStatus_Level_STATUS Optional |
| message | The detailed status message, including for alerts and error messages. | string Optional |
| time | The time of the status. | string Optional |
ScheduledEventsPolicy
Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations.
Used by: AvailabilitySet_Spec.
| Property | Description | Type |
|---|---|---|
| scheduledEventsAdditionalPublishingTargets | The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. | ScheduledEventsAdditionalPublishingTargets Optional |
| userInitiatedReboot | The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. | UserInitiatedReboot Optional |
| userInitiatedRedeploy | The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. | UserInitiatedRedeploy Optional |
ScheduledEventsPolicy_STATUS
Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations.
Used by: AvailabilitySet_STATUS.
| Property | Description | Type |
|---|---|---|
| scheduledEventsAdditionalPublishingTargets | The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. | ScheduledEventsAdditionalPublishingTargets_STATUS Optional |
| userInitiatedReboot | The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. | UserInitiatedReboot_STATUS Optional |
| userInitiatedRedeploy | The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. | UserInitiatedRedeploy_STATUS Optional |
Sku
Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.
Used by: AvailabilitySet_Spec.
| Property | Description | Type |
|---|---|---|
| capacity | Specifies the number of virtual machines in the scale set. | int Optional |
| name | The sku name. | string Optional |
| tier | Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic | string Optional |
Sku_STATUS
Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.
Used by: AvailabilitySet_STATUS.
| Property | Description | Type |
|---|---|---|
| capacity | Specifies the number of virtual machines in the scale set. | int Optional |
| name | The sku name. | string Optional |
| tier | Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic | string Optional |
SubResource
Used by: AvailabilitySet_Spec.
| Property | Description | Type |
|---|---|---|
| reference | Resource Id | genruntime.ResourceReference Optional |
SubResource_STATUS
Used by: AvailabilitySet_STATUS, AvailabilitySet_STATUS, DefaultVirtualMachineScaleSetInfo_STATUS, and VirtualMachineScaleSetMigrationInfo_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Resource Id | string Optional |
VirtualMachineScaleSetMigrationInfo_STATUS
Describes the Availability Set properties related to migration to Flexible Virtual Machine Scale Set.
Used by: AvailabilitySet_STATUS.
| Property | Description | Type |
|---|---|---|
| defaultVirtualMachineScaleSetInfo | Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API. | DefaultVirtualMachineScaleSetInfo_STATUS Optional |
| migrateToVirtualMachineScaleSet | Specifies the Virtual Machine Scale Set that the Availability Set is migrated to. | SubResource_STATUS Optional |
DefaultVirtualMachineScaleSetInfo_STATUS
Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API.
Used by: VirtualMachineScaleSetMigrationInfo_STATUS.
| Property | Description | Type |
|---|---|---|
| constrainedMaximumCapacity | Indicates if the the maximum capacity of the default migrated Virtual Machine Scale Set after its migration will be constrained to a limited number of VMs. | bool Optional |
| defaultVirtualMachineScaleSet | The default Virtual Machine ScaleSet Uri that the Availability Set will be moved to upon triggering a seamless migration via the ConvertToVirtualMachineScaleSet API. | SubResource_STATUS Optional |
InstanceViewStatus_Level_STATUS
Used by: InstanceViewStatus_STATUS.
| Value | Description |
|---|---|
| “Error” | |
| “Info” | |
| “Warning” |
ScheduledEventsAdditionalPublishingTargets
Used by: ScheduledEventsPolicy.
| Property | Description | Type |
|---|---|---|
| eventGridAndResourceGraph | The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. | EventGridAndResourceGraph Optional |
ScheduledEventsAdditionalPublishingTargets_STATUS
Used by: ScheduledEventsPolicy_STATUS.
| Property | Description | Type |
|---|---|---|
| eventGridAndResourceGraph | The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. | EventGridAndResourceGraph_STATUS Optional |
UserInitiatedReboot
Specifies Reboot related Scheduled Event related configurations.
Used by: ScheduledEventsPolicy.
| Property | Description | Type |
|---|---|---|
| automaticallyApprove | Specifies Reboot Scheduled Event related configurations. | bool Optional |
UserInitiatedReboot_STATUS
Specifies Reboot related Scheduled Event related configurations.
Used by: ScheduledEventsPolicy_STATUS.
| Property | Description | Type |
|---|---|---|
| automaticallyApprove | Specifies Reboot Scheduled Event related configurations. | bool Optional |
UserInitiatedRedeploy
Specifies Redeploy related Scheduled Event related configurations.
Used by: ScheduledEventsPolicy.
| Property | Description | Type |
|---|---|---|
| automaticallyApprove | Specifies Redeploy Scheduled Event related configurations. | bool Optional |
UserInitiatedRedeploy_STATUS
Specifies Redeploy related Scheduled Event related configurations.
Used by: ScheduledEventsPolicy_STATUS.
| Property | Description | Type |
|---|---|---|
| automaticallyApprove | Specifies Redeploy Scheduled Event related configurations. | bool Optional |
EventGridAndResourceGraph
Specifies eventGridAndResourceGraph related Scheduled Event related configurations.
Used by: ScheduledEventsAdditionalPublishingTargets.
| Property | Description | Type |
|---|---|---|
| enable | Specifies if event grid and resource graph is enabled for Scheduled event related configurations. | bool Optional |
EventGridAndResourceGraph_STATUS
Specifies eventGridAndResourceGraph related Scheduled Event related configurations.
Used by: ScheduledEventsAdditionalPublishingTargets_STATUS.
| Property | Description | Type |
|---|---|---|
| enable | Specifies if event grid and resource graph is enabled for Scheduled event related configurations. | bool Optional |