Skip to content

compute.v1beta1.windowsVirtualMachine

"WindowsVirtualMachine is the Schema for the WindowsVirtualMachines API. Manages a Windows Virtual Machine."

Index

Fields

fn new

new(name)

new returns an instance of WindowsVirtualMachine

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"WindowsVirtualMachineSpec defines the desired state of WindowsVirtualMachine"

fn spec.withDeletionPolicy

withDeletionPolicy(deletionPolicy)

"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource."

obj spec.forProvider

fn spec.forProvider.withAdditionalCapabilities

withAdditionalCapabilities(additionalCapabilities)

"A additional_capabilities block as defined below."

fn spec.forProvider.withAdditionalCapabilitiesMixin

withAdditionalCapabilitiesMixin(additionalCapabilities)

"A additional_capabilities block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withAdditionalUnattendContent

withAdditionalUnattendContent(additionalUnattendContent)

"One or more additional_unattend_content blocks as defined below. Changing this forces a new resource to be created."

fn spec.forProvider.withAdditionalUnattendContentMixin

withAdditionalUnattendContentMixin(additionalUnattendContent)

"One or more additional_unattend_content blocks as defined below. Changing this forces a new resource to be created."

Note: This function appends passed data to existing values

fn spec.forProvider.withAdminUsername

withAdminUsername(adminUsername)

"The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created."

fn spec.forProvider.withAllowExtensionOperations

withAllowExtensionOperations(allowExtensionOperations)

"Should Extension Operations be allowed on this Virtual Machine? Defaults to true."

fn spec.forProvider.withAvailabilitySetId

withAvailabilitySetId(availabilitySetId)

"Specifies the ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created."

fn spec.forProvider.withBootDiagnostics

withBootDiagnostics(bootDiagnostics)

"A boot_diagnostics block as defined below."

fn spec.forProvider.withBootDiagnosticsMixin

withBootDiagnosticsMixin(bootDiagnostics)

"A boot_diagnostics block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withCapacityReservationGroupId

withCapacityReservationGroupId(capacityReservationGroupId)

"Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to."

fn spec.forProvider.withComputerName

withComputerName(computerName)

"Specifies the Hostname which should be used for this Virtual Machine. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid computer_name, then you must specify computer_name. Changing this forces a new resource to be created."

fn spec.forProvider.withDedicatedHostGroupId

withDedicatedHostGroupId(dedicatedHostGroupId)

"The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with dedicated_host_id."

fn spec.forProvider.withDedicatedHostId

withDedicatedHostId(dedicatedHostId)

"The ID of a Dedicated Host where this machine should be run on. Conflicts with dedicated_host_group_id."

fn spec.forProvider.withEdgeZone

withEdgeZone(edgeZone)

"Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine should exist. Changing this forces a new Windows Virtual Machine to be created."

fn spec.forProvider.withEnableAutomaticUpdates

withEnableAutomaticUpdates(enableAutomaticUpdates)

"Specifies if Automatic Updates are Enabled for the Windows Virtual Machine. Changing this forces a new resource to be created. Defaults to true."

fn spec.forProvider.withEncryptionAtHostEnabled

withEncryptionAtHostEnabled(encryptionAtHostEnabled)

"Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?"

fn spec.forProvider.withEvictionPolicy

withEvictionPolicy(evictionPolicy)

"Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are Deallocate and Delete. Changing this forces a new resource to be created."

fn spec.forProvider.withExtensionsTimeBudget

withExtensionsTimeBudget(extensionsTimeBudget)

"Specifies the duration allocated for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to 90 minutes (PT1H30M)."

fn spec.forProvider.withGalleryApplication

withGalleryApplication(galleryApplication)

"A gallery_application block as defined below."

fn spec.forProvider.withGalleryApplicationMixin

withGalleryApplicationMixin(galleryApplication)

"A gallery_application block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withHotpatchingEnabled

withHotpatchingEnabled(hotpatchingEnabled)

"Should the VM be patched without requiring a reboot? Possible values are true or false. Defaults to false. For more information about hot patching please see the product documentation."

fn spec.forProvider.withIdentity

withIdentity(identity)

"An identity block as defined below."

fn spec.forProvider.withIdentityMixin

