Skip to content

insights.v1beta1.monitorAutoscaleSetting

"MonitorAutoscaleSetting is the Schema for the MonitorAutoscaleSettings API. Manages an AutoScale Setting which can be applied to Virtual Machine Scale Sets, App Services and other scalable resources."

Index

Fields

fn new

new(name)

new returns an instance of MonitorAutoscaleSetting

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

"MonitorAutoscaleSettingSpec defines the desired state of MonitorAutoscaleSetting"

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

withEnabled(enabled)

"Specifies whether automatic scaling is enabled for the target resource. Defaults to true."

fn spec.forProvider.withLocation

withLocation(location)

"Specifies the supported Azure location where the AutoScale Setting should exist. Changing this forces a new resource to be created."

fn spec.forProvider.withName

withName(name)

"The name of the AutoScale Setting. Changing this forces a new resource to be created."

fn spec.forProvider.withNotification

withNotification(notification)

"Specifies a notification block as defined below."

fn spec.forProvider.withNotificationMixin

withNotificationMixin(notification)

"Specifies a notification block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withProfile

withProfile(profile)

"Specifies one or more (up to 20) profile blocks as defined below."

fn spec.forProvider.withProfileMixin

withProfileMixin(profile)

"Specifies one or more (up to 20) profile blocks as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withResourceGroupName

withResourceGroupName(resourceGroupName)

"The name of the Resource Group in the AutoScale Setting should be created. Changing this forces a new resource to be created."

fn spec.forProvider.withTags

withTags(tags)

"A mapping of tags to assign to the resource."

fn spec.forProvider.withTagsMixin

withTagsMixin(tags)

"A mapping of tags to assign to the resource."

Note: This function appends passed data to existing values

fn spec.forProvider.withTargetResourceId

withTargetResourceId(targetResourceId)

"Specifies the resource ID of the resource that the autoscale setting should be added to. Changing this forces a new resource to be created."

obj spec.forProvider.notification

"Specifies a notification block as defined below."

fn spec.forProvider.notification.withEmail

withEmail(email)

"A email block as defined below."

fn spec.forProvider.notification.withEmailMixin

withEmailMixin(email)

"A email block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.notification.withWebhook

withWebhook(webhook)

"One or more webhook blocks as defined below."

fn spec.forProvider.notification.withWebhookMixin

withWebhookMixin(webhook)

"One or more webhook blocks as defined below."

Note: This function appends passed data to existing values

obj spec.forProvider.notification.email

"A email block as defined below."

fn spec.forProvider.notification.email.withCustomEmails

withCustomEmails(customEmails)

"Specifies a list of custom email addresses to which the email notifications will be sent."

fn spec.forProvider.notification.email.withCustomEmailsMixin

withCustomEmailsMixin(customEmails)

"Specifies a list of custom email addresses to which the email notifications will be sent."

Note: This function appends passed data to existing values

fn spec.forProvider.notification.email.withSendToSubscriptionAdministrator

withSendToSubscriptionAdministrator(sendToSubscriptionAdministrator)

"Should email notifications be sent to the subscription administrator? Defaults to false."

fn spec.forProvider.notification.email.withSendToSubscriptionCoAdministrator

withSendToSubscriptionCoAdministrator(sendToSubscriptionCoAdministrator)

"Should email notifications be sent to the subscription co-administrator? Defaults to false."

obj spec.forProvider.notification.webhook

"One or more webhook blocks as defined below."

fn spec.forProvider.notification.webhook.withProperties

withProperties(properties)

"A map of settings."

fn spec.forProvider.notification.webhook.withPropertiesMixin

withPropertiesMixin(properties)

"A map of settings."

Note: This function appends passed data to existing values

fn spec.forProvider.notification.webhook.withServiceUri

withServiceUri(serviceUri)

"The HTTPS URI which should receive scale notifications."

obj spec.forProvider.profile

"Specifies one or more (up to 20) profile blocks as defined below."

fn spec.forProvider.profile.withCapacity

withCapacity(capacity)

"A capacity block as defined below."

fn spec.forProvider.profile.withCapacityMixin

withCapacityMixin(capacity)

"A capacity block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.profile.withFixedDate

withFixedDate(fixedDate)

"A fixed_date block as defined below. This cannot be specified if a recurrence block is specified."

fn spec.forProvider.profile.withFixedDateMixin

withFixedDateMixin(fixedDate)

"A fixed_date block as defined below. This cannot be specified if a recurrence block is specified."

Note: This function appends passed data to existing values

fn spec.forProvider.profile.withName

withName(name)

"Specifies the name of the profile."

fn spec.forProvider.profile.withRecurrence

withRecurrence(recurrence)

"A recurrence block as defined below. This cannot be specified if a fixed_date block is specified."

fn spec.forProvider.profile.withRecurrenceMixin

