Skip to content

web.v1beta1.functionAppSlot

"FunctionAppSlot is the Schema for the FunctionAppSlots API. Manages a Function App Deployment Slot."

Index

Fields

fn new

new(name)

new returns an instance of FunctionAppSlot

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

"FunctionAppSlotSpec defines the desired state of FunctionAppSlot"

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

withAppServicePlanId(appServicePlanId)

"The ID of the App Service Plan within which to create this Function App Slot. Changing this forces a new resource to be created."

fn spec.forProvider.withAppSettings

withAppSettings(appSettings)

"A key-value pair of App Settings."

fn spec.forProvider.withAppSettingsMixin

withAppSettingsMixin(appSettings)

"A key-value pair of App Settings."

Note: This function appends passed data to existing values

fn spec.forProvider.withAuthSettings

withAuthSettings(authSettings)

"An auth_settings block as defined below."

fn spec.forProvider.withAuthSettingsMixin

withAuthSettingsMixin(authSettings)

"An auth_settings block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withConnectionString

withConnectionString(connectionString)

"A connection_string block as defined below."

fn spec.forProvider.withConnectionStringMixin

withConnectionStringMixin(connectionString)

"A connection_string block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withDailyMemoryTimeQuota

withDailyMemoryTimeQuota(dailyMemoryTimeQuota)

"The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan."

fn spec.forProvider.withEnableBuiltinLogging

withEnableBuiltinLogging(enableBuiltinLogging)

"Should the built-in logging of the Function App be enabled? Defaults to true."

fn spec.forProvider.withEnabled

withEnabled(enabled)

"Is the Function App enabled? Defaults to true."

fn spec.forProvider.withFunctionAppName

withFunctionAppName(functionAppName)

"The name of the Function App within which to create the Function App Slot. Changing this forces a new resource to be created."

fn spec.forProvider.withHttpsOnly

withHttpsOnly(httpsOnly)

"Can the Function App only be accessed via HTTPS? Defaults to false."

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

withLocation(location)

"Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created."

fn spec.forProvider.withOsType

withOsType(osType)

"A string indicating the Operating System type for this function app. The only possible value is linux. Changing this forces a new resource to be created."

fn spec.forProvider.withResourceGroupName

withResourceGroupName(resourceGroupName)

"The name of the resource group in which to create the Function App Slot. Changing this forces a new resource to be created."

fn spec.forProvider.withSiteConfig

withSiteConfig(siteConfig)

"A site_config object as defined below."

fn spec.forProvider.withSiteConfigMixin

withSiteConfigMixin(siteConfig)

"A site_config object as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withStorageAccountName

withStorageAccountName(storageAccountName)

"The backend storage account name which will be used by the Function App (such as the dashboard, logs). 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.withVersion

withVersion(version)

"The runtime version associated with the Function App. Defaults to ~1."

obj spec.forProvider.appServicePlanIdRef

"Reference to a AppServicePlan in web to populate appServicePlanId."

fn spec.forProvider.appServicePlanIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.appServicePlanIdRef.policy

"Policies for referencing."

fn spec.forProvider.appServicePlanIdRef.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.appServicePlanIdRef.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.appServicePlanIdSelector

"Selector for a AppServicePlan in web to populate appServicePlanId."

fn spec.forProvider.appServicePlanIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.appServicePlanIdSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.appServicePlanIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.appServicePlanIdSelector.policy

"Policies for selection."

fn spec.forProvider.appServicePlanIdSelector.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.appServicePlanIdSelector.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.authSettings

"An auth_settings block as defined below."

fn spec.forProvider.authSettings.withActiveDirectory

withActiveDirectory(activeDirectory)

"An active_directory block as defined below."

fn spec.forProvider.authSettings.withActiveDirectoryMixin

withActiveDirectoryMixin(activeDirectory)

"An active_directory block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.authSettings.withAdditionalLoginParams

withAdditionalLoginParams(additionalLoginParams)

"login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form \"key=value\"."

fn spec.forProvider.authSettings.withAdditionalLoginParamsMixin

withAdditionalLoginParamsMixin(additionalLoginParams)

"login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form \"key=value\"."

Note: This function appends passed data to existing values

fn spec.forProvider.authSettings.withAllowedExternalRedirectUrls

withAllowedExternalRedirectUrls(allowedExternalRedirectUrls)

"External URLs that can be redirected to as part of logging in or logging out of the app."

fn spec.forProvider.authSettings.withAllowedExternalRedirectUrlsMixin