withIdentityMixin(identity)

"An identity block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withLicenseType

withLicenseType(licenseType)

"Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are None, Windows_Client and Windows_Server."

fn spec.forProvider.withLocation

withLocation(location)

"The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created."

fn spec.forProvider.withMaxBidPrice

withMaxBidPrice(maxBidPrice)

"The maximum price you're willing to pay for this Virtual Machine, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machine will be evicted using the eviction_policy. Defaults to -1, which means that the Virtual Machine should not be evicted for price reasons."

fn spec.forProvider.withNetworkInterfaceIds

withNetworkInterfaceIds(networkInterfaceIds)

". A list of Network Interface IDs which should be attached to this Virtual Machine. The first Network Interface ID in this list will be the Primary Network Interface on the Virtual Machine."

fn spec.forProvider.withNetworkInterfaceIdsMixin

withNetworkInterfaceIdsMixin(networkInterfaceIds)

". A list of Network Interface IDs which should be attached to this Virtual Machine. The first Network Interface ID in this list will be the Primary Network Interface on the Virtual Machine."

Note: This function appends passed data to existing values

fn spec.forProvider.withNetworkInterfaceIdsRefs

withNetworkInterfaceIdsRefs(networkInterfaceIdsRefs)

"References to NetworkInterface in network to populate networkInterfaceIds."

fn spec.forProvider.withNetworkInterfaceIdsRefsMixin

withNetworkInterfaceIdsRefsMixin(networkInterfaceIdsRefs)

"References to NetworkInterface in network to populate networkInterfaceIds."

Note: This function appends passed data to existing values

fn spec.forProvider.withOsDisk

withOsDisk(osDisk)

"A os_disk block as defined below."

fn spec.forProvider.withOsDiskMixin

withOsDiskMixin(osDisk)

"A os_disk block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withPatchAssessmentMode

withPatchAssessmentMode(patchAssessmentMode)

"Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are AutomaticByPlatform or ImageDefault. Defaults to ImageDefault."

fn spec.forProvider.withPatchMode

withPatchMode(patchMode)

"Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are Manual, AutomaticByOS and AutomaticByPlatform. Defaults to AutomaticByOS. For more information on patch modes please see the product documentation."

fn spec.forProvider.withPlan

withPlan(plan)

"A plan block as defined below. Changing this forces a new resource to be created."

fn spec.forProvider.withPlanMixin

withPlanMixin(plan)

"A plan block as defined below. Changing this forces a new resource to be created."

Note: This function appends passed data to existing values

fn spec.forProvider.withPlatformFaultDomain

withPlatformFaultDomain(platformFaultDomain)

"Specifies the Platform Fault Domain in which this Windows Virtual Machine should be created. Defaults to -1, which means this will be automatically assigned to a fault domain that best maintains balance across the available fault domains. Changing this forces a new Windows Virtual Machine to be created."

fn spec.forProvider.withPriority

withPriority(priority)

"Specifies the priority of this Virtual Machine. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created."

fn spec.forProvider.withProvisionVmAgent

withProvisionVmAgent(provisionVmAgent)

"Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to true. Changing this forces a new resource to be created."

fn spec.forProvider.withProximityPlacementGroupId

withProximityPlacementGroupId(proximityPlacementGroupId)

"The ID of the Proximity Placement Group which the Virtual Machine should be assigned to."

fn spec.forProvider.withResourceGroupName

withResourceGroupName(resourceGroupName)

"The name of the Resource Group in which the Windows Virtual Machine should be exist. Changing this forces a new resource to be created."

fn spec.forProvider.withSecret

withSecret(secret)

"One or more secret blocks as defined below."

fn spec.forProvider.withSecretMixin

withSecretMixin(secret)

"One or more secret blocks as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withSecureBootEnabled

withSecureBootEnabled(secureBootEnabled)

"Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created."

fn spec.forProvider.withSize

withSize(size)

"The SKU which should be used for this Virtual Machine, such as Standard_F2."

fn spec.forProvider.withSourceImageId

withSourceImageId(sourceImageId)

"The ID of the Image which this Virtual Machine should be created from. Changing this forces a new resource to be created. Possible Image ID types include Image IDs, Shared Image IDs, Shared Image Version IDs, Community Gallery Image IDs, Community Gallery Image Version IDs, Shared Gallery Image IDs and Shared Gallery Image Version IDs."