withRecurrenceMixin(recurrence)

"A recurrence block as defined below. This cannot be specified if a fixed_date block is specified."

Note: This function appends passed data to existing values

fn spec.forProvider.profile.withRule

withRule(rule)

"One or more (up to 10) rule blocks as defined below."

fn spec.forProvider.profile.withRuleMixin

withRuleMixin(rule)

"One or more (up to 10) rule blocks as defined below."

Note: This function appends passed data to existing values

obj spec.forProvider.profile.capacity

"A capacity block as defined below."

fn spec.forProvider.profile.capacity.withDefault

withDefault(default)

"The number of instances that are available for scaling if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default. Valid values are between 0 and 1000."

fn spec.forProvider.profile.capacity.withMaximum

withMaximum(maximum)

"The maximum number of instances for this resource. Valid values are between 0 and 1000."

fn spec.forProvider.profile.capacity.withMinimum

withMinimum(minimum)

"The minimum number of instances for this resource. Valid values are between 0 and 1000."

obj spec.forProvider.profile.fixedDate

"A fixed_date block as defined below. This cannot be specified if a recurrence block is specified."

fn spec.forProvider.profile.fixedDate.withEnd

withEnd(end)

"Specifies the end date for the profile, formatted as an RFC3339 date string."

fn spec.forProvider.profile.fixedDate.withStart

withStart(start)

"Specifies the start date for the profile, formatted as an RFC3339 date string."

fn spec.forProvider.profile.fixedDate.withTimezone

withTimezone(timezone)

"The Time Zone used for the hours field. A list of possible values can be found here. Defaults to UTC."

obj spec.forProvider.profile.recurrence

"A recurrence block as defined below. This cannot be specified if a fixed_date block is specified."

fn spec.forProvider.profile.recurrence.withDays

withDays(days)

"A list of days that this profile takes effect on. Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday."

fn spec.forProvider.profile.recurrence.withDaysMixin

withDaysMixin(days)

"A list of days that this profile takes effect on. Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday."

Note: This function appends passed data to existing values

fn spec.forProvider.profile.recurrence.withHours

withHours(hours)

"A list containing a single item, which specifies the Hour interval at which this recurrence should be triggered (in 24-hour time). Possible values are from 0 to 23."

fn spec.forProvider.profile.recurrence.withHoursMixin

withHoursMixin(hours)

"A list containing a single item, which specifies the Hour interval at which this recurrence should be triggered (in 24-hour time). Possible values are from 0 to 23."

Note: This function appends passed data to existing values

fn spec.forProvider.profile.recurrence.withMinutes

withMinutes(minutes)

"A list containing a single item which specifies the Minute interval at which this recurrence should be triggered."

fn spec.forProvider.profile.recurrence.withMinutesMixin

withMinutesMixin(minutes)

"A list containing a single item which specifies the Minute interval at which this recurrence should be triggered."

Note: This function appends passed data to existing values

fn spec.forProvider.profile.recurrence.withTimezone

withTimezone(timezone)

"The Time Zone used for the hours field. A list of possible values can be found here. Defaults to UTC."

obj spec.forProvider.profile.rule

"One or more (up to 10) rule blocks as defined below."

fn spec.forProvider.profile.rule.withMetricTrigger

withMetricTrigger(metricTrigger)

"A metric_trigger block as defined below."

fn spec.forProvider.profile.rule.withMetricTriggerMixin

withMetricTriggerMixin(metricTrigger)

"A metric_trigger block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.profile.rule.withScaleAction

withScaleAction(scaleAction)

"A scale_action block as defined below."

fn spec.forProvider.profile.rule.withScaleActionMixin

withScaleActionMixin(scaleAction)

"A scale_action block as defined below."

Note: This function appends passed data to existing values

obj spec.forProvider.profile.rule.metricTrigger

"A metric_trigger block as defined below."

fn spec.forProvider.profile.rule.metricTrigger.withDimensions

withDimensions(dimensions)

"One or more dimensions block as defined below."

fn spec.forProvider.profile.rule.metricTrigger.withDimensionsMixin

withDimensionsMixin(dimensions)

"One or more dimensions block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.profile.rule.metricTrigger.withDivideByInstanceCount

withDivideByInstanceCount(divideByInstanceCount)

"Whether to enable metric divide by instance count."

fn spec.forProvider.profile.rule.metricTrigger.withMetricName

withMetricName(metricName)

"The name of the metric that defines what the rule monitors, such as Percentage CPU for Virtual Machine Scale Sets and CpuPercentage for App Service Plan."

fn spec.forProvider.profile.rule.metricTrigger.withMetricNamespace

withMetricNamespace(metricNamespace)

"The namespace of the metric that defines what the rule monitors, such as microsoft.compute/virtualmachinescalesets for Virtual Machine Scale Sets."