withAllowedExternalRedirectUrlsMixin(allowedExternalRedirectUrls)

"External URLs that can be redirected to as part of logging in or logging out of the app."

Note: This function appends passed data to existing values

fn spec.forProvider.authSettings.withDefaultProvider

withDefaultProvider(defaultProvider)

"The default provider to use when multiple providers have been set up. Possible values are AzureActiveDirectory, Facebook, Google, MicrosoftAccount and Twitter."

fn spec.forProvider.authSettings.withEnabled

withEnabled(enabled)

"Is Authentication enabled?"

fn spec.forProvider.authSettings.withFacebook

withFacebook(facebook)

"A facebook block as defined below."

fn spec.forProvider.authSettings.withFacebookMixin

withFacebookMixin(facebook)

"A facebook block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.authSettings.withGoogle

withGoogle(google)

"A google block as defined below."

fn spec.forProvider.authSettings.withGoogleMixin

withGoogleMixin(google)

"A google block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.authSettings.withIssuer

withIssuer(issuer)

"Issuer URI. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/."

fn spec.forProvider.authSettings.withMicrosoft

withMicrosoft(microsoft)

"A microsoft block as defined below."

fn spec.forProvider.authSettings.withMicrosoftMixin

withMicrosoftMixin(microsoft)

"A microsoft block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.authSettings.withRuntimeVersion

withRuntimeVersion(runtimeVersion)

"The runtime version of the Authentication/Authorization module."

fn spec.forProvider.authSettings.withTokenRefreshExtensionHours

withTokenRefreshExtensionHours(tokenRefreshExtensionHours)

"The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to 72."

fn spec.forProvider.authSettings.withTokenStoreEnabled

withTokenStoreEnabled(tokenStoreEnabled)

"If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to false."

fn spec.forProvider.authSettings.withTwitter

withTwitter(twitter)

"A twitter block as defined below."

fn spec.forProvider.authSettings.withTwitterMixin

withTwitterMixin(twitter)

"A twitter block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.authSettings.withUnauthenticatedClientAction

withUnauthenticatedClientAction(unauthenticatedClientAction)

"The action to take when an unauthenticated client attempts to access the app. Possible values are AllowAnonymous and RedirectToLoginPage."

obj spec.forProvider.authSettings.activeDirectory

"An active_directory block as defined below."

fn spec.forProvider.authSettings.activeDirectory.withAllowedAudiences

withAllowedAudiences(allowedAudiences)

"Allowed audience values to consider when validating JWTs issued by Azure Active Directory."

fn spec.forProvider.authSettings.activeDirectory.withAllowedAudiencesMixin

withAllowedAudiencesMixin(allowedAudiences)

"Allowed audience values to consider when validating JWTs issued by Azure Active Directory."

Note: This function appends passed data to existing values

fn spec.forProvider.authSettings.activeDirectory.withClientId

withClientId(clientId)

"The OAuth 2.0 client ID that was created for the app used for authentication."

obj spec.forProvider.authSettings.activeDirectory.clientSecretSecretRef

"The OAuth 2.0 client secret that was created for the app used for authentication."

fn spec.forProvider.authSettings.activeDirectory.clientSecretSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.authSettings.activeDirectory.clientSecretSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.authSettings.activeDirectory.clientSecretSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.authSettings.facebook

"A facebook block as defined below."

fn spec.forProvider.authSettings.facebook.withAppId

withAppId(appId)

"The App ID of the Facebook app used for login"

fn spec.forProvider.authSettings.facebook.withOauthScopes

withOauthScopes(oauthScopes)

"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx"

fn spec.forProvider.authSettings.facebook.withOauthScopesMixin

withOauthScopesMixin(oauthScopes)

"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx"

Note: This function appends passed data to existing values

obj spec.forProvider.authSettings.facebook.appSecretSecretRef

"The App Secret of the Facebook app used for Facebook login."

fn spec.forProvider.authSettings.facebook.appSecretSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.authSettings.facebook.appSecretSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.authSettings.facebook.appSecretSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.authSettings.google

"A google block as defined below."

fn spec.forProvider.authSettings.google.withClientId

withClientId(clientId)

"The OAuth 2.0 client ID that was created for the app used for authentication."

fn spec.forProvider.authSettings.google.withOauthScopes

withOauthScopes(oauthScopes)

"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx"

fn spec.forProvider.authSettings.google.withOauthScopesMixin

withOauthScopesMixin(oauthScopes)

"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx"

