compute.v1beta1.orchestratedVirtualMachineScaleSet

"OrchestratedVirtualMachineScaleSet is the Schema for the OrchestratedVirtualMachineScaleSets API. Manages an Orchestrated Virtual Machine Scale Set."

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of OrchestratedVirtualMachineScaleSet

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"

fn metadata.withSelfLink

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

"OrchestratedVirtualMachineScaleSetSpec defines the desired state of OrchestratedVirtualMachineScaleSet"

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)

"An additional_capabilities block as defined below."

fn spec.forProvider.withAdditionalCapabilitiesMixin

withAdditionalCapabilitiesMixin(additionalCapabilities)

"An additional_capabilities block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withAutomaticInstanceRepair

withAutomaticInstanceRepair(automaticInstanceRepair)

"An automatic_instance_repair block as defined below."

fn spec.forProvider.withAutomaticInstanceRepairMixin

withAutomaticInstanceRepairMixin(automaticInstanceRepair)

"An automatic_instance_repair block as defined below."

Note: This function appends passed data to existing values

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 Scale Set should be allocated to. Changing this forces a new resource to be created."

fn spec.forProvider.withDataDisk

withDataDisk(dataDisk)

"One or more data_disk blocks as defined below."

fn spec.forProvider.withDataDiskMixin

withDataDiskMixin(dataDisk)

"One or more data_disk blocks as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withEncryptionAtHostEnabled

withEncryptionAtHostEnabled(encryptionAtHostEnabled)

"Should disks attached to this Virtual Machine Scale Set be encrypted by enabling Encryption at Host?"

fn spec.forProvider.withEvictionPolicy

withEvictionPolicy(evictionPolicy)

"The Policy which should be used Virtual Machines are Evicted from the Scale Set. Possible values are Deallocate and Delete. Changing this forces a new resource to be created."

fn spec.forProvider.withExtension

withExtension(extension)

"One or more extension blocks as defined below"

fn spec.forProvider.withExtensionMixin

withExtensionMixin(extension)

"One or more extension blocks as defined below"

Note: This function appends passed data to existing values

fn spec.forProvider.withExtensionOperationsEnabled

withExtensionOperationsEnabled(extensionOperationsEnabled)

"Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are true or false. Defaults to true. Changing this forces a new Orchestrated Virtual Machine Scale Set to be created."

fn spec.forProvider.withExtensionsTimeBudget

withExtensionsTimeBudget(extensionsTimeBudget)

"Specifies the time alloted 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. The default value is 90 minutes (PT1H30M)."

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.withInstances

withInstances(instances)

"The number of Virtual Machines in the Orcestrated Virtual Machine Scale Set."

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 Orchestrated Virtual Machine Scale Set. Possible values are None, Windows_Client and Windows_Server."

fn spec.forProvider.withLocation

withLocation(location)

"The Azure location where the Orchestrated Virtual Machine Scale Set 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 each Orchestrated Virtual Machine in this Scale Set, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machines in the Scale Set will be evicted using the eviction_policy. Defaults to -1, which means that each Virtual Machine in the Orchestrated Scale Set should not be evicted for price reasons."

fn spec.forProvider.withNetworkInterface

withNetworkInterface(networkInterface)

"One or more network_interface blocks as defined below."

fn spec.forProvider.withNetworkInterfaceMixin

withNetworkInterfaceMixin(networkInterface)

"One or more network_interface blocks as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withOsDisk

withOsDisk(osDisk)

"An os_disk block as defined below."

fn spec.forProvider.withOsDiskMixin

withOsDiskMixin(osDisk)

"An os_disk block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withOsProfile

withOsProfile(osProfile)

"An os_profile block as defined below."

fn spec.forProvider.withOsProfileMixin

withOsProfileMixin(osProfile)

"An os_profile block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withPlan

withPlan(plan)

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

fn spec.forProvider.withPlanMixin

withPlanMixin(plan)

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

Note: This function appends passed data to existing values

fn spec.forProvider.withPlatformFaultDomainCount

withPlatformFaultDomainCount(platformFaultDomainCount)

"Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created."

fn spec.forProvider.withPriority

withPriority(priority)

"The Priority of this Orchestrated Virtual Machine Scale Set. Possible values are Regular and Spot. Defaults to Regular. Changing this value forces a new resource."

fn spec.forProvider.withProximityPlacementGroupId

withProximityPlacementGroupId(proximityPlacementGroupId)

