web.v1beta1.linuxFunctionApp
"LinuxFunctionApp is the Schema for the LinuxFunctionApps API. Manages a Linux Function App."
Index
fn new(name)
obj metadata
fn withAnnotations(annotations)
fn withAnnotationsMixin(annotations)
fn withClusterName(clusterName)
fn withCreationTimestamp(creationTimestamp)
fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
fn withDeletionTimestamp(deletionTimestamp)
fn withFinalizers(finalizers)
fn withFinalizersMixin(finalizers)
fn withGenerateName(generateName)
fn withGeneration(generation)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withName(name)
fn withNamespace(namespace)
fn withOwnerReferences(ownerReferences)
fn withOwnerReferencesMixin(ownerReferences)
fn withResourceVersion(resourceVersion)
fn withSelfLink(selfLink)
fn withUid(uid)
obj spec
fn withDeletionPolicy(deletionPolicy)
obj spec.forProvider
fn withAppSettings(appSettings)
fn withAppSettingsMixin(appSettings)
fn withAuthSettings(authSettings)
fn withAuthSettingsMixin(authSettings)
fn withBackup(backup)
fn withBackupMixin(backup)
fn withBuiltinLoggingEnabled(builtinLoggingEnabled)
fn withClientCertificateEnabled(clientCertificateEnabled)
fn withClientCertificateExclusionPaths(clientCertificateExclusionPaths)
fn withClientCertificateMode(clientCertificateMode)
fn withConnectionString(connectionString)
fn withConnectionStringMixin(connectionString)
fn withContentShareForceDisabled(contentShareForceDisabled)
fn withDailyMemoryTimeQuota(dailyMemoryTimeQuota)
fn withEnabled(enabled)
fn withFunctionsExtensionVersion(functionsExtensionVersion)
fn withHttpsOnly(httpsOnly)
fn withIdentity(identity)
fn withIdentityMixin(identity)
fn withKeyVaultReferenceIdentityId(keyVaultReferenceIdentityId)
fn withLocation(location)
fn withName(name)
fn withResourceGroupName(resourceGroupName)
fn withServicePlanId(servicePlanId)
fn withSiteConfig(siteConfig)
fn withSiteConfigMixin(siteConfig)
fn withStickySettings(stickySettings)
fn withStickySettingsMixin(stickySettings)
fn withStorageAccount(storageAccount)
fn withStorageAccountMixin(storageAccount)
fn withStorageAccountName(storageAccountName)
fn withStorageKeyVaultSecretId(storageKeyVaultSecretId)
fn withStorageUsesManagedIdentity(storageUsesManagedIdentity)
fn withTags(tags)
fn withTagsMixin(tags)
fn withVirtualNetworkSubnetId(virtualNetworkSubnetId)
obj spec.forProvider.authSettings
fn withActiveDirectory(activeDirectory)
fn withActiveDirectoryMixin(activeDirectory)
fn withAdditionalLoginParameters(additionalLoginParameters)
fn withAdditionalLoginParametersMixin(additionalLoginParameters)
fn withAllowedExternalRedirectUrls(allowedExternalRedirectUrls)
fn withAllowedExternalRedirectUrlsMixin(allowedExternalRedirectUrls)
fn withDefaultProvider(defaultProvider)
fn withEnabled(enabled)
fn withFacebook(facebook)
fn withFacebookMixin(facebook)
fn withGithub(github)
fn withGithubMixin(github)
fn withGoogle(google)
fn withGoogleMixin(google)
fn withIssuer(issuer)
fn withMicrosoft(microsoft)
fn withMicrosoftMixin(microsoft)
fn withRuntimeVersion(runtimeVersion)
fn withTokenRefreshExtensionHours(tokenRefreshExtensionHours)
fn withTokenStoreEnabled(tokenStoreEnabled)
fn withTwitter(twitter)
fn withTwitterMixin(twitter)
fn withUnauthenticatedClientAction(unauthenticatedClientAction)
obj spec.forProvider.authSettings.activeDirectory
obj spec.forProvider.authSettings.facebook
obj spec.forProvider.authSettings.github
obj spec.forProvider.authSettings.google
obj spec.forProvider.authSettings.microsoft
obj spec.forProvider.authSettings.twitter
obj spec.forProvider.backup
obj spec.forProvider.connectionString
obj spec.forProvider.identity
obj spec.forProvider.resourceGroupNameRef
obj spec.forProvider.resourceGroupNameSelector
obj spec.forProvider.servicePlanIdRef
obj spec.forProvider.servicePlanIdSelector
obj spec.forProvider.siteConfig
fn withAlwaysOn(alwaysOn)
fn withApiDefinitionUrl(apiDefinitionUrl)
fn withApiManagementApiId(apiManagementApiId)
fn withAppCommandLine(appCommandLine)
fn withAppScaleLimit(appScaleLimit)
fn withAppServiceLogs(appServiceLogs)
fn withAppServiceLogsMixin(appServiceLogs)
fn withApplicationStack(applicationStack)
fn withApplicationStackMixin(applicationStack)
fn withContainerRegistryManagedIdentityClientId(containerRegistryManagedIdentityClientId)
fn withContainerRegistryUseManagedIdentity(containerRegistryUseManagedIdentity)
fn withCors(cors)
fn withCorsMixin(cors)
fn withDefaultDocuments(defaultDocuments)
fn withDefaultDocumentsMixin(defaultDocuments)
fn withElasticInstanceMinimum(elasticInstanceMinimum)
fn withFtpsState(ftpsState)
fn withHealthCheckEvictionTimeInMin(healthCheckEvictionTimeInMin)
fn withHealthCheckPath(healthCheckPath)
fn withHttp2Enabled(http2Enabled)
fn withIpRestriction(ipRestriction)
fn withIpRestrictionMixin(ipRestriction)
fn withLoadBalancingMode(loadBalancingMode)
fn withManagedPipelineMode(managedPipelineMode)
fn withMinimumTlsVersion(minimumTlsVersion)
fn withPreWarmedInstanceCount(preWarmedInstanceCount)
fn withRemoteDebuggingEnabled(remoteDebuggingEnabled)
fn withRemoteDebuggingVersion(remoteDebuggingVersion)
fn withRuntimeScaleMonitoringEnabled(runtimeScaleMonitoringEnabled)
fn withScmIpRestriction(scmIpRestriction)
fn withScmIpRestrictionMixin(scmIpRestriction)
fn withScmMinimumTlsVersion(scmMinimumTlsVersion)
fn withScmUseMainIpRestriction(scmUseMainIpRestriction)
fn withUse32BitWorker(use32BitWorker)
fn withVnetRouteAllEnabled(vnetRouteAllEnabled)
fn withWebsocketsEnabled(websocketsEnabled)
fn withWorkerCount(workerCount)
obj spec.forProvider.siteConfig.appServiceLogs
obj spec.forProvider.siteConfig.applicationInsightsConnectionStringSecretRef
obj spec.forProvider.siteConfig.applicationInsightsKeySecretRef
obj spec.forProvider.siteConfig.applicationStack
fn withDocker(docker)
fn withDockerMixin(docker)
fn withDotnetVersion(dotnetVersion)
fn withJavaVersion(javaVersion)
fn withNodeVersion(nodeVersion)
fn withPowershellCoreVersion(powershellCoreVersion)
fn withPythonVersion(pythonVersion)
fn withUseCustomRuntime(useCustomRuntime)
fn withUseDotnetIsolatedRuntime(useDotnetIsolatedRuntime)
obj spec.forProvider.siteConfig.applicationStack.docker
obj spec.forProvider.siteConfig.cors
obj spec.forProvider.siteConfig.ipRestriction
fn withAction(action)
fn withHeaders(headers)
fn withHeadersMixin(headers)
fn withIpAddress(ipAddress)
fn withName(name)
fn withPriority(priority)
fn withServiceTag(serviceTag)
fn withVirtualNetworkSubnetId(virtualNetworkSubnetId)
obj spec.forProvider.siteConfig.ipRestriction.headers
fn withXAzureFdid(xAzureFdid)
fn withXAzureFdidMixin(xAzureFdid)
fn withXFdHealthProbe(xFdHealthProbe)
fn withXFdHealthProbeMixin(xFdHealthProbe)
fn withXForwardedFor(xForwardedFor)
fn withXForwardedForMixin(xForwardedFor)
fn withXForwardedHost(xForwardedHost)
fn withXForwardedHostMixin(xForwardedHost)
obj spec.forProvider.siteConfig.ipRestriction.virtualNetworkSubnetIdRef
obj spec.forProvider.siteConfig.ipRestriction.virtualNetworkSubnetIdSelector
obj spec.forProvider.siteConfig.scmIpRestriction
fn withAction(action)
fn withHeaders(headers)
fn withHeadersMixin(headers)
fn withIpAddress(ipAddress)
fn withName(name)
fn withPriority(priority)
fn withServiceTag(serviceTag)
fn withVirtualNetworkSubnetId(virtualNetworkSubnetId)
obj spec.forProvider.siteConfig.scmIpRestriction.headers
fn withXAzureFdid(xAzureFdid)
fn withXAzureFdidMixin(xAzureFdid)
fn withXFdHealthProbe(xFdHealthProbe)
fn withXFdHealthProbeMixin(xFdHealthProbe)
fn withXForwardedFor(xForwardedFor)
fn withXForwardedForMixin(xForwardedFor)
fn withXForwardedHost(xForwardedHost)
fn withXForwardedHostMixin(xForwardedHost)
obj spec.forProvider.siteConfig.scmIpRestriction.virtualNetworkSubnetIdRef
obj spec.forProvider.siteConfig.scmIpRestriction.virtualNetworkSubnetIdSelector
obj spec.forProvider.stickySettings
obj spec.forProvider.storageAccount
obj spec.forProvider.storageAccountAccessKeySecretRef
obj spec.forProvider.storageAccountNameRef
obj spec.forProvider.storageAccountNameSelector
obj spec.forProvider.virtualNetworkSubnetIdRef
obj spec.forProvider.virtualNetworkSubnetIdSelector
obj spec.providerConfigRef
obj spec.providerRef
obj spec.publishConnectionDetailsTo
obj spec.writeConnectionSecretToRef
Fields
fn new
new(name)
new returns an instance of LinuxFunctionApp
obj metadata
"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."
fn metadata.withAnnotations
withAnnotations(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
fn metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
Note: This function appends passed data to existing values
fn metadata.withClusterName
withClusterName(clusterName)
"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."
fn metadata.withCreationTimestamp
withCreationTimestamp(creationTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withDeletionGracePeriodSeconds
withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."
fn metadata.withDeletionTimestamp
withDeletionTimestamp(deletionTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withFinalizers
withFinalizers(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
fn metadata.withFinalizersMixin
withFinalizersMixin(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
Note: This function appends passed data to existing values
fn metadata.withGenerateName
withGenerateName(generateName)
"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"
fn metadata.withGeneration
withGeneration(generation)
"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."
fn metadata.withLabels
withLabels(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
fn metadata.withLabelsMixin
withLabelsMixin(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
Note: This function appends passed data to existing values
fn metadata.withName
withName(name)
"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"
fn metadata.withNamespace
withNamespace(namespace)
"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"
fn metadata.withOwnerReferences
withOwnerReferences(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
fn metadata.withOwnerReferencesMixin
withOwnerReferencesMixin(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
Note: This function appends passed data to existing values
fn metadata.withResourceVersion
withResourceVersion(resourceVersion)
"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"
fn metadata.withSelfLink
withSelfLink(selfLink)
"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."
fn metadata.withUid
withUid(uid)
"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"
obj spec
"LinuxFunctionAppSpec defines the desired state of LinuxFunctionApp"
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.withAppSettings
withAppSettings(appSettings)
"A map of key-value pairs for App Settings and custom values. A map of key-value pairs for App Settings and custom values."
fn spec.forProvider.withAppSettingsMixin
withAppSettingsMixin(appSettings)
"A map of key-value pairs for App Settings and custom values. A map of key-value pairs for App Settings and custom values."
Note: This function appends passed data to existing values
fn spec.forProvider.withAuthSettings
withAuthSettings(authSettings)
"A auth_settings block as defined below."
fn spec.forProvider.withAuthSettingsMixin
withAuthSettingsMixin(authSettings)
"A auth_settings block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withBackup
withBackup(backup)
"A backup block as defined below."
fn spec.forProvider.withBackupMixin
withBackupMixin(backup)
"A backup block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withBuiltinLoggingEnabled
withBuiltinLoggingEnabled(builtinLoggingEnabled)
"Should built in logging be enabled. Configures AzureWebJobsDashboard app setting based on the configured storage setting. Defaults to true. Should built in logging be enabled. Configures AzureWebJobsDashboard
app setting based on the configured storage setting"
fn spec.forProvider.withClientCertificateEnabled
withClientCertificateEnabled(clientCertificateEnabled)
"Should the function app use Client Certificates. Should the function app use Client Certificates"
fn spec.forProvider.withClientCertificateExclusionPaths
withClientCertificateExclusionPaths(clientCertificateExclusionPaths)
"Paths to exclude when using client certificates, separated by ; Paths to exclude when using client certificates, separated by ;"
fn spec.forProvider.withClientCertificateMode
withClientCertificateMode(clientCertificateMode)
"The mode of the Function App's client certificates requirement for incoming requests. Possible values are Required, Optional, and OptionalInteractiveUser. The mode of the Function App's client certificates requirement for incoming requests. Possible values are Required
, Optional
, and OptionalInteractiveUser
"
fn spec.forProvider.withConnectionString
withConnectionString(connectionString)
"One or more connection_string blocks as defined below."
fn spec.forProvider.withConnectionStringMixin
withConnectionStringMixin(connectionString)
"One or more connection_string blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withContentShareForceDisabled
withContentShareForceDisabled(contentShareForceDisabled)
"Should the settings for linking the Function App to storage be suppressed. Force disable the content share settings."
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. Defaults to 0. The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps in Consumption Plans."
fn spec.forProvider.withEnabled
withEnabled(enabled)
"Is the Function App enabled? Defaults to true. Is the Linux Function App enabled."
fn spec.forProvider.withFunctionsExtensionVersion
withFunctionsExtensionVersion(functionsExtensionVersion)
"The runtime version associated with the Function App. Defaults to ~4. The runtime version associated with the Function App."
fn spec.forProvider.withHttpsOnly
withHttpsOnly(httpsOnly)
"Can the Function App only be accessed via HTTPS? Defaults to false. Can the Function App only be accessed via HTTPS?"
fn spec.forProvider.withIdentity
withIdentity(identity)
"A identity block as defined below."
fn spec.forProvider.withIdentityMixin
withIdentityMixin(identity)
"A identity block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withKeyVaultReferenceIdentityId
withKeyVaultReferenceIdentityId(keyVaultReferenceIdentityId)
"The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the identity block. For more information see - Access vaults with a user-assigned identity The User Assigned Identity to use for Key Vault access."
fn spec.forProvider.withLocation
withLocation(location)
"The Azure Region where the Linux Function App should exist. Changing this forces a new Linux Function App to be created."
fn spec.forProvider.withName
withName(name)
"The name which should be used for this Linux Function App. Changing this forces a new Linux Function App to be created. Limit the function name to 32 characters to avoid naming collisions. For more information about Function App naming rule and Host ID Collisions Specifies the name of the Function App."
fn spec.forProvider.withResourceGroupName
withResourceGroupName(resourceGroupName)
"The name of the Resource Group where the Linux Function App should exist. Changing this forces a new Linux Function App to be created."
fn spec.forProvider.withServicePlanId
withServicePlanId(servicePlanId)
"The ID of the App Service Plan within which to create this Function App. The ID of the App Service Plan within which to create this Function App"
fn spec.forProvider.withSiteConfig
withSiteConfig(siteConfig)
"A site_config block as defined below."
fn spec.forProvider.withSiteConfigMixin
withSiteConfigMixin(siteConfig)
"A site_config block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withStickySettings
withStickySettings(stickySettings)
"A sticky_settings block as defined below."
fn spec.forProvider.withStickySettingsMixin
withStickySettingsMixin(stickySettings)
"A sticky_settings block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withStorageAccount
withStorageAccount(storageAccount)
"One or more storage_account blocks as defined below."
fn spec.forProvider.withStorageAccountMixin
withStorageAccountMixin(storageAccount)
"One or more storage_account blocks 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 this Function App. The backend storage account name which will be used by this Function App."
fn spec.forProvider.withStorageKeyVaultSecretId
withStorageKeyVaultSecretId(storageKeyVaultSecretId)
"The Key Vault Secret ID, optionally including version, that contains the Connection String to connect to the storage account for this Function App. The Key Vault Secret ID, including version, that contains the Connection String to connect to the storage account for this Function App."
fn spec.forProvider.withStorageUsesManagedIdentity
withStorageUsesManagedIdentity(storageUsesManagedIdentity)
"Should the Function App use Managed Identity to access the storage account. Conflicts with storage_account_access_key. Should the Function App use its Managed Identity to access storage?"
fn spec.forProvider.withTags
withTags(tags)
"A mapping of tags which should be assigned to the Linux Function App."
fn spec.forProvider.withTagsMixin
withTagsMixin(tags)
"A mapping of tags which should be assigned to the Linux Function App."
Note: This function appends passed data to existing values
fn spec.forProvider.withVirtualNetworkSubnetId
withVirtualNetworkSubnetId(virtualNetworkSubnetId)
"The subnet id which will be used by this Function App for regional virtual network integration."
obj spec.forProvider.authSettings
"A auth_settings block as defined below."
fn spec.forProvider.authSettings.withActiveDirectory
withActiveDirectory(activeDirectory)
"An active_directory block as defined above."
fn spec.forProvider.authSettings.withActiveDirectoryMixin
withActiveDirectoryMixin(activeDirectory)
"An active_directory block as defined above."
Note: This function appends passed data to existing values
fn spec.forProvider.authSettings.withAdditionalLoginParameters
withAdditionalLoginParameters(additionalLoginParameters)
"Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in. Specifies a map of Login Parameters to send to the OpenID Connect authorization endpoint when a user logs in."
fn spec.forProvider.authSettings.withAdditionalLoginParametersMixin
withAdditionalLoginParametersMixin(additionalLoginParameters)
"Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in. Specifies a map of Login Parameters to send to the OpenID Connect authorization endpoint when a user logs in."
Note: This function appends passed data to existing values
fn spec.forProvider.authSettings.withAllowedExternalRedirectUrls
withAllowedExternalRedirectUrls(allowedExternalRedirectUrls)
"Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Linux Web App. Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows Web App."
fn spec.forProvider.authSettings.withAllowedExternalRedirectUrlsMixin
withAllowedExternalRedirectUrlsMixin(allowedExternalRedirectUrls)
"Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Linux Web App. Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows Web App."
Note: This function appends passed data to existing values
fn spec.forProvider.authSettings.withDefaultProvider
withDefaultProvider(defaultProvider)
"The default authentication provider to use when multiple providers are configured. Possible values include: AzureActiveDirectory, Facebook, Google, MicrosoftAccount, Twitter, Github The default authentication provider to use when multiple providers are configured. Possible values include: AzureActiveDirectory
, Facebook
, Google
, MicrosoftAccount
, Twitter
, Github
."
fn spec.forProvider.authSettings.withEnabled
withEnabled(enabled)
"Should the Authentication / Authorization feature be enabled for the Linux Web App? Should the Authentication / Authorization feature be 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.withGithub
withGithub(github)
"A github block as defined below."
fn spec.forProvider.authSettings.withGithubMixin
withGithubMixin(github)
"A github 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)
"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this Linux Web App. The OpenID Connect Issuer URI that represents the entity which issues access tokens."
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 RuntimeVersion of the Authentication / Authorization feature in use for the Linux Web App. The RuntimeVersion of the Authentication / Authorization feature in use."
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 hours. The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to 72
hours."
fn spec.forProvider.authSettings.withTokenStoreEnabled
withTokenStoreEnabled(tokenStoreEnabled)
"Should the Linux Web App durably store platform-specific security tokens that are obtained during login flows? Defaults to false. Should the Windows Web App 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 include: RedirectToLoginPage, AllowAnonymous. The action to take when an unauthenticated client attempts to access the app. Possible values include: RedirectToLoginPage
, AllowAnonymous
."
obj spec.forProvider.authSettings.activeDirectory
"An active_directory block as defined above."
fn spec.forProvider.authSettings.activeDirectory.withAllowedAudiences
withAllowedAudiences(allowedAudiences)
"Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory. Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory."
fn spec.forProvider.authSettings.activeDirectory.withAllowedAudiencesMixin
withAllowedAudiencesMixin(allowedAudiences)
"Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory. Specifies a list of 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. The ID of the Client to use to authenticate with Azure Active Directory."
fn spec.forProvider.authSettings.activeDirectory.withClientSecretSettingName
withClientSecretSettingName(clientSecretSettingName)
"The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret. The App Setting name that contains the client secret of the Client. Cannot be used with client_secret
."
obj spec.forProvider.authSettings.activeDirectory.clientSecretSecretRef
"The OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret_setting_name. The Client Secret for the Client ID. Cannot be used with client_secret_setting_name
."
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. The App ID of the Facebook app used for login."
fn spec.forProvider.authSettings.facebook.withAppSecretSettingName
withAppSecretSettingName(appSecretSettingName)
"The app setting name that contains the app_secret value used for Facebook login. Cannot be specified with app_secret. The app setting name that contains the app_secret
value used for Facebook Login. Cannot be specified with app_secret
."
fn spec.forProvider.authSettings.facebook.withOauthScopes
withOauthScopes(oauthScopes)
"Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, wl.basic is used as the default scope. Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook Login authentication."
fn spec.forProvider.authSettings.facebook.withOauthScopesMixin
withOauthScopesMixin(oauthScopes)
"Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, wl.basic is used as the default scope. Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook Login authentication."
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. Cannot be specified with app_secret_setting_name. The App Secret of the Facebook app used for Facebook Login. Cannot be specified with app_secret_setting_name
."
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.github
"A github block as defined below."
fn spec.forProvider.authSettings.github.withClientId
withClientId(clientId)
"The OAuth 2.0 client ID that was created for the app used for authentication. The ID of the GitHub app used for login."
fn spec.forProvider.authSettings.github.withClientSecretSettingName
withClientSecretSettingName(clientSecretSettingName)
"The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret. The app setting name that contains the client_secret
value used for GitHub Login. Cannot be specified with client_secret
."
fn spec.forProvider.authSettings.github.withOauthScopes
withOauthScopes(oauthScopes)
"Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, wl.basic is used as the default scope. Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub Login authentication."
fn spec.forProvider.authSettings.github.withOauthScopesMixin
withOauthScopesMixin(oauthScopes)
"Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, wl.basic is used as the default scope. Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub Login authentication."
Note: This function appends passed data to existing values
obj spec.forProvider.authSettings.github.clientSecretSecretRef
"The OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret_setting_name. The Client Secret of the GitHub app used for GitHub Login. Cannot be specified with client_secret_setting_name
."
fn spec.forProvider.authSettings.github.clientSecretSecretRef.withKey
withKey(key)
"The key to select."
fn spec.forProvider.authSettings.github.clientSecretSecretRef.withName
withName(name)
"Name of the secret."
fn spec.forProvider.authSettings.github.clientSecretSecretRef.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. The OpenID Connect Client ID for the Google web application."
fn spec.forProvider.authSettings.google.withClientSecretSettingName
withClientSecretSettingName(clientSecretSettingName)
"The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret. The app setting name that contains the client_secret
value used for Google Login. Cannot be specified with client_secret
."
fn spec.forProvider.authSettings.google.withOauthScopes
withOauthScopes(oauthScopes)
"Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, wl.basic is used as the default scope. Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes."
fn spec.forProvider.authSettings.google.withOauthScopesMixin
withOauthScopesMixin(oauthScopes)
"Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, wl.basic is used as the default scope. Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes."
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. Cannot be specified with client_secret_setting_name. The client secret associated with the Google web application. Cannot be specified with client_secret_setting_name
."
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. The OAuth 2.0 client ID that was created for the app used for authentication."
fn spec.forProvider.authSettings.microsoft.withClientSecretSettingName
withClientSecretSettingName(clientSecretSettingName)
"The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret. The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret
."
fn spec.forProvider.authSettings.microsoft.withOauthScopes
withOauthScopes(oauthScopes)
"Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, wl.basic is used as the default scope. The list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, wl.basic
is used as the default scope."
fn spec.forProvider.authSettings.microsoft.withOauthScopesMixin
withOauthScopesMixin(oauthScopes)
"Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, wl.basic is used as the default scope. The list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, wl.basic
is used as the default scope."
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. Cannot be specified with client_secret_setting_name. The OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret_setting_name
."
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. The OAuth 1.0a consumer key of the Twitter application used for sign-in."
fn spec.forProvider.authSettings.twitter.withConsumerSecretSettingName
withConsumerSecretSettingName(consumerSecretSettingName)
"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with consumer_secret. The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with consumer_secret
."
obj spec.forProvider.authSettings.twitter.consumerSecretSecretRef
"The OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with consumer_secret_setting_name. The OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with consumer_secret_setting_name
."
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.backup
"A backup block as defined below."
fn spec.forProvider.backup.withEnabled
withEnabled(enabled)
"Should this backup job be enabled? Defaults to true. Should this backup job be enabled?"
fn spec.forProvider.backup.withName
withName(name)
"The name which should be used for this Backup. The name which should be used for this Backup."
fn spec.forProvider.backup.withSchedule
withSchedule(schedule)
"A schedule block as defined below."
fn spec.forProvider.backup.withScheduleMixin
withScheduleMixin(schedule)
"A schedule block as defined below."
Note: This function appends passed data to existing values
obj spec.forProvider.backup.schedule
"A schedule block as defined below."
fn spec.forProvider.backup.schedule.withFrequencyInterval
withFrequencyInterval(frequencyInterval)
"How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and frequency_unit should be set to Day). How often the backup should be executed (e.g. for weekly backup, this should be set to 7
and frequency_unit
should be set to Day
)."
fn spec.forProvider.backup.schedule.withFrequencyUnit
withFrequencyUnit(frequencyUnit)
"The unit of time for how often the backup should take place. Possible values include: Day and Hour. The unit of time for how often the backup should take place. Possible values include: Day
and Hour
."
fn spec.forProvider.backup.schedule.withKeepAtLeastOneBackup
withKeepAtLeastOneBackup(keepAtLeastOneBackup)
"Should the service keep at least one backup, regardless of age of backup. Defaults to false. Should the service keep at least one backup, regardless of age of backup. Defaults to false
."
fn spec.forProvider.backup.schedule.withRetentionPeriodDays
withRetentionPeriodDays(retentionPeriodDays)
"After how many days backups should be deleted. Defaults to 30. After how many days backups should be deleted."
fn spec.forProvider.backup.schedule.withStartTime
withStartTime(startTime)
"When the schedule should start working in RFC-3339 format. When the schedule should start working in RFC-3339 format."
obj spec.forProvider.backup.storageAccountUrlSecretRef
"The SAS URL to the container. The SAS URL to the container."
fn spec.forProvider.backup.storageAccountUrlSecretRef.withKey
withKey(key)
"The key to select."
fn spec.forProvider.backup.storageAccountUrlSecretRef.withName
withName(name)
"Name of the secret."
fn spec.forProvider.backup.storageAccountUrlSecretRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."
obj spec.forProvider.connectionString
"One or more connection_string blocks as defined below."
fn spec.forProvider.connectionString.withName
withName(name)
"The name which should be used for this Connection. The name which should be used for this Connection."
fn spec.forProvider.connectionString.withType
withType(type)
"Type of database. Possible values include: MySQL, SQLServer, SQLAzure, Custom, NotificationHub, ServiceBus, EventHub, APIHub, DocDb, RedisCache, and PostgreSQL. Type of database. Possible values include: MySQL
, SQLServer
, SQLAzure
, Custom
, NotificationHub
, ServiceBus
, EventHub
, APIHub
, DocDb
, RedisCache
, and PostgreSQL
."
obj spec.forProvider.connectionString.valueSecretRef
"The connection string value. The connection string value."
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.identity
"A identity block as defined below."
fn spec.forProvider.identity.withIdentityIds
withIdentityIds(identityIds)
"A list of User Assigned Managed Identity IDs to be assigned to this Linux Function App."
fn spec.forProvider.identity.withIdentityIdsMixin
withIdentityIdsMixin(identityIds)
"A list of User Assigned Managed Identity IDs to be assigned to this Linux Function App."
Note: This function appends passed data to existing values
fn spec.forProvider.identity.withType
withType(type)
"Specifies the type of Managed Service Identity that should be configured on this Linux Function App. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both)."
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.servicePlanIdRef
"Reference to a ServicePlan in web to populate servicePlanId."
fn spec.forProvider.servicePlanIdRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.servicePlanIdRef.policy
"Policies for referencing."
fn spec.forProvider.servicePlanIdRef.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.servicePlanIdRef.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.servicePlanIdSelector
"Selector for a ServicePlan in web to populate servicePlanId."
fn spec.forProvider.servicePlanIdSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.servicePlanIdSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.servicePlanIdSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.servicePlanIdSelector.policy
"Policies for selection."
fn spec.forProvider.servicePlanIdSelector.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.servicePlanIdSelector.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 block as defined below."
fn spec.forProvider.siteConfig.withAlwaysOn
withAlwaysOn(alwaysOn)
"If this Linux Web App is Always On enabled. Defaults to false. If this Linux Web App is Always On enabled. Defaults to false
."
fn spec.forProvider.siteConfig.withApiDefinitionUrl
withApiDefinitionUrl(apiDefinitionUrl)
"The URL of the API definition that describes this Linux Function App. The URL of the API definition that describes this Linux Function App."
fn spec.forProvider.siteConfig.withApiManagementApiId
withApiManagementApiId(apiManagementApiId)
"The ID of the API Management API for this Linux Function App. The ID of the API Management API for this Linux Function App."
fn spec.forProvider.siteConfig.withAppCommandLine
withAppCommandLine(appCommandLine)
"The App command line to launch. The program and any arguments used to launch this app via the command line. (Example node myapp.js
)."
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. 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.withAppServiceLogs
withAppServiceLogs(appServiceLogs)
"An app_service_logs block as defined above."
fn spec.forProvider.siteConfig.withAppServiceLogsMixin
withAppServiceLogsMixin(appServiceLogs)
"An app_service_logs block as defined above."
Note: This function appends passed data to existing values
fn spec.forProvider.siteConfig.withApplicationStack
withApplicationStack(applicationStack)
"An application_stack block as defined above."
fn spec.forProvider.siteConfig.withApplicationStackMixin
withApplicationStackMixin(applicationStack)
"An application_stack block as defined above."
Note: This function appends passed data to existing values
fn spec.forProvider.siteConfig.withContainerRegistryManagedIdentityClientId
withContainerRegistryManagedIdentityClientId(containerRegistryManagedIdentityClientId)
"The Client ID of the Managed Service Identity to use for connections to the Azure Container Registry. The Client ID of the Managed Service Identity to use for connections to the Azure Container Registry."
fn spec.forProvider.siteConfig.withContainerRegistryUseManagedIdentity
withContainerRegistryUseManagedIdentity(containerRegistryUseManagedIdentity)
"Should connections for Azure Container Registry use Managed Identity. Should connections for Azure Container Registry use Managed Identity."
fn spec.forProvider.siteConfig.withCors
withCors(cors)
"A cors block as defined above."
fn spec.forProvider.siteConfig.withCorsMixin
withCorsMixin(cors)
"A cors block as defined above."
Note: This function appends passed data to existing values
fn spec.forProvider.siteConfig.withDefaultDocuments
withDefaultDocuments(defaultDocuments)
"Specifies a list of Default Documents for the Linux Web App. Specifies a list of Default Documents for the Linux Web App."
fn spec.forProvider.siteConfig.withDefaultDocumentsMixin
withDefaultDocumentsMixin(defaultDocuments)
"Specifies a list of Default Documents for the Linux Web App. Specifies a list of Default Documents for the Linux Web App."
Note: This function appends passed data to existing values
fn spec.forProvider.siteConfig.withElasticInstanceMinimum
withElasticInstanceMinimum(elasticInstanceMinimum)
"The number of minimum instances for this Linux Function App. Only affects apps on Elastic Premium plans. The number of minimum instances for this Linux Function App. Only affects apps on Elastic Premium plans."
fn spec.forProvider.siteConfig.withFtpsState
withFtpsState(ftpsState)
"State of FTP / FTPS service for this function app. Possible values include: AllAllowed, FtpsOnly and Disabled. Defaults to Disabled. State of FTP / FTPS service for this function app. Possible values include: AllAllowed
, FtpsOnly
and Disabled
. Defaults to Disabled
."
fn spec.forProvider.siteConfig.withHealthCheckEvictionTimeInMin
withHealthCheckEvictionTimeInMin(healthCheckEvictionTimeInMin)
"The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between 2 and 10. Only valid in conjunction with health_check_path. The amount of time in minutes that a node is unhealthy before being removed from the load balancer. Possible values are between 2
and 10
. Defaults to 10
. Only valid in conjunction with health_check_path
"
fn spec.forProvider.siteConfig.withHealthCheckPath
withHealthCheckPath(healthCheckPath)
"The path to be checked for this function app health. The path to be checked for this function app health."
fn spec.forProvider.siteConfig.withHttp2Enabled
withHttp2Enabled(http2Enabled)
"Specifies if the HTTP2 protocol should be enabled. Defaults to false. Specifies if the http2 protocol should be enabled. Defaults to false
."
fn spec.forProvider.siteConfig.withIpRestriction
withIpRestriction(ipRestriction)
"One or more ip_restriction blocks as defined above."
fn spec.forProvider.siteConfig.withIpRestrictionMixin
withIpRestrictionMixin(ipRestriction)
"One or more ip_restriction blocks as defined above."
Note: This function appends passed data to existing values
fn spec.forProvider.siteConfig.withLoadBalancingMode
withLoadBalancingMode(loadBalancingMode)
"The Site load balancing mode. Possible values include: WeightedRoundRobin, LeastRequests, LeastResponseTime, WeightedTotalTraffic, RequestHash, PerSiteRoundRobin. Defaults to LeastRequests if omitted. The Site load balancing mode. Possible values include: WeightedRoundRobin
, LeastRequests
, LeastResponseTime
, WeightedTotalTraffic
, RequestHash
, PerSiteRoundRobin
. Defaults to LeastRequests
if omitted."
fn spec.forProvider.siteConfig.withManagedPipelineMode
withManagedPipelineMode(managedPipelineMode)
"Managed pipeline mode. Possible values include: Integrated, Classic. Defaults to Integrated. The Managed Pipeline mode. Possible values include: Integrated
, Classic
. Defaults to Integrated
."
fn spec.forProvider.siteConfig.withMinimumTlsVersion
withMinimumTlsVersion(minimumTlsVersion)
"The configures the minimum version of TLS required for SSL requests. Possible values include: 1.0, 1.1, and 1.2. Defaults to 1.2. The configures the minimum version of TLS required for SSL requests. Possible values include: 1.0
, 1.1
, and 1.2
. Defaults to 1.2
."
fn spec.forProvider.siteConfig.withPreWarmedInstanceCount
withPreWarmedInstanceCount(preWarmedInstanceCount)
"The number of pre-warmed instances for this function app. Only affects apps on an Elastic Premium plan. The number of pre-warmed instances for this function app. Only affects apps on an Elastic Premium plan."
fn spec.forProvider.siteConfig.withRemoteDebuggingEnabled
withRemoteDebuggingEnabled(remoteDebuggingEnabled)
"Should Remote Debugging be enabled. Defaults to false. Should Remote Debugging be enabled. Defaults to false
."
fn spec.forProvider.siteConfig.withRemoteDebuggingVersion
withRemoteDebuggingVersion(remoteDebuggingVersion)
"The Remote Debugging Version. Possible values include VS2017, VS2019, and VS2022. The Remote Debugging Version. Possible values include VS2017
, VS2019
, and `VS2022“"
fn spec.forProvider.siteConfig.withRuntimeScaleMonitoringEnabled
withRuntimeScaleMonitoringEnabled(runtimeScaleMonitoringEnabled)
"Should Scale Monitoring of the Functions Runtime be enabled? Should Functions Runtime Scale Monitoring be enabled."
fn spec.forProvider.siteConfig.withScmIpRestriction
withScmIpRestriction(scmIpRestriction)
"One or more scm_ip_restriction blocks as defined above."
fn spec.forProvider.siteConfig.withScmIpRestrictionMixin
withScmIpRestrictionMixin(scmIpRestriction)
"One or more scm_ip_restriction blocks as defined above."
Note: This function appends passed data to existing values
fn spec.forProvider.siteConfig.withScmMinimumTlsVersion
withScmMinimumTlsVersion(scmMinimumTlsVersion)
"Configures the minimum version of TLS required for SSL requests to the SCM site Possible values include: 1.0, 1.1, and 1.2. Defaults to 1.2. Configures the minimum version of TLS required for SSL requests to the SCM site Possible values include: 1.0
, 1.1
, and 1.2
. Defaults to 1.2
."
fn spec.forProvider.siteConfig.withScmUseMainIpRestriction
withScmUseMainIpRestriction(scmUseMainIpRestriction)
"Should the Linux Function App ip_restriction configuration be used for the SCM also. Should the Linux Function App ip_restriction
configuration be used for the SCM also."
fn spec.forProvider.siteConfig.withUse32BitWorker
withUse32BitWorker(use32BitWorker)
"Should the Linux Web App use a 32-bit worker process. Defaults to true. Should the Linux Web App use a 32-bit worker."
fn spec.forProvider.siteConfig.withVnetRouteAllEnabled
withVnetRouteAllEnabled(vnetRouteAllEnabled)
"Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to false. Should all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied? Defaults to false
."
fn spec.forProvider.siteConfig.withWebsocketsEnabled
withWebsocketsEnabled(websocketsEnabled)
"Should Web Sockets be enabled. Defaults to false. Should Web Sockets be enabled. Defaults to false
."
fn spec.forProvider.siteConfig.withWorkerCount
withWorkerCount(workerCount)
"The number of Workers for this Linux Function App. The number of Workers for this Linux Function App."
obj spec.forProvider.siteConfig.appServiceLogs
"An app_service_logs block as defined above."
fn spec.forProvider.siteConfig.appServiceLogs.withDiskQuotaMb
withDiskQuotaMb(diskQuotaMb)
"The amount of disk space to use for logs. Valid values are between 25 and 100. Defaults to 35. The amount of disk space to use for logs. Valid values are between 25
and 100
."
fn spec.forProvider.siteConfig.appServiceLogs.withRetentionPeriodDays
withRetentionPeriodDays(retentionPeriodDays)
"After how many days backups should be deleted. Defaults to 30. The retention period for logs in days. Valid values are between 0
and 99999
. Defaults to 0
(never delete)."
obj spec.forProvider.siteConfig.applicationInsightsConnectionStringSecretRef
"The Connection String for linking the Linux Function App to Application Insights. The Connection String for linking the Linux Function App to Application Insights."
fn spec.forProvider.siteConfig.applicationInsightsConnectionStringSecretRef.withKey
withKey(key)
"The key to select."
fn spec.forProvider.siteConfig.applicationInsightsConnectionStringSecretRef.withName
withName(name)
"Name of the secret."
fn spec.forProvider.siteConfig.applicationInsightsConnectionStringSecretRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."
obj spec.forProvider.siteConfig.applicationInsightsKeySecretRef
"The Instrumentation Key for connecting the Linux Function App to Application Insights. The Instrumentation Key for connecting the Linux Function App to Application Insights."
fn spec.forProvider.siteConfig.applicationInsightsKeySecretRef.withKey
withKey(key)
"The key to select."
fn spec.forProvider.siteConfig.applicationInsightsKeySecretRef.withName
withName(name)
"Name of the secret."
fn spec.forProvider.siteConfig.applicationInsightsKeySecretRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."
obj spec.forProvider.siteConfig.applicationStack
"An application_stack block as defined above."
fn spec.forProvider.siteConfig.applicationStack.withDocker
withDocker(docker)
"One or more docker blocks as defined below. A docker block"
fn spec.forProvider.siteConfig.applicationStack.withDockerMixin
withDockerMixin(docker)
"One or more docker blocks as defined below. A docker block"
Note: This function appends passed data to existing values
fn spec.forProvider.siteConfig.applicationStack.withDotnetVersion
withDotnetVersion(dotnetVersion)
"The version of .NET to use. Possible values include 3.1, 6.0 and 7.0. The version of .Net. Possible values are 3.1
, 6.0
and 7.0
"
fn spec.forProvider.siteConfig.applicationStack.withJavaVersion
withJavaVersion(javaVersion)
"The Version of Java to use. Supported versions include 8, 11 & 17 (In-Preview). The version of Java to use. Possible values are 8
, 11
, and 17
"
fn spec.forProvider.siteConfig.applicationStack.withNodeVersion
withNodeVersion(nodeVersion)
"The version of Node to run. Possible values include 12, 14, 16 and 18. The version of Node to use. Possible values include 12
, and 14
"
fn spec.forProvider.siteConfig.applicationStack.withPowershellCoreVersion
withPowershellCoreVersion(powershellCoreVersion)
"The version of PowerShell Core to run. Possible values are 7, and 7.2. The version of PowerShell Core to use. Possibles values are 7
, and 7.2
"
fn spec.forProvider.siteConfig.applicationStack.withPythonVersion
withPythonVersion(pythonVersion)
"The version of Python to run. Possible values are 3.10, 3.9, 3.8 and 3.7. The version of Python to use. Possible values include 3.9
, 3.8
, and 3.7
."
fn spec.forProvider.siteConfig.applicationStack.withUseCustomRuntime
withUseCustomRuntime(useCustomRuntime)
"Should the Linux Function App use a custom runtime?"
fn spec.forProvider.siteConfig.applicationStack.withUseDotnetIsolatedRuntime
withUseDotnetIsolatedRuntime(useDotnetIsolatedRuntime)
"Should the DotNet process use an isolated runtime. Defaults to false. Should the DotNet process use an isolated runtime. Defaults to false
."
obj spec.forProvider.siteConfig.applicationStack.docker
"One or more docker blocks as defined below. A docker block"
fn spec.forProvider.siteConfig.applicationStack.docker.withImageName
withImageName(imageName)
"The name of the Docker image to use. The name of the Docker image to use."
fn spec.forProvider.siteConfig.applicationStack.docker.withImageTag
withImageTag(imageTag)
"The image tag of the image to use. The image tag of the image to use."
fn spec.forProvider.siteConfig.applicationStack.docker.withRegistryUrl
withRegistryUrl(registryUrl)
"The URL of the docker registry. The URL of the docker registry."
obj spec.forProvider.siteConfig.applicationStack.docker.registryPasswordSecretRef
"The password for the account to use to connect to the registry. The password for the account to use to connect to the registry."
fn spec.forProvider.siteConfig.applicationStack.docker.registryPasswordSecretRef.withKey
withKey(key)
"The key to select."
fn spec.forProvider.siteConfig.applicationStack.docker.registryPasswordSecretRef.withName
withName(name)
"Name of the secret."
fn spec.forProvider.siteConfig.applicationStack.docker.registryPasswordSecretRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."
obj spec.forProvider.siteConfig.applicationStack.docker.registryUsernameSecretRef
"The username to use for connections to the registry. The username to use for connections to the registry."
fn spec.forProvider.siteConfig.applicationStack.docker.registryUsernameSecretRef.withKey
withKey(key)
"The key to select."
fn spec.forProvider.siteConfig.applicationStack.docker.registryUsernameSecretRef.withName
withName(name)
"Name of the secret."
fn spec.forProvider.siteConfig.applicationStack.docker.registryUsernameSecretRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."
obj spec.forProvider.siteConfig.cors
"A cors block as defined above."
fn spec.forProvider.siteConfig.cors.withAllowedOrigins
withAllowedOrigins(allowedOrigins)
"Specifies a list of origins that should be allowed to make cross-origin calls. Specifies a list of origins that should be allowed to make cross-origin calls."
fn spec.forProvider.siteConfig.cors.withAllowedOriginsMixin
withAllowedOriginsMixin(allowedOrigins)
"Specifies a list of origins that should be allowed to make cross-origin calls. Specifies a list of origins that should be allowed to make cross-origin calls."
Note: This function appends passed data to existing values
fn spec.forProvider.siteConfig.cors.withSupportCredentials
withSupportCredentials(supportCredentials)
"Are credentials allowed in CORS requests? Defaults to false. Are credentials allowed in CORS requests? Defaults to false
."
obj spec.forProvider.siteConfig.ipRestriction
"One or more ip_restriction blocks as defined above."
fn spec.forProvider.siteConfig.ipRestriction.withAction
withAction(action)
"The action to take. Possible values are Allow or Deny."
fn spec.forProvider.siteConfig.ipRestriction.withHeaders
withHeaders(headers)
"A headers block as defined above."
fn spec.forProvider.siteConfig.ipRestriction.withHeadersMixin
withHeadersMixin(headers)
"A headers block as defined above."
Note: This function appends passed data to existing values
fn spec.forProvider.siteConfig.ipRestriction.withIpAddress
withIpAddress(ipAddress)
"The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32"
fn spec.forProvider.siteConfig.ipRestriction.withName
withName(name)
"The name which should be used for this Storage Account."
fn spec.forProvider.siteConfig.ipRestriction.withPriority
withPriority(priority)
"The priority value of this ip_restriction. Defaults to 65000."
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 subnet id which will be used by this Function App for regional virtual network integration."
obj spec.forProvider.siteConfig.ipRestriction.headers
"A headers block as defined above."
fn spec.forProvider.siteConfig.ipRestriction.headers.withXAzureFdid
withXAzureFdid(xAzureFdid)
"Specifies a list of Azure Front Door IDs."
fn spec.forProvider.siteConfig.ipRestriction.headers.withXAzureFdidMixin
withXAzureFdidMixin(xAzureFdid)
"Specifies a list of Azure Front Door IDs."
Note: This function appends passed data to existing values
fn spec.forProvider.siteConfig.ipRestriction.headers.withXFdHealthProbe
withXFdHealthProbe(xFdHealthProbe)
"Specifies if a Front Door Health Probe should be expected. The only possible value is 1."
fn spec.forProvider.siteConfig.ipRestriction.headers.withXFdHealthProbeMixin
withXFdHealthProbeMixin(xFdHealthProbe)
"Specifies if a Front Door Health Probe should be expected. The only possible value is 1."
Note: This function appends passed data to existing values
fn spec.forProvider.siteConfig.ipRestriction.headers.withXForwardedFor
withXForwardedFor(xForwardedFor)
"Specifies a list of addresses for which matching should be applied. Omitting this value means allow any."
fn spec.forProvider.siteConfig.ipRestriction.headers.withXForwardedForMixin
withXForwardedForMixin(xForwardedFor)
"Specifies a list of addresses for which matching should be applied. Omitting this value means allow any."
Note: This function appends passed data to existing values
fn spec.forProvider.siteConfig.ipRestriction.headers.withXForwardedHost
withXForwardedHost(xForwardedHost)
"Specifies a list of Hosts for which matching should be applied."
fn spec.forProvider.siteConfig.ipRestriction.headers.withXForwardedHostMixin
withXForwardedHostMixin(xForwardedHost)
"Specifies a list of Hosts for which matching should be applied."
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
"One or more scm_ip_restriction blocks as defined above."
fn spec.forProvider.siteConfig.scmIpRestriction.withAction
withAction(action)
"The action to take. Possible values are Allow or Deny."
fn spec.forProvider.siteConfig.scmIpRestriction.withHeaders
withHeaders(headers)
"A headers block as defined above."
fn spec.forProvider.siteConfig.scmIpRestriction.withHeadersMixin
withHeadersMixin(headers)
"A headers block as defined above."
Note: This function appends passed data to existing values
fn spec.forProvider.siteConfig.scmIpRestriction.withIpAddress
withIpAddress(ipAddress)
"The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32"
fn spec.forProvider.siteConfig.scmIpRestriction.withName
withName(name)
"The name which should be used for this Storage Account."
fn spec.forProvider.siteConfig.scmIpRestriction.withPriority
withPriority(priority)
"The priority value of this ip_restriction. Defaults to 65000."
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 subnet id which will be used by this Function App for regional virtual network integration."
obj spec.forProvider.siteConfig.scmIpRestriction.headers
"A headers block as defined above."
fn spec.forProvider.siteConfig.scmIpRestriction.headers.withXAzureFdid
withXAzureFdid(xAzureFdid)
"Specifies a list of Azure Front Door IDs."
fn spec.forProvider.siteConfig.scmIpRestriction.headers.withXAzureFdidMixin
withXAzureFdidMixin(xAzureFdid)
"Specifies a list of Azure Front Door IDs."
Note: This function appends passed data to existing values
fn spec.forProvider.siteConfig.scmIpRestriction.headers.withXFdHealthProbe
withXFdHealthProbe(xFdHealthProbe)
"Specifies if a Front Door Health Probe should be expected. The only possible value is 1."
fn spec.forProvider.siteConfig.scmIpRestriction.headers.withXFdHealthProbeMixin
withXFdHealthProbeMixin(xFdHealthProbe)
"Specifies if a Front Door Health Probe should be expected. The only possible value is 1."
Note: This function appends passed data to existing values
fn spec.forProvider.siteConfig.scmIpRestriction.headers.withXForwardedFor
withXForwardedFor(xForwardedFor)
"Specifies a list of addresses for which matching should be applied. Omitting this value means allow any."
fn spec.forProvider.siteConfig.scmIpRestriction.headers.withXForwardedForMixin
withXForwardedForMixin(xForwardedFor)
"Specifies a list of addresses for which matching should be applied. Omitting this value means allow any."
Note: This function appends passed data to existing values
fn spec.forProvider.siteConfig.scmIpRestriction.headers.withXForwardedHost
withXForwardedHost(xForwardedHost)
"Specifies a list of Hosts for which matching should be applied."
fn spec.forProvider.siteConfig.scmIpRestriction.headers.withXForwardedHostMixin
withXForwardedHostMixin(xForwardedHost)
"Specifies a list of Hosts for which matching should be applied."
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.stickySettings
"A sticky_settings block as defined below."
fn spec.forProvider.stickySettings.withAppSettingNames
withAppSettingNames(appSettingNames)
"A list of app_setting names that the Linux Function App will not swap between Slots when a swap operation is triggered."
fn spec.forProvider.stickySettings.withAppSettingNamesMixin
withAppSettingNamesMixin(appSettingNames)
"A list of app_setting names that the Linux Function App will not swap between Slots when a swap operation is triggered."
Note: This function appends passed data to existing values
fn spec.forProvider.stickySettings.withConnectionStringNames
withConnectionStringNames(connectionStringNames)
"A list of connection_string names that the Linux Function App will not swap between Slots when a swap operation is triggered."
fn spec.forProvider.stickySettings.withConnectionStringNamesMixin
withConnectionStringNamesMixin(connectionStringNames)
"A list of connection_string names that the Linux Function App will not swap between Slots when a swap operation is triggered."
Note: This function appends passed data to existing values
obj spec.forProvider.storageAccount
"One or more storage_account blocks as defined below."
fn spec.forProvider.storageAccount.withAccountName
withAccountName(accountName)
"The Name of the Storage Account."
fn spec.forProvider.storageAccount.withMountPath
withMountPath(mountPath)
"The path at which to mount the storage share."
fn spec.forProvider.storageAccount.withName
withName(name)
"The name which should be used for this Storage Account."
fn spec.forProvider.storageAccount.withShareName
withShareName(shareName)
"The Name of the File Share or Container Name for Blob storage."
fn spec.forProvider.storageAccount.withType
withType(type)
"The Azure Storage Type. Possible values include AzureFiles and AzureBlob."
obj spec.forProvider.storageAccount.accessKeySecretRef
"The Access key for the storage account."
fn spec.forProvider.storageAccount.accessKeySecretRef.withKey
withKey(key)
"The key to select."
fn spec.forProvider.storageAccount.accessKeySecretRef.withName
withName(name)
"Name of the secret."
fn spec.forProvider.storageAccount.accessKeySecretRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."
obj spec.forProvider.storageAccountAccessKeySecretRef
"The access key which will be used to access the backend storage account for the Function App. Conflicts with storage_uses_managed_identity. The access key which will be used to access the 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.forProvider.virtualNetworkSubnetIdRef
"Reference to a Subnet in network to populate virtualNetworkSubnetId."
fn spec.forProvider.virtualNetworkSubnetIdRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.virtualNetworkSubnetIdRef.policy
"Policies for referencing."
fn spec.forProvider.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.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.virtualNetworkSubnetIdSelector
"Selector for a Subnet in network to populate virtualNetworkSubnetId."
fn spec.forProvider.virtualNetworkSubnetIdSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.virtualNetworkSubnetIdSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.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.virtualNetworkSubnetIdSelector.policy
"Policies for selection."
fn spec.forProvider.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.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.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."