fn spec.forProvider.withSourceImageReference

withSourceImageReference(sourceImageReference)

"A source_image_reference block as defined below. Changing this forces a new resource to be created."

fn spec.forProvider.withSourceImageReferenceMixin

withSourceImageReferenceMixin(sourceImageReference)

"A source_image_reference block as defined below. Changing this forces a new resource to be created."

Note: This function appends passed data to existing values

fn spec.forProvider.withTags

withTags(tags)

"A mapping of tags which should be assigned to this Virtual Machine."

fn spec.forProvider.withTagsMixin

withTagsMixin(tags)

"A mapping of tags which should be assigned to this Virtual Machine."

Note: This function appends passed data to existing values

fn spec.forProvider.withTerminationNotification

withTerminationNotification(terminationNotification)

"A termination_notification block as defined below."

fn spec.forProvider.withTerminationNotificationMixin

withTerminationNotificationMixin(terminationNotification)

"A termination_notification block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withTimezone

withTimezone(timezone)

"Specifies the Time Zone which should be used by the Virtual Machine, the possible values are defined here. Changing this forces a new resource to be created."

fn spec.forProvider.withUserData

withUserData(userData)

"The Base64-Encoded User Data which should be used for this Virtual Machine."

fn spec.forProvider.withVirtualMachineScaleSetId

withVirtualMachineScaleSetId(virtualMachineScaleSetId)

"Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created."

fn spec.forProvider.withVtpmEnabled

withVtpmEnabled(vtpmEnabled)

"Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created."

fn spec.forProvider.withWinrmListener

withWinrmListener(winrmListener)

"One or more winrm_listener blocks as defined below. Changing this forces a new resource to be created."

fn spec.forProvider.withWinrmListenerMixin

withWinrmListenerMixin(winrmListener)

"One or more winrm_listener blocks as defined below. Changing this forces a new resource to be created."

Note: This function appends passed data to existing values

fn spec.forProvider.withZone

withZone(zone)

"* zones - Specifies the Availability Zone in which this Windows Virtual Machine should be located. Changing this forces a new Windows Virtual Machine to be created."

obj spec.forProvider.additionalCapabilities

"A additional_capabilities block as defined below."

fn spec.forProvider.additionalCapabilities.withUltraSsdEnabled

withUltraSsdEnabled(ultraSsdEnabled)

"Should the capacity to enable Data Disks of the UltraSSD_LRS storage account type be supported on this Virtual Machine? Defaults to false."

obj spec.forProvider.additionalUnattendContent

"One or more additional_unattend_content blocks as defined below. Changing this forces a new resource to be created."

fn spec.forProvider.additionalUnattendContent.withSetting

withSetting(setting)

"The name of the setting to which the content applies. Possible values are AutoLogon and FirstLogonCommands. Changing this forces a new resource to be created."

obj spec.forProvider.additionalUnattendContent.contentSecretRef

"The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created."

fn spec.forProvider.additionalUnattendContent.contentSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.additionalUnattendContent.contentSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.additionalUnattendContent.contentSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.adminPasswordSecretRef

"The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created."

fn spec.forProvider.adminPasswordSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.adminPasswordSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.adminPasswordSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.bootDiagnostics

"A boot_diagnostics block as defined below."

fn spec.forProvider.bootDiagnostics.withStorageAccountUri

withStorageAccountUri(storageAccountUri)

"The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor."

obj spec.forProvider.customDataSecretRef

"The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created."

fn spec.forProvider.customDataSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.customDataSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.customDataSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.galleryApplication

"A gallery_application block as defined below."

fn spec.forProvider.galleryApplication.withConfigurationBlobUri

withConfigurationBlobUri(configurationBlobUri)

"Specifies the URI to an Azure Blob that will replace the default configuration for the package if provided."

fn spec.forProvider.galleryApplication.withOrder

withOrder(order)

"Specifies the order in which the packages have to be installed. Possible values are between 0 and 2,147,483,647."

fn spec.forProvider.galleryApplication.withTag

withTag(tag)

"Specifies a passthrough value for more generic context. This field can be any valid string value."