"The ID of the Proximity Placement Group which the Orchestrated Virtual Machine should be assigned to. Changing this forces a new resource to be created."

fn spec.forProvider.withResourceGroupName

withResourceGroupName(resourceGroupName)

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

fn spec.forProvider.withSinglePlacementGroup

withSinglePlacementGroup(singlePlacementGroup)

"Should this Virtual Machine Scale Set be limited to a Single Placement Group, which means the number of instances will be capped at 100 Virtual Machines. Possible values are true or false."

fn spec.forProvider.withSkuName

withSkuName(skuName)

"The name of the SKU to be used by this Orcestrated Virtual Machine Scale Set. Valid values include: any of the General purpose, Compute optimized, Memory optimized, Storage optimized, GPU optimized, FPGA optimized, High performance, or Previous generation virtual machine SKUs."

fn spec.forProvider.withSourceImageId

withSourceImageId(sourceImageId)

"The ID of an Image which each Virtual Machine in this Scale Set should be based on. 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."

fn spec.forProvider.withSourceImageReferenceMixin

withSourceImageReferenceMixin(sourceImageReference)

"A source_image_reference block as defined below."

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 Orchestrated Virtual Machine Scale Set."

fn spec.forProvider.withTagsMixin

withTagsMixin(tags)

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

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.withZoneBalance

withZoneBalance(zoneBalance)

"Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to false. Changing this forces a new resource to be created."

fn spec.forProvider.withZones

withZones(zones)

"Specifies a list of Availability Zones in which this Orchestrated Virtual Machine should be located. Changing this forces a new Orchestrated Virtual Machine to be created."

fn spec.forProvider.withZonesMixin

withZonesMixin(zones)

"Specifies a list of Availability Zones in which this Orchestrated Virtual Machine should be located. Changing this forces a new Orchestrated Virtual Machine to be created."

Note: This function appends passed data to existing values

obj spec.forProvider.additionalCapabilities

"An 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 Orchestrated Virtual Machine Scale Set? Defaults to false. Changing this forces a new resource to be created."

obj spec.forProvider.automaticInstanceRepair

"An automatic_instance_repair block as defined below."

fn spec.forProvider.automaticInstanceRepair.withEnabled

withEnabled(enabled)

"Should the automatic instance repair be enabled on this Orchestrated Virtual Machine Scale Set? Possible values are true and false."

fn spec.forProvider.automaticInstanceRepair.withGracePeriod

withGracePeriod(gracePeriod)

"Amount of time for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. Possible values are between 30 and 90 minutes. Defaults to 30 minutes. The time duration should be specified in ISO 8601 format (e.g. PT30M to PT90M)."

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. By including a boot_diagnostics block without passing the storage_account_uri field will cause the API to utilize a Managed Storage Account to store the Boot Diagnostics output."

obj spec.forProvider.dataDisk

"One or more data_disk blocks as defined below."

fn spec.forProvider.dataDisk.withCaching

withCaching(caching)

"The type of Caching which should be used for this Data Disk. Possible values are None, ReadOnly and ReadWrite."

fn spec.forProvider.dataDisk.withCreateOption

withCreateOption(createOption)

"The create option which should be used for this Data Disk. Possible values are Empty and FromImage. Defaults to Empty. (FromImage should only be used if the source image includes data disks)."

fn spec.forProvider.dataDisk.withDiskEncryptionSetId

withDiskEncryptionSetId(diskEncryptionSetId)

"The ID of the Disk Encryption Set which should be used to encrypt the Data Disk. Changing this forces a new resource to be created."

fn spec.forProvider.dataDisk.withDiskSizeGb

withDiskSizeGb(diskSizeGb)

"The size of the Data Disk which should be created."

fn spec.forProvider.dataDisk.withLun

withLun(lun)

"The Logical Unit Number of the Data Disk, which must be unique within the Virtual Machine."

fn spec.forProvider.dataDisk.withStorageAccountType

withStorageAccountType(storageAccountType)

"The Type of Storage Account which should back this Data Disk. Possible values include Standard_LRS, StandardSSD_LRS, StandardSSD_ZRS, Premium_LRS, PremiumV2_LRS, Premium_ZRS and UltraSSD_LRS."

fn spec.forProvider.dataDisk.withUltraSsdDiskIopsReadWrite

withUltraSsdDiskIopsReadWrite(ultraSsdDiskIopsReadWrite)