fn spec.forProvider.profile.rule.metricTrigger.withMetricResourceId

withMetricResourceId(metricResourceId)

"The ID of the Resource which the Rule monitors."

fn spec.forProvider.profile.rule.metricTrigger.withOperator

withOperator(operator)

"Specifies the operator used to compare the metric data and threshold. Possible values are: Equals, NotEquals, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual."

fn spec.forProvider.profile.rule.metricTrigger.withStatistic

withStatistic(statistic)

"Specifies how the metrics from multiple instances are combined. Possible values are Average, Max, Min and Sum."

fn spec.forProvider.profile.rule.metricTrigger.withThreshold

withThreshold(threshold)

"Specifies the threshold of the metric that triggers the scale action."

fn spec.forProvider.profile.rule.metricTrigger.withTimeAggregation

withTimeAggregation(timeAggregation)

"Specifies how the data that's collected should be combined over time. Possible values include Average, Count, Maximum, Minimum, Last and Total."

fn spec.forProvider.profile.rule.metricTrigger.withTimeGrain

withTimeGrain(timeGrain)

"Specifies the granularity of metrics that the rule monitors, which must be one of the pre-defined values returned from the metric definitions for the metric. This value must be between 1 minute and 12 hours an be formatted as an ISO 8601 string."

fn spec.forProvider.profile.rule.metricTrigger.withTimeWindow

withTimeWindow(timeWindow)

"Specifies the time range for which data is collected, which must be greater than the delay in metric collection (which varies from resource to resource). This value must be between 5 minutes and 12 hours and be formatted as an ISO 8601 string."

obj spec.forProvider.profile.rule.metricTrigger.dimensions

"One or more dimensions block as defined below."

fn spec.forProvider.profile.rule.metricTrigger.dimensions.withName

withName(name)

"Specifies the name of the profile."

fn spec.forProvider.profile.rule.metricTrigger.dimensions.withOperator

withOperator(operator)

"Specifies the operator used to compare the metric data and threshold. Possible values are: Equals, NotEquals, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual."

fn spec.forProvider.profile.rule.metricTrigger.dimensions.withValues

withValues(values)

"A list of dimension values."

fn spec.forProvider.profile.rule.metricTrigger.dimensions.withValuesMixin

withValuesMixin(values)

"A list of dimension values."

Note: This function appends passed data to existing values

obj spec.forProvider.profile.rule.metricTrigger.metricResourceIdRef

"Reference to a LinuxVirtualMachineScaleSet in compute to populate metricResourceId."

fn spec.forProvider.profile.rule.metricTrigger.metricResourceIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.profile.rule.metricTrigger.metricResourceIdRef.policy

"Policies for referencing."

fn spec.forProvider.profile.rule.metricTrigger.metricResourceIdRef.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.profile.rule.metricTrigger.metricResourceIdRef.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.profile.rule.metricTrigger.metricResourceIdSelector

"Selector for a LinuxVirtualMachineScaleSet in compute to populate metricResourceId."

fn spec.forProvider.profile.rule.metricTrigger.metricResourceIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.profile.rule.metricTrigger.metricResourceIdSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.profile.rule.metricTrigger.metricResourceIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.profile.rule.metricTrigger.metricResourceIdSelector.policy

"Policies for selection."

fn spec.forProvider.profile.rule.metricTrigger.metricResourceIdSelector.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.profile.rule.metricTrigger.metricResourceIdSelector.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.profile.rule.scaleAction

"A scale_action block as defined below."

fn spec.forProvider.profile.rule.scaleAction.withCooldown

withCooldown(cooldown)

"The amount of time to wait since the last scaling action before this action occurs. Must be between 1 minute and 1 week and formatted as a ISO 8601 string."

fn spec.forProvider.profile.rule.scaleAction.withDirection

withDirection(direction)

"The scale direction. Possible values are Increase and Decrease."

fn spec.forProvider.profile.rule.scaleAction.withType

withType(type)

"The type of action that should occur. Possible values are ChangeCount, ExactCount, PercentChangeCount and ServiceAllowedNextValue."

fn spec.forProvider.profile.rule.scaleAction.withValue

withValue(value)

"The number of instances involved in the scaling action."

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

"Reference to a LinuxVirtualMachineScaleSet in compute to populate targetResourceId."

fn spec.forProvider.targetResourceIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.targetResourceIdRef.policy

"Policies for referencing."

fn spec.forProvider.targetResourceIdRef.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.targetResourceIdRef.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.targetResourceIdSelector

"Selector for a LinuxVirtualMachineScaleSet in compute to populate targetResourceId."

fn spec.forProvider.targetResourceIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.targetResourceIdSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.targetResourceIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.targetResourceIdSelector.policy

"Policies for selection."

fn spec.forProvider.targetResourceIdSelector.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.targetResourceIdSelector.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.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."