Note: This function appends passed data to existing values

obj spec.forProvider.authSettings.google.clientSecretSecretRef

"The OAuth 2.0 client secret that was created for the app used for authentication."

fn spec.forProvider.authSettings.google.clientSecretSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.authSettings.google.clientSecretSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.authSettings.google.clientSecretSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.authSettings.microsoft

"A microsoft block as defined below."

fn spec.forProvider.authSettings.microsoft.withClientId

withClientId(clientId)

"The OAuth 2.0 client ID that was created for the app used for authentication."

fn spec.forProvider.authSettings.microsoft.withOauthScopes

withOauthScopes(oauthScopes)

"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx"

fn spec.forProvider.authSettings.microsoft.withOauthScopesMixin

withOauthScopesMixin(oauthScopes)

"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx"

Note: This function appends passed data to existing values

obj spec.forProvider.authSettings.microsoft.clientSecretSecretRef

"The OAuth 2.0 client secret that was created for the app used for authentication."

fn spec.forProvider.authSettings.microsoft.clientSecretSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.authSettings.microsoft.clientSecretSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.authSettings.microsoft.clientSecretSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.authSettings.twitter

"A twitter block as defined below."

fn spec.forProvider.authSettings.twitter.withConsumerKey

withConsumerKey(consumerKey)

"The OAuth 1.0a consumer key of the Twitter application used for sign-in."

obj spec.forProvider.authSettings.twitter.consumerSecretSecretRef

"The OAuth 1.0a consumer secret of the Twitter application used for sign-in."

fn spec.forProvider.authSettings.twitter.consumerSecretSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.authSettings.twitter.consumerSecretSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.authSettings.twitter.consumerSecretSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.connectionString

"A connection_string block as defined below."

fn spec.forProvider.connectionString.withName

withName(name)

"The name of the Connection String."

fn spec.forProvider.connectionString.withType

withType(type)

"The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer."

obj spec.forProvider.connectionString.valueSecretRef

"The value for the Connection String."

fn spec.forProvider.connectionString.valueSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.connectionString.valueSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.connectionString.valueSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.functionAppNameRef

"Reference to a FunctionApp in web to populate functionAppName."

fn spec.forProvider.functionAppNameRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.functionAppNameRef.policy

"Policies for referencing."

fn spec.forProvider.functionAppNameRef.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.functionAppNameRef.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.functionAppNameSelector

"Selector for a FunctionApp in web to populate functionAppName."

fn spec.forProvider.functionAppNameSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.functionAppNameSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.functionAppNameSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.functionAppNameSelector.policy

"Policies for selection."

fn spec.forProvider.functionAppNameSelector.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.functionAppNameSelector.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.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. Required if type is UserAssigned."

fn spec.forProvider.identity.withIdentityIdsMixin

withIdentityIdsMixin(identityIds)

"Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned."

Note: This function appends passed data to existing values

fn spec.forProvider.identity.withType

withType(type)

"Specifies the identity type of the Function App. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned where you can specify the Service Principal IDs in the identity_ids field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities."

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

"A site_config object as defined below."

fn spec.forProvider.siteConfig.withAlwaysOn

withAlwaysOn(alwaysOn)

"Should the Function App be loaded at all times? Defaults to false."

fn spec.forProvider.siteConfig.withAppScaleLimit

withAppScaleLimit(appScaleLimit)

"The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan."

fn spec.forProvider.siteConfig.withAutoSwapSlotName

withAutoSwapSlotName(autoSwapSlotName)

"The name of the slot to automatically swap to during deployment"

fn spec.forProvider.siteConfig.withCors

withCors(cors)

"A cors block as defined below."

fn spec.forProvider.siteConfig.withCorsMixin

withCorsMixin(cors)

"A cors block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.siteConfig.withDotnetFrameworkVersion

withDotnetFrameworkVersion(dotnetFrameworkVersion)

"The version of the .NET framework's CLR used in this function app. Possible values are v4.0 (including .NET Core 2.1 and 3.1), v5.0 and v6.0. For more information on which .NET Framework version to use based on the runtime version you're targeting - please see this table. Defaults to v4.0."

fn spec.forProvider.siteConfig.withElasticInstanceMinimum

withElasticInstanceMinimum(elasticInstanceMinimum)

"The number of minimum instances for this function app. Only applicable to apps on the Premium plan."

fn spec.forProvider.siteConfig.withFtpsState

withFtpsState(ftpsState)