"Specifies the Read-Write IOPS for this Data Disk. Only settable for UltraSSD disks."

fn spec.forProvider.dataDisk.withUltraSsdDiskMbpsReadWrite

withUltraSsdDiskMbpsReadWrite(ultraSsdDiskMbpsReadWrite)

"Specifies the bandwidth in MB per second for this Data Disk. Only settable for UltraSSD disks."

fn spec.forProvider.dataDisk.withWriteAcceleratorEnabled

withWriteAcceleratorEnabled(writeAcceleratorEnabled)

"Specifies if Write Accelerator is enabled on the Data Disk. Defaults to false."

obj spec.forProvider.extension

"One or more extension blocks as defined below"

fn spec.forProvider.extension.withAutoUpgradeMinorVersionEnabled

withAutoUpgradeMinorVersionEnabled(autoUpgradeMinorVersionEnabled)

"Should the latest version of the Extension be used at Deployment Time, if one is available? This won't auto-update the extension on existing installation. Defaults to true."

fn spec.forProvider.extension.withExtensionsToProvisionAfterVmCreation

withExtensionsToProvisionAfterVmCreation(extensionsToProvisionAfterVmCreation)

"An ordered list of Extension names which Orchestrated Virtual Machine Scale Set should provision after VM creation."

fn spec.forProvider.extension.withExtensionsToProvisionAfterVmCreationMixin

withExtensionsToProvisionAfterVmCreationMixin(extensionsToProvisionAfterVmCreation)

"An ordered list of Extension names which Orchestrated Virtual Machine Scale Set should provision after VM creation."

Note: This function appends passed data to existing values

fn spec.forProvider.extension.withFailureSuppressionEnabled

withFailureSuppressionEnabled(failureSuppressionEnabled)

"Should failures from the extension be suppressed? Possible values are true or false."

fn spec.forProvider.extension.withForceExtensionExecutionOnChange

withForceExtensionExecutionOnChange(forceExtensionExecutionOnChange)

"A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn't changed."

fn spec.forProvider.extension.withName

withName(name)

"The name for the Virtual Machine Scale Set Extension."

fn spec.forProvider.extension.withProtectedSettingsFromKeyVault

withProtectedSettingsFromKeyVault(protectedSettingsFromKeyVault)

"A protected_settings_from_key_vault block as defined below."

fn spec.forProvider.extension.withProtectedSettingsFromKeyVaultMixin

withProtectedSettingsFromKeyVaultMixin(protectedSettingsFromKeyVault)

"A protected_settings_from_key_vault block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.extension.withPublisher

withPublisher(publisher)

"Specifies the Publisher of the Extension."

fn spec.forProvider.extension.withSettings

withSettings(settings)

"A JSON String which specifies Settings for the Extension."

fn spec.forProvider.extension.withType

withType(type)

"Specifies the Type of the Extension."

fn spec.forProvider.extension.withTypeHandlerVersion

withTypeHandlerVersion(typeHandlerVersion)

"Specifies the version of the extension to use, available versions can be found using the Azure CLI."

obj spec.forProvider.extension.protectedSettingsFromKeyVault

"A protected_settings_from_key_vault block as defined below."

fn spec.forProvider.extension.protectedSettingsFromKeyVault.withSecretUrl

withSecretUrl(secretUrl)

"The URL to the Key Vault Secret which stores the protected settings."

fn spec.forProvider.extension.protectedSettingsFromKeyVault.withSourceVaultId

withSourceVaultId(sourceVaultId)

"The ID of the source Key Vault."

obj spec.forProvider.extension.protectedSettingsSecretRef

"A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension."

fn spec.forProvider.extension.protectedSettingsSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.extension.protectedSettingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.extension.protectedSettingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.identity

"An identity block as defined below."

fn spec.forProvider.identity.withIdentityIds

withIdentityIds(identityIds)

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

fn spec.forProvider.identity.withIdentityIdsMixin

withIdentityIdsMixin(identityIds)

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

Note: This function appends passed data to existing values

fn spec.forProvider.identity.withType

withType(type)

"The type of Managed Identity that should be configured on this Orchestrated Windows Virtual Machine Scale Set. Only possible value is UserAssigned."

obj spec.forProvider.networkInterface

"One or more network_interface blocks as defined below."

fn spec.forProvider.networkInterface.withDnsServers

withDnsServers(dnsServers)

"A list of IP Addresses of DNS Servers which should be assigned to the Network Interface."