fn spec.forProvider.galleryApplication.withVersionId

withVersionId(versionId)

"Specifies the Gallery Application Version resource ID."

obj spec.forProvider.identity

"An identity block as defined below."

fn spec.forProvider.identity.withIdentityIds

withIdentityIds(identityIds)

"Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine."

fn spec.forProvider.identity.withIdentityIdsMixin

withIdentityIdsMixin(identityIds)

"Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine."

Note: This function appends passed data to existing values

fn spec.forProvider.identity.withType

withType(type)

"Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both)."

obj spec.forProvider.networkInterfaceIdsRefs

"References to NetworkInterface in network to populate networkInterfaceIds."

fn spec.forProvider.networkInterfaceIdsRefs.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.networkInterfaceIdsRefs.policy

"Policies for referencing."

fn spec.forProvider.networkInterfaceIdsRefs.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.networkInterfaceIdsRefs.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.networkInterfaceIdsSelector

"Selector for a list of NetworkInterface in network to populate networkInterfaceIds."

fn spec.forProvider.networkInterfaceIdsSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.networkInterfaceIdsSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.networkInterfaceIdsSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.networkInterfaceIdsSelector.policy

"Policies for selection."

fn spec.forProvider.networkInterfaceIdsSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.networkInterfaceIdsSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.osDisk

"A os_disk block as defined below."

fn spec.forProvider.osDisk.withCaching

withCaching(caching)

"The Type of Caching which should be used for the Internal OS Disk. Possible values are None, ReadOnly and ReadWrite."

fn spec.forProvider.osDisk.withDiffDiskSettings

withDiffDiskSettings(diffDiskSettings)

"A diff_disk_settings block as defined above. Changing this forces a new resource to be created."

fn spec.forProvider.osDisk.withDiffDiskSettingsMixin

withDiffDiskSettingsMixin(diffDiskSettings)

"A diff_disk_settings block as defined above. Changing this forces a new resource to be created."

Note: This function appends passed data to existing values

fn spec.forProvider.osDisk.withDiskEncryptionSetId

withDiskEncryptionSetId(diskEncryptionSetId)

"The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with secure_vm_disk_encryption_set_id."

fn spec.forProvider.osDisk.withDiskSizeGb

withDiskSizeGb(diskSizeGb)

"The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from."

fn spec.forProvider.osDisk.withName

withName(name)

"The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created."

fn spec.forProvider.osDisk.withSecureVmDiskEncryptionSetId

withSecureVmDiskEncryptionSetId(secureVmDiskEncryptionSetId)

"The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk when the Virtual Machine is a Confidential VM. Conflicts with disk_encryption_set_id. Changing this forces a new resource to be created."

fn spec.forProvider.osDisk.withSecurityEncryptionType

withSecurityEncryptionType(securityEncryptionType)

"Encryption Type when the Virtual Machine is a Confidential VM. Possible values are VMGuestStateOnly and DiskWithVMGuestState. Changing this forces a new resource to be created."

fn spec.forProvider.osDisk.withStorageAccountType

withStorageAccountType(storageAccountType)

"The Type of Storage Account which should back this the Internal OS Disk. Possible values are Standard_LRS, StandardSSD_LRS, Premium_LRS, StandardSSD_ZRS and Premium_ZRS. Changing this forces a new resource to be created."

fn spec.forProvider.osDisk.withWriteAcceleratorEnabled

withWriteAcceleratorEnabled(writeAcceleratorEnabled)

"Should Write Accelerator be Enabled for this OS Disk? Defaults to false."

obj spec.forProvider.osDisk.diffDiskSettings

"A diff_disk_settings block as defined above. Changing this forces a new resource to be created."

fn spec.forProvider.osDisk.diffDiskSettings.withOption

withOption(option)

"Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is Local. Changing this forces a new resource to be created."

fn spec.forProvider.osDisk.diffDiskSettings.withPlacement

withPlacement(placement)

"Specifies where to store the Ephemeral Disk. Possible values are CacheDisk and ResourceDisk. Defaults to CacheDisk. Changing this forces a new resource to be created."

obj spec.forProvider.plan

"A plan block as defined below. Changing this forces a new resource to be created."

