Documentation
¶
Overview ¶
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Index ¶
- Constants
- type CapacityReservationGroupInstanceView_STATUS
- type CapacityReservationGroupProperties
- type CapacityReservationGroupProperties_STATUS
- type CapacityReservationGroup_STATUS
- type CapacityReservationGroup_Spec
- type CapacityReservationInstanceViewWithName_STATUS
- type CapacityReservationInstanceView_STATUS
- type CapacityReservationProperties
- type CapacityReservationProperties_STATUS
- type CapacityReservationUtilization_STATUS
- type CapacityReservation_STATUS
- type CapacityReservation_Spec
- type InstanceViewStatus_STATUS
- type ReservationType
- type ReservationType_STATUS
- type ResourceSharingProfile
- type ResourceSharingProfile_STATUS
- type ScheduleProfile
- type ScheduleProfile_STATUS
- type Sku
- type Sku_STATUS
- type StatusLevelTypes_STATUS
- type SubResource
- type SubResourceReadOnly_STATUS
- type SubResource_STATUS
- type SystemData_CreatedByType_STATUS
- type SystemData_LastModifiedByType_STATUS
- type SystemData_STATUS
Constants ¶
const ( ReservationType_Block = ReservationType("Block") ReservationType_Targeted = ReservationType("Targeted") )
const ( ReservationType_STATUS_Block = ReservationType_STATUS("Block") ReservationType_STATUS_Targeted = ReservationType_STATUS("Targeted") )
const ( SystemData_CreatedByType_STATUS_Application = SystemData_CreatedByType_STATUS("Application") SystemData_CreatedByType_STATUS_Key = SystemData_CreatedByType_STATUS("Key") SystemData_CreatedByType_STATUS_ManagedIdentity = SystemData_CreatedByType_STATUS("ManagedIdentity") SystemData_CreatedByType_STATUS_User = SystemData_CreatedByType_STATUS("User") )
const ( SystemData_LastModifiedByType_STATUS_Application = SystemData_LastModifiedByType_STATUS("Application") SystemData_LastModifiedByType_STATUS_Key = SystemData_LastModifiedByType_STATUS("Key") SystemData_LastModifiedByType_STATUS_ManagedIdentity = SystemData_LastModifiedByType_STATUS("ManagedIdentity") SystemData_LastModifiedByType_STATUS_User = SystemData_LastModifiedByType_STATUS("User") )
const ( StatusLevelTypes_STATUS_Error = StatusLevelTypes_STATUS("Error") StatusLevelTypes_STATUS_Info = StatusLevelTypes_STATUS("Info") StatusLevelTypes_STATUS_Warning = StatusLevelTypes_STATUS("Warning") )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CapacityReservationGroupInstanceView_STATUS ¶
type CapacityReservationGroupInstanceView_STATUS struct {
// CapacityReservations: List of instance view of the capacity reservations under the capacity reservation group.
CapacityReservations []CapacityReservationInstanceViewWithName_STATUS `json:"capacityReservations,omitempty"`
// api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
SharedSubscriptionIds []SubResourceReadOnly_STATUS `json:"sharedSubscriptionIds,omitempty"`
}
type CapacityReservationGroupProperties ¶
type CapacityReservationGroupProperties struct {
// ReservationType: Indicates the type of capacity reservation. Allowed values are 'Block' for block capacity reservations
// and 'Targeted' for reservations that enable a VM to consume a specific capacity reservation when a capacity reservation
// group is provided. The reservation type is immutable and cannot be changed after it is assigned.
ReservationType *ReservationType `json:"reservationType,omitempty"`
// SharingProfile: Specifies the settings to enable sharing across subscriptions for the capacity reservation group
// resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single
// Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity
// reservation does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to
// https://aka.ms/computereservationsharing for more details.
SharingProfile *ResourceSharingProfile `json:"sharingProfile,omitempty"`
}
capacity reservation group Properties.
type CapacityReservationGroupProperties_STATUS ¶
type CapacityReservationGroupProperties_STATUS struct {
// CapacityReservations: A list of all capacity reservation resource ids that belong to capacity reservation group.
CapacityReservations []SubResourceReadOnly_STATUS `json:"capacityReservations,omitempty"`
// InstanceView: The capacity reservation group instance view which has the list of instance views for all the capacity
// reservations that belong to the capacity reservation group.
InstanceView *CapacityReservationGroupInstanceView_STATUS `json:"instanceView,omitempty"`
// ReservationType: Indicates the type of capacity reservation. Allowed values are 'Block' for block capacity reservations
// and 'Targeted' for reservations that enable a VM to consume a specific capacity reservation when a capacity reservation
// group is provided. The reservation type is immutable and cannot be changed after it is assigned.
ReservationType *ReservationType_STATUS `json:"reservationType,omitempty"`
// SharingProfile: Specifies the settings to enable sharing across subscriptions for the capacity reservation group
// resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single
// Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity
// reservation does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to
// https://aka.ms/computereservationsharing for more details.
SharingProfile *ResourceSharingProfile_STATUS `json:"sharingProfile,omitempty"`
// VirtualMachinesAssociated: A list of references to all virtual machines associated to the capacity reservation group.
VirtualMachinesAssociated []SubResourceReadOnly_STATUS `json:"virtualMachinesAssociated,omitempty"`
}
capacity reservation group Properties.
type CapacityReservationGroup_STATUS ¶
type CapacityReservationGroup_STATUS struct {
// Id: Fully qualified resource ID for the resource. Ex -
// /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Id *string `json:"id,omitempty"`
// Location: The geo-location where the resource lives
Location *string `json:"location,omitempty"`
// Name: The name of the resource
Name *string `json:"name,omitempty"`
// Properties: capacity reservation group Properties.
Properties *CapacityReservationGroupProperties_STATUS `json:"properties,omitempty"`
// SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.
SystemData *SystemData_STATUS `json:"systemData,omitempty"`
// Tags: Resource tags.
Tags map[string]string `json:"tags,omitempty"`
// Type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string `json:"type,omitempty"`
// Zones: The availability zones.
Zones []string `json:"zones,omitempty"`
}
Specifies information about the capacity reservation group that the capacity reservations should be assigned to. Currently, a capacity reservation can only be added to a capacity reservation group at creation time. An existing capacity reservation cannot be added or moved to another capacity reservation group.
type CapacityReservationGroup_Spec ¶
type CapacityReservationGroup_Spec struct {
// Location: The geo-location where the resource lives
Location *string `json:"location,omitempty"`
Name string `json:"name,omitempty"`
// Properties: capacity reservation group Properties.
Properties *CapacityReservationGroupProperties `json:"properties,omitempty"`
// Tags: Resource tags.
Tags map[string]string `json:"tags,omitempty"`
// Zones: The availability zones.
Zones []string `json:"zones,omitempty"`
}
func (CapacityReservationGroup_Spec) GetAPIVersion ¶
func (group CapacityReservationGroup_Spec) GetAPIVersion() string
GetAPIVersion returns the ARM API version of the resource. This is always "2025-04-01"
func (*CapacityReservationGroup_Spec) GetName ¶
func (group *CapacityReservationGroup_Spec) GetName() string
GetName returns the Name of the resource
func (*CapacityReservationGroup_Spec) GetType ¶
func (group *CapacityReservationGroup_Spec) GetType() string
GetType returns the ARM Type of the resource. This is always "Microsoft.Compute/capacityReservationGroups"
type CapacityReservationInstanceViewWithName_STATUS ¶
type CapacityReservationInstanceViewWithName_STATUS struct {
// Name: The name of the capacity reservation.
Name *string `json:"name,omitempty"`
// Statuses: The resource status information.
Statuses []InstanceViewStatus_STATUS `json:"statuses,omitempty"`
// UtilizationInfo: Unutilized capacity of the capacity reservation.
UtilizationInfo *CapacityReservationUtilization_STATUS `json:"utilizationInfo,omitempty"`
}
The instance view of a capacity reservation that includes the name of the capacity reservation. It is used for the response to the instance view of a capacity reservation group.
type CapacityReservationInstanceView_STATUS ¶
type CapacityReservationInstanceView_STATUS struct {
// Statuses: The resource status information.
Statuses []InstanceViewStatus_STATUS `json:"statuses,omitempty"`
// UtilizationInfo: Unutilized capacity of the capacity reservation.
UtilizationInfo *CapacityReservationUtilization_STATUS `json:"utilizationInfo,omitempty"`
}
The instance view of a capacity reservation that provides as snapshot of the runtime properties of the capacity reservation that is managed by the platform and can change outside of control plane operations.
type CapacityReservationProperties ¶
type CapacityReservationProperties struct {
// ScheduleProfile: Defines the schedule for Block-type capacity reservations. Specifies the schedule during which capacity
// reservation is active and VM or VMSS resource can be allocated using reservation. This property is required and only
// supported when the capacity reservation group type is 'Block'. The scheduleProfile, start, and end fields are immutable
// after creation. Minimum API version: 2025-04-01. Please refer to https://aka.ms/blockcapacityreservation for more
// details.
ScheduleProfile *ScheduleProfile `json:"scheduleProfile,omitempty"`
}
Properties of the Capacity reservation.
type CapacityReservationProperties_STATUS ¶
type CapacityReservationProperties_STATUS struct {
// InstanceView: The Capacity reservation instance view.
InstanceView *CapacityReservationInstanceView_STATUS `json:"instanceView,omitempty"`
// PlatformFaultDomainCount: Specifies the value of fault domain count that Capacity Reservation supports for requested VM
// size. Note: The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal
// to this value if it deploys using capacity reservation. Minimum api-version: 2022-08-01.
PlatformFaultDomainCount *int `json:"platformFaultDomainCount,omitempty"`
// ProvisioningState: The provisioning state, which only appears in the response.
ProvisioningState *string `json:"provisioningState,omitempty"`
// ProvisioningTime: The date time when the capacity reservation was last updated.
ProvisioningTime *string `json:"provisioningTime,omitempty"`
// ReservationId: A unique id generated and assigned to the capacity reservation by the platform which does not change
// throughout the lifetime of the resource.
ReservationId *string `json:"reservationId,omitempty"`
// ScheduleProfile: Defines the schedule for Block-type capacity reservations. Specifies the schedule during which capacity
// reservation is active and VM or VMSS resource can be allocated using reservation. This property is required and only
// supported when the capacity reservation group type is 'Block'. The scheduleProfile, start, and end fields are immutable
// after creation. Minimum API version: 2025-04-01. Please refer to https://aka.ms/blockcapacityreservation for more
// details.
ScheduleProfile *ScheduleProfile_STATUS `json:"scheduleProfile,omitempty"`
// TimeCreated: Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01.
TimeCreated *string `json:"timeCreated,omitempty"`
// VirtualMachinesAssociated: A list of all virtual machine resource ids that are associated with the capacity reservation.
VirtualMachinesAssociated []SubResourceReadOnly_STATUS `json:"virtualMachinesAssociated,omitempty"`
}
Properties of the Capacity reservation.
type CapacityReservationUtilization_STATUS ¶
type CapacityReservationUtilization_STATUS struct {
// CurrentCapacity: The value provides the current capacity of the VM size which was reserved successfully and for which
// the customer is getting billed. Minimum api-version: 2022-08-01.
CurrentCapacity *int `json:"currentCapacity,omitempty"`
// VirtualMachinesAllocated: A list of all virtual machines resource ids allocated against the capacity reservation.
VirtualMachinesAllocated []SubResourceReadOnly_STATUS `json:"virtualMachinesAllocated,omitempty"`
}
Represents the capacity reservation utilization in terms of resources allocated.
type CapacityReservation_STATUS ¶
type CapacityReservation_STATUS struct {
// Id: Fully qualified resource ID for the resource. Ex -
// /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Id *string `json:"id,omitempty"`
// Location: The geo-location where the resource lives
Location *string `json:"location,omitempty"`
// Name: The name of the resource
Name *string `json:"name,omitempty"`
// Properties: Properties of the Capacity reservation.
Properties *CapacityReservationProperties_STATUS `json:"properties,omitempty"`
// Sku: SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. For
// Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the
// capability called 'CapacityReservationSupported' set to true are supported. When 'CapacityReservationSupported' is true,
// the SKU capability also specifies the 'SupportedCapacityReservationTypes', which lists the types of capacity
// reservations (such as Targeted or Block) that the SKU supports. Refer to List Microsoft.Compute SKUs in a region
// (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.
Sku *Sku_STATUS `json:"sku,omitempty"`
// SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.
SystemData *SystemData_STATUS `json:"systemData,omitempty"`
// Tags: Resource tags.
Tags map[string]string `json:"tags,omitempty"`
// Type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string `json:"type,omitempty"`
// Zones: The availability zones.
Zones []string `json:"zones,omitempty"`
}
type CapacityReservation_Spec ¶
type CapacityReservation_Spec struct {
// Location: The geo-location where the resource lives
Location *string `json:"location,omitempty"`
Name string `json:"name,omitempty"`
// Properties: Properties of the Capacity reservation.
Properties *CapacityReservationProperties `json:"properties,omitempty"`
// Sku: SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. For
// Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the
// capability called 'CapacityReservationSupported' set to true are supported. When 'CapacityReservationSupported' is true,
// the SKU capability also specifies the 'SupportedCapacityReservationTypes', which lists the types of capacity
// reservations (such as Targeted or Block) that the SKU supports. Refer to List Microsoft.Compute SKUs in a region
// (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.
Sku *Sku `json:"sku,omitempty"`
// Tags: Resource tags.
Tags map[string]string `json:"tags,omitempty"`
// Zones: The availability zones.
Zones []string `json:"zones,omitempty"`
}
func (CapacityReservation_Spec) GetAPIVersion ¶
func (reservation CapacityReservation_Spec) GetAPIVersion() string
GetAPIVersion returns the ARM API version of the resource. This is always "2025-04-01"
func (*CapacityReservation_Spec) GetName ¶
func (reservation *CapacityReservation_Spec) GetName() string
GetName returns the Name of the resource
func (*CapacityReservation_Spec) GetType ¶
func (reservation *CapacityReservation_Spec) GetType() string
GetType returns the ARM Type of the resource. This is always "Microsoft.Compute/capacityReservationGroups/capacityReservations"
type InstanceViewStatus_STATUS ¶
type InstanceViewStatus_STATUS struct {
// Code: The status code.
Code *string `json:"code,omitempty"`
// DisplayStatus: The short localizable label for the status.
DisplayStatus *string `json:"displayStatus,omitempty"`
// Level: The level code.
Level *StatusLevelTypes_STATUS `json:"level,omitempty"`
// Message: The detailed status message, including for alerts and error messages.
Message *string `json:"message,omitempty"`
// Time: The time of the status.
Time *string `json:"time,omitempty"`
}
Instance view status.
type ReservationType ¶
type ReservationType string
Indicates the type of capacity reservation. Allowed values are 'Block' for block capacity reservations and 'Targeted' for reservations that enable a VM to consume a specific capacity reservation when a capacity reservation group is provided. The reservation type is immutable and cannot be changed after it is assigned. +kubebuilder:validation:Enum={"Block","Targeted"}
type ReservationType_STATUS ¶
type ReservationType_STATUS string
Indicates the type of capacity reservation. Allowed values are 'Block' for block capacity reservations and 'Targeted' for reservations that enable a VM to consume a specific capacity reservation when a capacity reservation group is provided. The reservation type is immutable and cannot be changed after it is assigned.
type ResourceSharingProfile ¶
type ResourceSharingProfile struct {
// SubscriptionIds: Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block
// Capacity Reservations does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer
// to https://aka.ms/computereservationsharing for more details.
SubscriptionIds []SubResource `json:"subscriptionIds,omitempty"`
}
type ResourceSharingProfile_STATUS ¶
type ResourceSharingProfile_STATUS struct {
// SubscriptionIds: Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block
// Capacity Reservations does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer
// to https://aka.ms/computereservationsharing for more details.
SubscriptionIds []SubResource_STATUS `json:"subscriptionIds,omitempty"`
}
type ScheduleProfile ¶
type ScheduleProfile struct {
// End: The required end date for block capacity reservations. Must be after the start date, with a duration of either
// 1–14 whole days or 3–26 whole weeks. Example: 2025-06-28.
End *string `json:"end,omitempty"`
// Start: The required start date for block capacity reservations. Must be today or within 56 days in the future. For
// same-day scheduling, requests must be submitted before 11:30 AM UTC. Example: 2025-06-27.
Start *string `json:"start,omitempty"`
}
Defines the schedule for Block-type capacity reservations. Specifies the schedule during which capacity reservation is active and VM or VMSS resource can be allocated using reservation. This property is required and only supported when the capacity reservation group type is 'Block'. The scheduleProfile, start, and end fields are immutable after creation. Minimum API version: 2025-04-01. Please refer to https://aka.ms/blockcapacityreservation for more details.
type ScheduleProfile_STATUS ¶
type ScheduleProfile_STATUS struct {
// End: The required end date for block capacity reservations. Must be after the start date, with a duration of either
// 1–14 whole days or 3–26 whole weeks. Example: 2025-06-28.
End *string `json:"end,omitempty"`
// Start: The required start date for block capacity reservations. Must be today or within 56 days in the future. For
// same-day scheduling, requests must be submitted before 11:30 AM UTC. Example: 2025-06-27.
Start *string `json:"start,omitempty"`
}
Defines the schedule for Block-type capacity reservations. Specifies the schedule during which capacity reservation is active and VM or VMSS resource can be allocated using reservation. This property is required and only supported when the capacity reservation group type is 'Block'. The scheduleProfile, start, and end fields are immutable after creation. Minimum API version: 2025-04-01. Please refer to https://aka.ms/blockcapacityreservation for more details.
type Sku ¶
type Sku struct {
// Capacity: Specifies the number of virtual machines in the scale set.
Capacity *int `json:"capacity,omitempty"`
// Name: The sku name.
Name *string `json:"name,omitempty"`
// Tier: Specifies the tier of virtual machines in a scale set.
// Possible Values:
// Standard
// Basic
Tier *string `json:"tier,omitempty"`
}
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.
type Sku_STATUS ¶
type Sku_STATUS struct {
// Capacity: Specifies the number of virtual machines in the scale set.
Capacity *int `json:"capacity,omitempty"`
// Name: The sku name.
Name *string `json:"name,omitempty"`
// Tier: Specifies the tier of virtual machines in a scale set.
// Possible Values:
// Standard
// Basic
Tier *string `json:"tier,omitempty"`
}
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.
type SubResource ¶
type SubResource struct {
// Id: Resource Id
Id *string `json:"id,omitempty"`
}
type SubResourceReadOnly_STATUS ¶
type SubResourceReadOnly_STATUS struct {
// Id: Resource Id
Id *string `json:"id,omitempty"`
}
type SubResource_STATUS ¶
type SubResource_STATUS struct {
// Id: Resource Id
Id *string `json:"id,omitempty"`
}
type SystemData_CreatedByType_STATUS ¶
type SystemData_CreatedByType_STATUS string
type SystemData_LastModifiedByType_STATUS ¶
type SystemData_LastModifiedByType_STATUS string
type SystemData_STATUS ¶
type SystemData_STATUS struct {
// CreatedAt: The timestamp of resource creation (UTC).
CreatedAt *string `json:"createdAt,omitempty"`
// CreatedBy: The identity that created the resource.
CreatedBy *string `json:"createdBy,omitempty"`
// CreatedByType: The type of identity that created the resource.
CreatedByType *SystemData_CreatedByType_STATUS `json:"createdByType,omitempty"`
// LastModifiedAt: The timestamp of resource last modification (UTC)
LastModifiedAt *string `json:"lastModifiedAt,omitempty"`
// LastModifiedBy: The identity that last modified the resource.
LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
// LastModifiedByType: The type of identity that last modified the resource.
LastModifiedByType *SystemData_LastModifiedByType_STATUS `json:"lastModifiedByType,omitempty"`
}
Metadata pertaining to creation and last modification of the resource.