fn spec.forProvider.networkInterface.withDnsServersMixin

withDnsServersMixin(dnsServers)

"A list of IP Addresses of DNS Servers which should be assigned to the Network Interface."

Note: This function appends passed data to existing values

fn spec.forProvider.networkInterface.withEnableAcceleratedNetworking

withEnableAcceleratedNetworking(enableAcceleratedNetworking)

"Does this Network Interface support Accelerated Networking? Possible values are true and false. Defaults to false."

fn spec.forProvider.networkInterface.withEnableIpForwarding

withEnableIpForwarding(enableIpForwarding)

"Does this Network Interface support IP Forwarding? Possible values are true and false. Defaults to false."

fn spec.forProvider.networkInterface.withIpConfiguration

withIpConfiguration(ipConfiguration)

"One or more ip_configuration blocks as defined above."

fn spec.forProvider.networkInterface.withIpConfigurationMixin

withIpConfigurationMixin(ipConfiguration)

"One or more ip_configuration blocks as defined above."

Note: This function appends passed data to existing values

fn spec.forProvider.networkInterface.withName

withName(name)

"The Name which should be used for this Network Interface. Changing this forces a new resource to be created."

fn spec.forProvider.networkInterface.withNetworkSecurityGroupId

withNetworkSecurityGroupId(networkSecurityGroupId)

"The ID of a Network Security Group which should be assigned to this Network Interface."

fn spec.forProvider.networkInterface.withPrimary

withPrimary(primary)

"Is this the Primary IP Configuration? Possible values are true and false. Defaults to false."

obj spec.forProvider.networkInterface.ipConfiguration

"One or more ip_configuration blocks as defined above."

fn spec.forProvider.networkInterface.ipConfiguration.withApplicationGatewayBackendAddressPoolIds

withApplicationGatewayBackendAddressPoolIds(applicationGatewayBackendAddressPoolIds)

"A list of Backend Address Pools IDs from a Application Gateway which this Orchestrated Virtual Machine Scale Set should be connected to."

fn spec.forProvider.networkInterface.ipConfiguration.withApplicationGatewayBackendAddressPoolIdsMixin

withApplicationGatewayBackendAddressPoolIdsMixin(applicationGatewayBackendAddressPoolIds)

"A list of Backend Address Pools IDs from a Application Gateway which this Orchestrated Virtual Machine Scale Set should be connected to."

Note: This function appends passed data to existing values

fn spec.forProvider.networkInterface.ipConfiguration.withApplicationSecurityGroupIds

withApplicationSecurityGroupIds(applicationSecurityGroupIds)

"A list of Application Security Group IDs which this Orchestrated Virtual Machine Scale Set should be connected to."

fn spec.forProvider.networkInterface.ipConfiguration.withApplicationSecurityGroupIdsMixin

withApplicationSecurityGroupIdsMixin(applicationSecurityGroupIds)

"A list of Application Security Group IDs which this Orchestrated Virtual Machine Scale Set should be connected to."

Note: This function appends passed data to existing values

fn spec.forProvider.networkInterface.ipConfiguration.withLoadBalancerBackendAddressPoolIds

withLoadBalancerBackendAddressPoolIds(loadBalancerBackendAddressPoolIds)

"A list of Backend Address Pools IDs from a Load Balancer which this Orchestrated Virtual Machine Scale Set should be connected to."

fn spec.forProvider.networkInterface.ipConfiguration.withLoadBalancerBackendAddressPoolIdsMixin

withLoadBalancerBackendAddressPoolIdsMixin(loadBalancerBackendAddressPoolIds)

"A list of Backend Address Pools IDs from a Load Balancer which this Orchestrated Virtual Machine Scale Set should be connected to."

Note: This function appends passed data to existing values

fn spec.forProvider.networkInterface.ipConfiguration.withName

withName(name)

"The Name of the Public IP Address Configuration."

fn spec.forProvider.networkInterface.ipConfiguration.withPrimary

withPrimary(primary)

"Is this the Primary IP Configuration? Possible values are true and false. Defaults to false."

fn spec.forProvider.networkInterface.ipConfiguration.withPublicIpAddress

withPublicIpAddress(publicIpAddress)

"A public_ip_address block as defined below."

fn spec.forProvider.networkInterface.ipConfiguration.withPublicIpAddressMixin

withPublicIpAddressMixin(publicIpAddress)

"A public_ip_address block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.networkInterface.ipConfiguration.withSubnetId