"State of FTP / FTPS service for this function app. Possible values include: AllAllowed, FtpsOnly and Disabled."

fn spec.forProvider.siteConfig.withHealthCheckPath

withHealthCheckPath(healthCheckPath)

"Path which will be checked for this function app health."

fn spec.forProvider.siteConfig.withHttp2Enabled

withHttp2Enabled(http2Enabled)

"Specifies whether or not the HTTP2 protocol should be enabled. Defaults to false."

fn spec.forProvider.siteConfig.withIpRestriction

withIpRestriction(ipRestriction)

"A List of objects representing IP restrictions as defined below."

fn spec.forProvider.siteConfig.withIpRestrictionMixin

withIpRestrictionMixin(ipRestriction)

"A List of objects representing IP restrictions as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.siteConfig.withJavaVersion

withJavaVersion(javaVersion)

"Java version hosted by the function app in Azure. Possible values are 1.8, 11 & 17 (In-Preview)."

fn spec.forProvider.siteConfig.withLinuxFxVersion

withLinuxFxVersion(linuxFxVersion)

"Linux App Framework and version for the AppService, e.g. DOCKER|(golang:latest)."

fn spec.forProvider.siteConfig.withMinTlsVersion

withMinTlsVersion(minTlsVersion)

"The minimum supported TLS version for the function app. Possible values are 1.0, 1.1, and 1.2. Defaults to 1.2 for new function apps."

fn spec.forProvider.siteConfig.withPreWarmedInstanceCount

withPreWarmedInstanceCount(preWarmedInstanceCount)

"The number of pre-warmed instances for this function app. Only affects apps on the Premium plan."

fn spec.forProvider.siteConfig.withRuntimeScaleMonitoringEnabled

withRuntimeScaleMonitoringEnabled(runtimeScaleMonitoringEnabled)

"Should Runtime Scale Monitoring be enabled?. Only applicable to apps on the Premium plan. Defaults to false."

fn spec.forProvider.siteConfig.withScmIpRestriction

withScmIpRestriction(scmIpRestriction)

"A List of objects representing IP restrictions as defined below."

fn spec.forProvider.siteConfig.withScmIpRestrictionMixin

withScmIpRestrictionMixin(scmIpRestriction)

"A List of objects representing IP restrictions as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.siteConfig.withScmType

withScmType(scmType)

"The type of Source Control used by this function App. Valid values include: BitBucketGit, BitBucketHg, CodePlexGit, CodePlexHg, Dropbox, ExternalGit, ExternalHg, GitHub, LocalGit, None (default), OneDrive, Tfs, VSO, and VSTSRM."

fn spec.forProvider.siteConfig.withScmUseMainIpRestriction

withScmUseMainIpRestriction(scmUseMainIpRestriction)

"IP security restrictions for scm to use main. Defaults to false."

fn spec.forProvider.siteConfig.withUse32BitWorkerProcess

withUse32BitWorkerProcess(use32BitWorkerProcess)

"Should the Function App run in 32 bit mode, rather than 64 bit mode? Defaults to true."

fn spec.forProvider.siteConfig.withVnetRouteAllEnabled

withVnetRouteAllEnabled(vnetRouteAllEnabled)

"Is the Function App enabled? Defaults to true."

fn spec.forProvider.siteConfig.withWebsocketsEnabled

withWebsocketsEnabled(websocketsEnabled)

"Should WebSockets be enabled?"

obj spec.forProvider.siteConfig.cors

"A cors block as defined below."

fn spec.forProvider.siteConfig.cors.withAllowedOrigins

withAllowedOrigins(allowedOrigins)

"A list of origins which should be able to make cross-origin calls. * can be used to allow all calls."

fn spec.forProvider.siteConfig.cors.withAllowedOriginsMixin

withAllowedOriginsMixin(allowedOrigins)

"A list of origins which should be able to make cross-origin calls. * can be used to allow all calls."

Note: This function appends passed data to existing values

fn spec.forProvider.siteConfig.cors.withSupportCredentials

withSupportCredentials(supportCredentials)

"Are credentials supported?"

obj spec.forProvider.siteConfig.ipRestriction

"A List of objects representing IP restrictions as defined below."

fn spec.forProvider.siteConfig.ipRestriction.withAction

withAction(action)

"Allow or Deny access for this IP range. Defaults to Allow."

fn spec.forProvider.siteConfig.ipRestriction.withHeaders

withHeaders(headers)

"The headers for this specific scm_ip_restriction as defined below."