fn spec.forProvider.plan.withName

withName(name)

"Specifies the Name of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created."

fn spec.forProvider.plan.withProduct

withProduct(product)

"Specifies the Product of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created."

fn spec.forProvider.plan.withPublisher

withPublisher(publisher)

"Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created."

obj spec.forProvider.resourceGroupNameRef

"Reference to a ResourceGroup in azure to populate resourceGroupName."

fn spec.forProvider.resourceGroupNameRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.resourceGroupNameRef.policy

"Policies for referencing."

fn spec.forProvider.resourceGroupNameRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.resourceGroupNameRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.resourceGroupNameSelector

"Selector for a ResourceGroup in azure to populate resourceGroupName."

fn spec.forProvider.resourceGroupNameSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.resourceGroupNameSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.resourceGroupNameSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.resourceGroupNameSelector.policy

"Policies for selection."

fn spec.forProvider.resourceGroupNameSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.resourceGroupNameSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.secret

"One or more secret blocks as defined below."

fn spec.forProvider.secret.withCertificate

withCertificate(certificate)

"One or more certificate blocks as defined above."

fn spec.forProvider.secret.withCertificateMixin

withCertificateMixin(certificate)

"One or more certificate blocks as defined above."

Note: This function appends passed data to existing values

fn spec.forProvider.secret.withKeyVaultId

withKeyVaultId(keyVaultId)

"The ID of the Key Vault from which all Secrets should be sourced."

obj spec.forProvider.secret.certificate

"One or more certificate blocks as defined above."

fn spec.forProvider.secret.certificate.withStore

withStore(store)

"The certificate store on the Virtual Machine where the certificate should be added."

fn spec.forProvider.secret.certificate.withUrl

withUrl(url)

"The Secret URL of a Key Vault Certificate."

obj spec.forProvider.sourceImageReference

"A source_image_reference block as defined below. Changing this forces a new resource to be created."

fn spec.forProvider.sourceImageReference.withOffer

withOffer(offer)

"Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created."

fn spec.forProvider.sourceImageReference.withPublisher

withPublisher(publisher)

"Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created."

fn spec.forProvider.sourceImageReference.withSku

withSku(sku)

"Specifies the SKU of the image used to create the virtual machines. Changing this forces a new resource to be created."

fn spec.forProvider.sourceImageReference.withVersion

withVersion(version)

"Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created."

obj spec.forProvider.terminationNotification

"A termination_notification block as defined below."

fn spec.forProvider.terminationNotification.withEnabled

withEnabled(enabled)

"Should the termination notification be enabled on this Virtual Machine?"

fn spec.forProvider.terminationNotification.withTimeout

withTimeout(timeout)

"Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to PT5M."

obj spec.forProvider.winrmListener

"One or more winrm_listener blocks as defined below. Changing this forces a new resource to be created."

fn spec.forProvider.winrmListener.withCertificateUrl

withCertificateUrl(certificateUrl)

"The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to Https. Changing this forces a new resource to be created."

fn spec.forProvider.winrmListener.withProtocol

withProtocol(protocol)

"Specifies the protocol of listener. Possible values are Http or Https. Changing this forces a new resource to be created."

obj spec.providerConfigRef

"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."

fn spec.providerConfigRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerConfigRef.policy

"Policies for referencing."

fn spec.providerConfigRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerConfigRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.providerRef

"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef"

fn spec.providerRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerRef.policy

"Policies for referencing."

fn spec.providerRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo

"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource."

fn spec.publishConnectionDetailsTo.withName

withName(name)

"Name is the name of the connection secret."

obj spec.publishConnectionDetailsTo.configRef

"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."

fn spec.publishConnectionDetailsTo.configRef.withName

withName(name)

"Name of the referenced object."

obj spec.publishConnectionDetailsTo.configRef.policy

"Policies for referencing."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo.metadata

"Metadata is the metadata for connection secret."

fn spec.publishConnectionDetailsTo.metadata.withAnnotations

withAnnotations(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withLabels

withLabels(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withType

withType(type)

"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."

obj spec.writeConnectionSecretToRef

"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other."

fn spec.writeConnectionSecretToRef.withName

withName(name)

"Name of the secret."

fn spec.writeConnectionSecretToRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."