withSubnetId(subnetId)

"The ID of the Subnet which this IP Configuration should be connected to."

fn spec.forProvider.networkInterface.ipConfiguration.withVersion

withVersion(version)

"Specifies the version of the image used to create the virtual machines."

obj spec.forProvider.networkInterface.ipConfiguration.publicIpAddress

"A public_ip_address block as defined below."

fn spec.forProvider.networkInterface.ipConfiguration.publicIpAddress.withDomainNameLabel

withDomainNameLabel(domainNameLabel)

"The Prefix which should be used for the Domain Name Label for each Virtual Machine Instance. Azure concatenates the Domain Name Label and Virtual Machine Index to create a unique Domain Name Label for each Virtual Machine. Valid values must be between 1 and 26 characters long, start with a lower case letter, end with a lower case letter or number and contains only a-z, 0-9 and hyphens."

fn spec.forProvider.networkInterface.ipConfiguration.publicIpAddress.withIdleTimeoutInMinutes

withIdleTimeoutInMinutes(idleTimeoutInMinutes)

"The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range 4 to 32."

fn spec.forProvider.networkInterface.ipConfiguration.publicIpAddress.withIpTag

withIpTag(ipTag)

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

fn spec.forProvider.networkInterface.ipConfiguration.publicIpAddress.withIpTagMixin

withIpTagMixin(ipTag)

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

Note: This function appends passed data to existing values

fn spec.forProvider.networkInterface.ipConfiguration.publicIpAddress.withName

withName(name)

"The Name of the Public IP Address Configuration."

fn spec.forProvider.networkInterface.ipConfiguration.publicIpAddress.withPublicIpPrefixId

withPublicIpPrefixId(publicIpPrefixId)

"The ID of the Public IP Address Prefix from where Public IP Addresses should be allocated. Changing this forces a new resource to be created."

fn spec.forProvider.networkInterface.ipConfiguration.publicIpAddress.withSkuName

withSkuName(skuName)

"The name of the SKU to be used by this Orcestrated Virtual Machine Scale Set. Valid values include: any of the General purpose, Compute optimized, Memory optimized, Storage optimized, GPU optimized, FPGA optimized, High performance, or Previous generation virtual machine SKUs."

fn spec.forProvider.networkInterface.ipConfiguration.publicIpAddress.withVersion

withVersion(version)

"Specifies the version of the image used to create the virtual machines."

obj spec.forProvider.networkInterface.ipConfiguration.publicIpAddress.ipTag

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

fn spec.forProvider.networkInterface.ipConfiguration.publicIpAddress.ipTag.withTag

withTag(tag)

"The IP Tag associated with the Public IP, such as SQL or Storage. Changing this forces a new resource to be created."

fn spec.forProvider.networkInterface.ipConfiguration.publicIpAddress.ipTag.withType

withType(type)

"The Type of IP Tag, such as FirstPartyUsage. Changing this forces a new resource to be created."

obj spec.forProvider.networkInterface.ipConfiguration.subnetIdRef

"Reference to a Subnet in network to populate subnetId."

fn spec.forProvider.networkInterface.ipConfiguration.subnetIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.networkInterface.ipConfiguration.subnetIdRef.policy

"Policies for referencing."

fn spec.forProvider.networkInterface.ipConfiguration.subnetIdRef.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.networkInterface.ipConfiguration.subnetIdRef.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.networkInterface.ipConfiguration.subnetIdSelector

"Selector for a Subnet in network to populate subnetId."

fn spec.forProvider.networkInterface.ipConfiguration.subnetIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.networkInterface.ipConfiguration.subnetIdSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.networkInterface.ipConfiguration.subnetIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.networkInterface.ipConfiguration.subnetIdSelector.policy

"Policies for selection."

fn spec.forProvider.networkInterface.ipConfiguration.subnetIdSelector.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.networkInterface.ipConfiguration.subnetIdSelector.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

"An 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. Changing this forces a new resource to be created."

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 Scale Set is sourced from."

fn spec.forProvider.osDisk.withStorageAccountType

withStorageAccountType(storageAccountType)

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

fn spec.forProvider.osDisk.withWriteAcceleratorEnabled

withWriteAcceleratorEnabled(writeAcceleratorEnabled)

"Specifies if Write Accelerator is enabled on the 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.osProfile

"An os_profile block as defined below."

fn spec.forProvider.osProfile.withLinuxConfiguration