fn spec.forProvider.siteConfig.ipRestriction.withHeadersMixin

withHeadersMixin(headers)

"The headers for this specific scm_ip_restriction as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.siteConfig.ipRestriction.withIpAddress

withIpAddress(ipAddress)

"The IP Address used for this IP Restriction in CIDR notation."

fn spec.forProvider.siteConfig.ipRestriction.withName

withName(name)

"The name for this IP Restriction."

fn spec.forProvider.siteConfig.ipRestriction.withPriority

withPriority(priority)

"The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified."

fn spec.forProvider.siteConfig.ipRestriction.withServiceTag

withServiceTag(serviceTag)

"The Service Tag used for this IP Restriction."

fn spec.forProvider.siteConfig.ipRestriction.withVirtualNetworkSubnetId

withVirtualNetworkSubnetId(virtualNetworkSubnetId)

"The Virtual Network Subnet ID used for this IP Restriction."

obj spec.forProvider.siteConfig.ipRestriction.headers

"The headers for this specific scm_ip_restriction as defined below."

fn spec.forProvider.siteConfig.ipRestriction.headers.withXAzureFdid

withXAzureFdid(xAzureFdid)

"A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8."

fn spec.forProvider.siteConfig.ipRestriction.headers.withXAzureFdidMixin

withXAzureFdidMixin(xAzureFdid)

"A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8."

Note: This function appends passed data to existing values

fn spec.forProvider.siteConfig.ipRestriction.headers.withXFdHealthProbe

withXFdHealthProbe(xFdHealthProbe)

"A list to allow the Azure FrontDoor health probe header. Only allowed value is \"1\"."

fn spec.forProvider.siteConfig.ipRestriction.headers.withXFdHealthProbeMixin

withXFdHealthProbeMixin(xFdHealthProbe)

"A list to allow the Azure FrontDoor health probe header. Only allowed value is \"1\"."

Note: This function appends passed data to existing values

fn spec.forProvider.siteConfig.ipRestriction.headers.withXForwardedFor

withXForwardedFor(xForwardedFor)

"A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8"

fn spec.forProvider.siteConfig.ipRestriction.headers.withXForwardedForMixin

withXForwardedForMixin(xForwardedFor)

"A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8"

Note: This function appends passed data to existing values

fn spec.forProvider.siteConfig.ipRestriction.headers.withXForwardedHost

withXForwardedHost(xForwardedHost)

"A list of allowed 'X-Forwarded-Host' domains with a maximum of 8."

fn spec.forProvider.siteConfig.ipRestriction.headers.withXForwardedHostMixin

withXForwardedHostMixin(xForwardedHost)

"A list of allowed 'X-Forwarded-Host' domains with a maximum of 8."

Note: This function appends passed data to existing values

obj spec.forProvider.siteConfig.ipRestriction.virtualNetworkSubnetIdRef

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

fn spec.forProvider.siteConfig.ipRestriction.virtualNetworkSubnetIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.siteConfig.ipRestriction.virtualNetworkSubnetIdRef.policy

"Policies for referencing."

fn spec.forProvider.siteConfig.ipRestriction.virtualNetworkSubnetIdRef.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.siteConfig.ipRestriction.virtualNetworkSubnetIdRef.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.siteConfig.ipRestriction.virtualNetworkSubnetIdSelector

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

fn spec.forProvider.siteConfig.ipRestriction.virtualNetworkSubnetIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.siteConfig.ipRestriction.virtualNetworkSubnetIdSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.siteConfig.ipRestriction.virtualNetworkSubnetIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.siteConfig.ipRestriction.virtualNetworkSubnetIdSelector.policy

"Policies for selection."

fn spec.forProvider.siteConfig.ipRestriction.virtualNetworkSubnetIdSelector.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.siteConfig.ipRestriction.virtualNetworkSubnetIdSelector.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.siteConfig.scmIpRestriction

"A List of objects representing IP restrictions as defined below."

fn spec.forProvider.siteConfig.scmIpRestriction.withAction

withAction(action)

"Allow or Deny access for this IP range. Defaults to Allow."

fn spec.forProvider.siteConfig.scmIpRestriction.withHeaders

withHeaders(headers)

"The headers for this specific scm_ip_restriction as defined below."

fn spec.forProvider.siteConfig.scmIpRestriction.withHeadersMixin

withHeadersMixin(headers)

"The headers for this specific scm_ip_restriction as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.siteConfig.scmIpRestriction.withIpAddress

withIpAddress(ipAddress)