withLinuxConfiguration(linuxConfiguration)

"A linux_configuration block as documented below."

fn spec.forProvider.osProfile.withLinuxConfigurationMixin

withLinuxConfigurationMixin(linuxConfiguration)

"A linux_configuration block as documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.osProfile.withWindowsConfiguration

withWindowsConfiguration(windowsConfiguration)

"A windows_configuration block as documented below."

fn spec.forProvider.osProfile.withWindowsConfigurationMixin

withWindowsConfigurationMixin(windowsConfiguration)

"A windows_configuration block as documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.osProfile.customDataSecretRef

"The Base64-Encoded Custom Data which should be used for this Orchestrated Virtual Machine Scale Set."

fn spec.forProvider.osProfile.customDataSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.osProfile.customDataSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.osProfile.customDataSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.osProfile.linuxConfiguration

"A linux_configuration block as documented below."

fn spec.forProvider.osProfile.linuxConfiguration.withAdminSshKey

withAdminSshKey(adminSshKey)

"A admin_ssh_key block as documented below."

fn spec.forProvider.osProfile.linuxConfiguration.withAdminSshKeyMixin

withAdminSshKeyMixin(adminSshKey)

"A admin_ssh_key block as documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.osProfile.linuxConfiguration.withAdminUsername

withAdminUsername(adminUsername)

"The username of the local administrator on each Orchestrated Virtual Machine Scale Set instance. Changing this forces a new resource to be created."

fn spec.forProvider.osProfile.linuxConfiguration.withComputerNamePrefix

withComputerNamePrefix(computerNamePrefix)

"The prefix which should be used for the name of the Virtual Machines in this Scale Set. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid computer_name_prefix, then you must specify computer_name_prefix. Changing this forces a new resource to be created."

fn spec.forProvider.osProfile.linuxConfiguration.withDisablePasswordAuthentication

withDisablePasswordAuthentication(disablePasswordAuthentication)

"When an admin_password is specified disable_password_authentication must be set to false. Defaults to true."

fn spec.forProvider.osProfile.linuxConfiguration.withPatchAssessmentMode

withPatchAssessmentMode(patchAssessmentMode)

"Specifies the mode of VM Guest Patching for the virtual machines that are associated to the Orchestrated Virtual Machine Scale Set. Possible values are AutomaticByPlatform or ImageDefault. Defaults to ImageDefault."

fn spec.forProvider.osProfile.linuxConfiguration.withPatchMode

withPatchMode(patchMode)

"Specifies the mode of in-guest patching of 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.osProfile.linuxConfiguration.withProvisionVmAgent

withProvisionVmAgent(provisionVmAgent)

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

fn spec.forProvider.osProfile.linuxConfiguration.withSecret

withSecret(secret)

"One or more secret blocks as defined below."

fn spec.forProvider.osProfile.linuxConfiguration.withSecretMixin

withSecretMixin(secret)

"One or more secret blocks as defined below."

Note: This function appends passed data to existing values

obj spec.forProvider.osProfile.linuxConfiguration.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.osProfile.linuxConfiguration.adminPasswordSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.osProfile.linuxConfiguration.adminPasswordSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.osProfile.linuxConfiguration.adminPasswordSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.osProfile.linuxConfiguration.adminSshKey

"A admin_ssh_key block as documented below."

fn spec.forProvider.osProfile.linuxConfiguration.adminSshKey.withPublicKey

withPublicKey(publicKey)

"The Public Key which should be used for authentication, which needs to be at least 2048-bit and in ssh-rsa format."

fn spec.forProvider.osProfile.linuxConfiguration.adminSshKey.withUsername

withUsername(username)

"The Username for which this Public SSH Key should be configured."

obj spec.forProvider.osProfile.linuxConfiguration.secret

"One or more secret blocks as defined below."

fn spec.forProvider.osProfile.linuxConfiguration.secret.withCertificate

withCertificate(certificate)

"One or more certificate blocks as defined below."

fn spec.forProvider.osProfile.linuxConfiguration.secret.withCertificateMixin

withCertificateMixin(certificate)

"One or more certificate blocks as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.osProfile.linuxConfiguration.secret.withKeyVaultId

withKeyVaultId(keyVaultId)

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

obj spec.forProvider.osProfile.linuxConfiguration.secret.certificate

"One or more certificate blocks as defined below."

fn spec.forProvider.osProfile.linuxConfiguration.secret.certificate.withUrl

withUrl(url)

"The Secret URL of a Key Vault Certificate."

obj spec.forProvider.osProfile.windowsConfiguration

"A windows_configuration block as documented below."

fn spec.forProvider.osProfile.windowsConfiguration.withAdminUsername

withAdminUsername(adminUsername)

"The username of the local administrator on each Orchestrated Virtual Machine Scale Set instance. Changing this forces a new resource to be created."

fn spec.forProvider.osProfile.windowsConfiguration.withComputerNamePrefix

withComputerNamePrefix(computerNamePrefix)

"The prefix which should be used for the name of the Virtual Machines in this Scale Set. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid computer_name_prefix, then you must specify computer_name_prefix. Changing this forces a new resource to be created."

fn spec.forProvider.osProfile.windowsConfiguration.withEnableAutomaticUpdates

withEnableAutomaticUpdates(enableAutomaticUpdates)

"Are automatic updates enabled for this Virtual Machine? Defaults to true."

fn spec.forProvider.osProfile.windowsConfiguration.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.osProfile.windowsConfiguration.withPatchAssessmentMode

withPatchAssessmentMode(patchAssessmentMode)

"Specifies the mode of VM Guest Patching for the virtual machines that are associated to the Orchestrated Virtual Machine Scale Set. Possible values are AutomaticByPlatform or ImageDefault. Defaults to ImageDefault."

fn spec.forProvider.osProfile.windowsConfiguration.withPatchMode

withPatchMode(patchMode)

"Specifies the mode of in-guest patching of 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.osProfile.windowsConfiguration.withProvisionVmAgent

withProvisionVmAgent(provisionVmAgent)

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

fn spec.forProvider.osProfile.windowsConfiguration.withSecret

withSecret(secret)

"One or more secret blocks as defined below."

fn spec.forProvider.osProfile.windowsConfiguration.withSecretMixin

withSecretMixin(secret)

"One or more secret blocks as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.osProfile.windowsConfiguration.withTimezone

withTimezone(timezone)

"Specifies the time zone of the virtual machine, the possible values are defined here."

fn spec.forProvider.osProfile.windowsConfiguration.withWinrmListener

withWinrmListener(winrmListener)

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

fn spec.forProvider.osProfile.windowsConfiguration.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

obj spec.forProvider.osProfile.windowsConfiguration.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.osProfile.windowsConfiguration.adminPasswordSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.osProfile.windowsConfiguration.adminPasswordSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.osProfile.windowsConfiguration.adminPasswordSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.osProfile.windowsConfiguration.secret

"One or more secret blocks as defined below."

fn spec.forProvider.osProfile.windowsConfiguration.secret.withCertificate

withCertificate(certificate)

"One or more certificate blocks as defined below."

fn spec.forProvider.osProfile.windowsConfiguration.secret.withCertificateMixin

withCertificateMixin(certificate)

"One or more certificate blocks as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.osProfile.windowsConfiguration.secret.withKeyVaultId

withKeyVaultId(keyVaultId)

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

obj spec.forProvider.osProfile.windowsConfiguration.secret.certificate

"One or more certificate blocks as defined below."

fn spec.forProvider.osProfile.windowsConfiguration.secret.certificate.withStore

withStore(store)

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

fn spec.forProvider.osProfile.windowsConfiguration.secret.certificate.withUrl

withUrl(url)

"The Secret URL of a Key Vault Certificate."

obj spec.forProvider.osProfile.windowsConfiguration.winrmListener

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

fn spec.forProvider.osProfile.windowsConfiguration.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.osProfile.windowsConfiguration.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.forProvider.plan

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

fn spec.forProvider.plan.withName

withName(name)

"Specifies the name of the image from the marketplace. Changing this forces a new resource to be created."

fn spec.forProvider.plan.withProduct

withProduct(product)

"Specifies the product of the image from the marketplace. Changing this forces a new resource to be created."

fn spec.forProvider.plan.withPublisher

withPublisher(publisher)

"Specifies the publisher of the image. 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.sourceImageReference

"A source_image_reference block as defined below."

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."

fn spec.forProvider.sourceImageReference.withVersion

withVersion(version)

"Specifies the version of the image used to create the virtual machines."

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 Scale Set? Possible values true or false"

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.userDataBase64SecretRef

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

fn spec.forProvider.userDataBase64SecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.userDataBase64SecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.userDataBase64SecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

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."