"The IP Address used for this IP Restriction in CIDR notation."

fn spec.forProvider.siteConfig.scmIpRestriction.withName

withName(name)

"The name for this IP Restriction."

fn spec.forProvider.siteConfig.scmIpRestriction.withPriority

withPriority(priority)

"The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified."

fn spec.forProvider.siteConfig.scmIpRestriction.withServiceTag

withServiceTag(serviceTag)

"The Service Tag used for this IP Restriction."

fn spec.forProvider.siteConfig.scmIpRestriction.withVirtualNetworkSubnetId

withVirtualNetworkSubnetId(virtualNetworkSubnetId)

"The Virtual Network Subnet ID used for this IP Restriction."

obj spec.forProvider.siteConfig.scmIpRestriction.headers

"The headers for this specific scm_ip_restriction as defined below."

fn spec.forProvider.siteConfig.scmIpRestriction.headers.withXAzureFdid

withXAzureFdid(xAzureFdid)

"A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8."

fn spec.forProvider.siteConfig.scmIpRestriction.headers.withXAzureFdidMixin

withXAzureFdidMixin(xAzureFdid)

"A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8."

Note: This function appends passed data to existing values

fn spec.forProvider.siteConfig.scmIpRestriction.headers.withXFdHealthProbe

withXFdHealthProbe(xFdHealthProbe)

"A list to allow the Azure FrontDoor health probe header. Only allowed value is \"1\"."

fn spec.forProvider.siteConfig.scmIpRestriction.headers.withXFdHealthProbeMixin

withXFdHealthProbeMixin(xFdHealthProbe)

"A list to allow the Azure FrontDoor health probe header. Only allowed value is \"1\"."

Note: This function appends passed data to existing values

fn spec.forProvider.siteConfig.scmIpRestriction.headers.withXForwardedFor

withXForwardedFor(xForwardedFor)

"A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8"

fn spec.forProvider.siteConfig.scmIpRestriction.headers.withXForwardedForMixin

withXForwardedForMixin(xForwardedFor)

"A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8"

Note: This function appends passed data to existing values

fn spec.forProvider.siteConfig.scmIpRestriction.headers.withXForwardedHost

withXForwardedHost(xForwardedHost)

"A list of allowed 'X-Forwarded-Host' domains with a maximum of 8."

fn spec.forProvider.siteConfig.scmIpRestriction.headers.withXForwardedHostMixin

withXForwardedHostMixin(xForwardedHost)

"A list of allowed 'X-Forwarded-Host' domains with a maximum of 8."

Note: This function appends passed data to existing values

obj spec.forProvider.siteConfig.scmIpRestriction.virtualNetworkSubnetIdRef

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

fn spec.forProvider.siteConfig.scmIpRestriction.virtualNetworkSubnetIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.siteConfig.scmIpRestriction.virtualNetworkSubnetIdRef.policy

"Policies for referencing."

fn spec.forProvider.siteConfig.scmIpRestriction.virtualNetworkSubnetIdRef.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.siteConfig.scmIpRestriction.virtualNetworkSubnetIdRef.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.siteConfig.scmIpRestriction.virtualNetworkSubnetIdSelector

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

fn spec.forProvider.siteConfig.scmIpRestriction.virtualNetworkSubnetIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.siteConfig.scmIpRestriction.virtualNetworkSubnetIdSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.siteConfig.scmIpRestriction.virtualNetworkSubnetIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.siteConfig.scmIpRestriction.virtualNetworkSubnetIdSelector.policy

"Policies for selection."

fn spec.forProvider.siteConfig.scmIpRestriction.virtualNetworkSubnetIdSelector.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.siteConfig.scmIpRestriction.virtualNetworkSubnetIdSelector.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.storageAccountAccessKeySecretRef

"The access key which will be used to access the backend storage account for the Function App."

fn spec.forProvider.storageAccountAccessKeySecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.storageAccountAccessKeySecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.storageAccountAccessKeySecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.storageAccountNameRef

"Reference to a Account in storage to populate storageAccountName."

fn spec.forProvider.storageAccountNameRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.storageAccountNameRef.policy

"Policies for referencing."

fn spec.forProvider.storageAccountNameRef.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.storageAccountNameRef.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.storageAccountNameSelector

"Selector for a Account in storage to populate storageAccountName."

fn spec.forProvider.storageAccountNameSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.storageAccountNameSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.storageAccountNameSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.storageAccountNameSelector.policy

"Policies for selection."

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