network.v1beta1.applicationGateway
"ApplicationGateway is the Schema for the ApplicationGateways API. Manages an Application Gateway."
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 withAuthenticationCertificate(authenticationCertificate)
fn withAuthenticationCertificateMixin(authenticationCertificate)
fn withAutoscaleConfiguration(autoscaleConfiguration)
fn withAutoscaleConfigurationMixin(autoscaleConfiguration)
fn withBackendAddressPool(backendAddressPool)
fn withBackendAddressPoolMixin(backendAddressPool)
fn withBackendHttpSettings(backendHttpSettings)
fn withBackendHttpSettingsMixin(backendHttpSettings)
fn withCustomErrorConfiguration(customErrorConfiguration)
fn withCustomErrorConfigurationMixin(customErrorConfiguration)
fn withEnableHttp2(enableHttp2)
fn withFipsEnabled(fipsEnabled)
fn withFirewallPolicyId(firewallPolicyId)
fn withForceFirewallPolicyAssociation(forceFirewallPolicyAssociation)
fn withFrontendIpConfiguration(frontendIpConfiguration)
fn withFrontendIpConfigurationMixin(frontendIpConfiguration)
fn withFrontendPort(frontendPort)
fn withFrontendPortMixin(frontendPort)
fn withGatewayIpConfiguration(gatewayIpConfiguration)
fn withGatewayIpConfigurationMixin(gatewayIpConfiguration)
fn withGlobal(global)
fn withGlobalMixin(global)
fn withHttpListener(httpListener)
fn withHttpListenerMixin(httpListener)
fn withIdentity(identity)
fn withIdentityMixin(identity)
fn withLocation(location)
fn withPrivateLinkConfiguration(privateLinkConfiguration)
fn withPrivateLinkConfigurationMixin(privateLinkConfiguration)
fn withProbe(probe)
fn withProbeMixin(probe)
fn withRedirectConfiguration(redirectConfiguration)
fn withRedirectConfigurationMixin(redirectConfiguration)
fn withRequestRoutingRule(requestRoutingRule)
fn withRequestRoutingRuleMixin(requestRoutingRule)
fn withResourceGroupName(resourceGroupName)
fn withRewriteRuleSet(rewriteRuleSet)
fn withRewriteRuleSetMixin(rewriteRuleSet)
fn withSku(sku)
fn withSkuMixin(sku)
fn withSslCertificate(sslCertificate)
fn withSslCertificateMixin(sslCertificate)
fn withSslPolicy(sslPolicy)
fn withSslPolicyMixin(sslPolicy)
fn withSslProfile(sslProfile)
fn withSslProfileMixin(sslProfile)
fn withTags(tags)
fn withTagsMixin(tags)
fn withTrustedClientCertificate(trustedClientCertificate)
fn withTrustedClientCertificateMixin(trustedClientCertificate)
fn withTrustedRootCertificate(trustedRootCertificate)
fn withTrustedRootCertificateMixin(trustedRootCertificate)
fn withUrlPathMap(urlPathMap)
fn withUrlPathMapMixin(urlPathMap)
fn withWafConfiguration(wafConfiguration)
fn withWafConfigurationMixin(wafConfiguration)
fn withZones(zones)
fn withZonesMixin(zones)
obj spec.forProvider.authenticationCertificate
obj spec.forProvider.autoscaleConfiguration
obj spec.forProvider.backendAddressPool
obj spec.forProvider.backendHttpSettings
fn withAffinityCookieName(affinityCookieName)
fn withAuthenticationCertificate(authenticationCertificate)
fn withAuthenticationCertificateMixin(authenticationCertificate)
fn withConnectionDraining(connectionDraining)
fn withConnectionDrainingMixin(connectionDraining)
fn withCookieBasedAffinity(cookieBasedAffinity)
fn withHostName(hostName)
fn withName(name)
fn withPath(path)
fn withPickHostNameFromBackendAddress(pickHostNameFromBackendAddress)
fn withPort(port)
fn withProbeName(probeName)
fn withProtocol(protocol)
fn withRequestTimeout(requestTimeout)
fn withTrustedRootCertificateNames(trustedRootCertificateNames)
fn withTrustedRootCertificateNamesMixin(trustedRootCertificateNames)
obj spec.forProvider.backendHttpSettings.authenticationCertificate
obj spec.forProvider.backendHttpSettings.connectionDraining
obj spec.forProvider.customErrorConfiguration
obj spec.forProvider.frontendIpConfiguration
fn withName(name)
fn withPrivateIpAddress(privateIpAddress)
fn withPrivateIpAddressAllocation(privateIpAddressAllocation)
fn withPrivateLinkConfigurationName(privateLinkConfigurationName)
fn withPublicIpAddressId(publicIpAddressId)
fn withSubnetId(subnetId)
obj spec.forProvider.frontendIpConfiguration.publicIpAddressIdRef
obj spec.forProvider.frontendIpConfiguration.publicIpAddressIdSelector
obj spec.forProvider.frontendIpConfiguration.subnetIdRef
obj spec.forProvider.frontendIpConfiguration.subnetIdSelector
obj spec.forProvider.frontendPort
obj spec.forProvider.gatewayIpConfiguration
obj spec.forProvider.global
obj spec.forProvider.httpListener
fn withCustomErrorConfiguration(customErrorConfiguration)
fn withCustomErrorConfigurationMixin(customErrorConfiguration)
fn withFirewallPolicyId(firewallPolicyId)
fn withFrontendIpConfigurationName(frontendIpConfigurationName)
fn withFrontendPortName(frontendPortName)
fn withHostName(hostName)
fn withHostNames(hostNames)
fn withHostNamesMixin(hostNames)
fn withName(name)
fn withProtocol(protocol)
fn withRequireSni(requireSni)
fn withSslCertificateName(sslCertificateName)
fn withSslProfileName(sslProfileName)
obj spec.forProvider.httpListener.customErrorConfiguration
obj spec.forProvider.identity
obj spec.forProvider.privateLinkConfiguration
fn withIpConfiguration(ipConfiguration)
fn withIpConfigurationMixin(ipConfiguration)
fn withName(name)
obj spec.forProvider.privateLinkConfiguration.ipConfiguration
fn withName(name)
fn withPrimary(primary)
fn withPrivateIpAddress(privateIpAddress)
fn withPrivateIpAddressAllocation(privateIpAddressAllocation)
fn withSubnetId(subnetId)
obj spec.forProvider.privateLinkConfiguration.ipConfiguration.subnetIdRef
obj spec.forProvider.privateLinkConfiguration.ipConfiguration.subnetIdSelector
obj spec.forProvider.probe
fn withHost(host)
fn withInterval(interval)
fn withMatch(match)
fn withMatchMixin(match)
fn withMinimumServers(minimumServers)
fn withName(name)
fn withPath(path)
fn withPickHostNameFromBackendHttpSettings(pickHostNameFromBackendHttpSettings)
fn withPort(port)
fn withProtocol(protocol)
fn withTimeout(timeout)
fn withUnhealthyThreshold(unhealthyThreshold)
obj spec.forProvider.probe.match
obj spec.forProvider.redirectConfiguration
obj spec.forProvider.requestRoutingRule
fn withBackendAddressPoolName(backendAddressPoolName)
fn withBackendHttpSettingsName(backendHttpSettingsName)
fn withHttpListenerName(httpListenerName)
fn withName(name)
fn withPriority(priority)
fn withRedirectConfigurationName(redirectConfigurationName)
fn withRewriteRuleSetName(rewriteRuleSetName)
fn withRuleType(ruleType)
fn withUrlPathMapName(urlPathMapName)
obj spec.forProvider.resourceGroupNameRef
obj spec.forProvider.resourceGroupNameSelector
obj spec.forProvider.rewriteRuleSet
fn withName(name)
fn withRewriteRule(rewriteRule)
fn withRewriteRuleMixin(rewriteRule)
obj spec.forProvider.rewriteRuleSet.rewriteRule
fn withCondition(condition)
fn withConditionMixin(condition)
fn withName(name)
fn withRequestHeaderConfiguration(requestHeaderConfiguration)
fn withRequestHeaderConfigurationMixin(requestHeaderConfiguration)
fn withResponseHeaderConfiguration(responseHeaderConfiguration)
fn withResponseHeaderConfigurationMixin(responseHeaderConfiguration)
fn withRuleSequence(ruleSequence)
fn withUrl(url)
fn withUrlMixin(url)
obj spec.forProvider.rewriteRuleSet.rewriteRule.condition
obj spec.forProvider.rewriteRuleSet.rewriteRule.requestHeaderConfiguration
obj spec.forProvider.rewriteRuleSet.rewriteRule.responseHeaderConfiguration
obj spec.forProvider.rewriteRuleSet.rewriteRule.url
obj spec.forProvider.sku
obj spec.forProvider.sslCertificate
obj spec.forProvider.sslPolicy
obj spec.forProvider.sslProfile
fn withName(name)
fn withSslPolicy(sslPolicy)
fn withSslPolicyMixin(sslPolicy)
fn withTrustedClientCertificateNames(trustedClientCertificateNames)
fn withTrustedClientCertificateNamesMixin(trustedClientCertificateNames)
fn withVerifyClientCertIssuerDn(verifyClientCertIssuerDn)
obj spec.forProvider.sslProfile.sslPolicy
obj spec.forProvider.trustedClientCertificate
obj spec.forProvider.trustedRootCertificate
obj spec.forProvider.urlPathMap
fn withDefaultBackendAddressPoolName(defaultBackendAddressPoolName)
fn withDefaultBackendHttpSettingsName(defaultBackendHttpSettingsName)
fn withDefaultRedirectConfigurationName(defaultRedirectConfigurationName)
fn withDefaultRewriteRuleSetName(defaultRewriteRuleSetName)
fn withName(name)
fn withPathRule(pathRule)
fn withPathRuleMixin(pathRule)
obj spec.forProvider.urlPathMap.pathRule
fn withBackendAddressPoolName(backendAddressPoolName)
fn withBackendHttpSettingsName(backendHttpSettingsName)
fn withFirewallPolicyId(firewallPolicyId)
fn withName(name)
fn withPaths(paths)
fn withPathsMixin(paths)
fn withRedirectConfigurationName(redirectConfigurationName)
fn withRewriteRuleSetName(rewriteRuleSetName)
obj spec.forProvider.wafConfiguration
fn withDisabledRuleGroup(disabledRuleGroup)
fn withDisabledRuleGroupMixin(disabledRuleGroup)
fn withEnabled(enabled)
fn withExclusion(exclusion)
fn withExclusionMixin(exclusion)
fn withFileUploadLimitMb(fileUploadLimitMb)
fn withFirewallMode(firewallMode)
fn withMaxRequestBodySizeKb(maxRequestBodySizeKb)
fn withRequestBodyCheck(requestBodyCheck)
fn withRuleSetType(ruleSetType)
fn withRuleSetVersion(ruleSetVersion)
obj spec.forProvider.wafConfiguration.disabledRuleGroup
obj spec.forProvider.wafConfiguration.exclusion
obj spec.providerConfigRef
obj spec.providerRef
obj spec.publishConnectionDetailsTo
obj spec.writeConnectionSecretToRef
Fields
fn new
new(name)
new returns an instance of ApplicationGateway
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
"ApplicationGatewaySpec defines the desired state of ApplicationGateway"
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.withAuthenticationCertificate
withAuthenticationCertificate(authenticationCertificate)
"One or more authentication_certificate blocks as defined below."
fn spec.forProvider.withAuthenticationCertificateMixin
withAuthenticationCertificateMixin(authenticationCertificate)
"One or more authentication_certificate blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withAutoscaleConfiguration
withAutoscaleConfiguration(autoscaleConfiguration)
"A autoscale_configuration block as defined below."
fn spec.forProvider.withAutoscaleConfigurationMixin
withAutoscaleConfigurationMixin(autoscaleConfiguration)
"A autoscale_configuration block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withBackendAddressPool
withBackendAddressPool(backendAddressPool)
"One or more backend_address_pool blocks as defined below."
fn spec.forProvider.withBackendAddressPoolMixin
withBackendAddressPoolMixin(backendAddressPool)
"One or more backend_address_pool blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withBackendHttpSettings
withBackendHttpSettings(backendHttpSettings)
"One or more backend_http_settings blocks as defined below."
fn spec.forProvider.withBackendHttpSettingsMixin
withBackendHttpSettingsMixin(backendHttpSettings)
"One or more backend_http_settings blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withCustomErrorConfiguration
withCustomErrorConfiguration(customErrorConfiguration)
"One or more custom_error_configuration blocks as defined below."
fn spec.forProvider.withCustomErrorConfigurationMixin
withCustomErrorConfigurationMixin(customErrorConfiguration)
"One or more custom_error_configuration blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withEnableHttp2
withEnableHttp2(enableHttp2)
"Is HTTP2 enabled on the application gateway resource? Defaults to false."
fn spec.forProvider.withFipsEnabled
withFipsEnabled(fipsEnabled)
"Is FIPS enabled on the Application Gateway?"
fn spec.forProvider.withFirewallPolicyId
withFirewallPolicyId(firewallPolicyId)
"The ID of the Web Application Firewall Policy."
fn spec.forProvider.withForceFirewallPolicyAssociation
withForceFirewallPolicyAssociation(forceFirewallPolicyAssociation)
"Is the Firewall Policy associated with the Application Gateway?"
fn spec.forProvider.withFrontendIpConfiguration
withFrontendIpConfiguration(frontendIpConfiguration)
"One or more frontend_ip_configuration blocks as defined below."
fn spec.forProvider.withFrontendIpConfigurationMixin
withFrontendIpConfigurationMixin(frontendIpConfiguration)
"One or more frontend_ip_configuration blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withFrontendPort
withFrontendPort(frontendPort)
"One or more frontend_port blocks as defined below."
fn spec.forProvider.withFrontendPortMixin
withFrontendPortMixin(frontendPort)
"One or more frontend_port blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withGatewayIpConfiguration
withGatewayIpConfiguration(gatewayIpConfiguration)
"One or more gateway_ip_configuration blocks as defined below."
fn spec.forProvider.withGatewayIpConfigurationMixin
withGatewayIpConfigurationMixin(gatewayIpConfiguration)
"One or more gateway_ip_configuration blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withGlobal
withGlobal(global)
"A global block as defined below."
fn spec.forProvider.withGlobalMixin
withGlobalMixin(global)
"A global block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withHttpListener
withHttpListener(httpListener)
"One or more http_listener blocks as defined below."
fn spec.forProvider.withHttpListenerMixin
withHttpListenerMixin(httpListener)
"One or more http_listener blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withIdentity
withIdentity(identity)
"An identity block as defined below."
fn spec.forProvider.withIdentityMixin
withIdentityMixin(identity)
"An identity block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withLocation
withLocation(location)
"The Azure region where the Application Gateway should exist. Changing this forces a new resource to be created."
fn spec.forProvider.withPrivateLinkConfiguration
withPrivateLinkConfiguration(privateLinkConfiguration)
"One or more private_link_configuration blocks as defined below."
fn spec.forProvider.withPrivateLinkConfigurationMixin
withPrivateLinkConfigurationMixin(privateLinkConfiguration)
"One or more private_link_configuration blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withProbe
withProbe(probe)
"One or more probe blocks as defined below."
fn spec.forProvider.withProbeMixin
withProbeMixin(probe)
"One or more probe blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withRedirectConfiguration
withRedirectConfiguration(redirectConfiguration)
"One or more redirect_configuration blocks as defined below."
fn spec.forProvider.withRedirectConfigurationMixin
withRedirectConfigurationMixin(redirectConfiguration)
"One or more redirect_configuration blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withRequestRoutingRule
withRequestRoutingRule(requestRoutingRule)
"One or more request_routing_rule blocks as defined below."
fn spec.forProvider.withRequestRoutingRuleMixin
withRequestRoutingRuleMixin(requestRoutingRule)
"One or more request_routing_rule blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withResourceGroupName
withResourceGroupName(resourceGroupName)
"The name of the resource group in which to the Application Gateway should exist. Changing this forces a new resource to be created."
fn spec.forProvider.withRewriteRuleSet
withRewriteRuleSet(rewriteRuleSet)
"One or more rewrite_rule_set blocks as defined below. Only valid for v2 SKUs."
fn spec.forProvider.withRewriteRuleSetMixin
withRewriteRuleSetMixin(rewriteRuleSet)
"One or more rewrite_rule_set blocks as defined below. Only valid for v2 SKUs."
Note: This function appends passed data to existing values
fn spec.forProvider.withSku
withSku(sku)
"A sku block as defined below."
fn spec.forProvider.withSkuMixin
withSkuMixin(sku)
"A sku block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withSslCertificate
withSslCertificate(sslCertificate)
"One or more ssl_certificate blocks as defined below."
fn spec.forProvider.withSslCertificateMixin
withSslCertificateMixin(sslCertificate)
"One or more ssl_certificate blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withSslPolicy
withSslPolicy(sslPolicy)
"a ssl_policy block as defined below."
fn spec.forProvider.withSslPolicyMixin
withSslPolicyMixin(sslPolicy)
"a ssl_policy block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withSslProfile
withSslProfile(sslProfile)
"One or more ssl_profile blocks as defined below."
fn spec.forProvider.withSslProfileMixin
withSslProfileMixin(sslProfile)
"One or more ssl_profile blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withTags
withTags(tags)
"A mapping of tags to assign to the resource."
fn spec.forProvider.withTagsMixin
withTagsMixin(tags)
"A mapping of tags to assign to the resource."
Note: This function appends passed data to existing values
fn spec.forProvider.withTrustedClientCertificate
withTrustedClientCertificate(trustedClientCertificate)
"One or more trusted_client_certificate blocks as defined below."
fn spec.forProvider.withTrustedClientCertificateMixin
withTrustedClientCertificateMixin(trustedClientCertificate)
"One or more trusted_client_certificate blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withTrustedRootCertificate
withTrustedRootCertificate(trustedRootCertificate)
"One or more trusted_root_certificate blocks as defined below."
fn spec.forProvider.withTrustedRootCertificateMixin
withTrustedRootCertificateMixin(trustedRootCertificate)
"One or more trusted_root_certificate blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withUrlPathMap
withUrlPathMap(urlPathMap)
"One or more url_path_map blocks as defined below."
fn spec.forProvider.withUrlPathMapMixin
withUrlPathMapMixin(urlPathMap)
"One or more url_path_map blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withWafConfiguration
withWafConfiguration(wafConfiguration)
"A waf_configuration block as defined below."
fn spec.forProvider.withWafConfigurationMixin
withWafConfigurationMixin(wafConfiguration)
"A waf_configuration block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withZones
withZones(zones)
"Specifies a list of Availability Zones in which this Application Gateway should be located. Changing this forces a new Application Gateway to be created."
fn spec.forProvider.withZonesMixin
withZonesMixin(zones)
"Specifies a list of Availability Zones in which this Application Gateway should be located. Changing this forces a new Application Gateway to be created."
Note: This function appends passed data to existing values
obj spec.forProvider.authenticationCertificate
"One or more authentication_certificate blocks as defined below."
fn spec.forProvider.authenticationCertificate.withName
withName(name)
"The Name of the Authentication Certificate to use."
obj spec.forProvider.authenticationCertificate.dataSecretRef
"The contents of the Authentication Certificate which should be used."
fn spec.forProvider.authenticationCertificate.dataSecretRef.withKey
withKey(key)
"The key to select."
fn spec.forProvider.authenticationCertificate.dataSecretRef.withName
withName(name)
"Name of the secret."
fn spec.forProvider.authenticationCertificate.dataSecretRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."
obj spec.forProvider.autoscaleConfiguration
"A autoscale_configuration block as defined below."
fn spec.forProvider.autoscaleConfiguration.withMaxCapacity
withMaxCapacity(maxCapacity)
"Maximum capacity for autoscaling. Accepted values are in the range 2 to 125."
fn spec.forProvider.autoscaleConfiguration.withMinCapacity
withMinCapacity(minCapacity)
"Minimum capacity for autoscaling. Accepted values are in the range 0 to 100."
obj spec.forProvider.backendAddressPool
"One or more backend_address_pool blocks as defined below."
fn spec.forProvider.backendAddressPool.withFqdns
withFqdns(fqdns)
"A list of FQDN's which should be part of the Backend Address Pool."
fn spec.forProvider.backendAddressPool.withFqdnsMixin
withFqdnsMixin(fqdns)
"A list of FQDN's which should be part of the Backend Address Pool."
Note: This function appends passed data to existing values
fn spec.forProvider.backendAddressPool.withIpAddresses
withIpAddresses(ipAddresses)
"A list of IP Addresses which should be part of the Backend Address Pool."
fn spec.forProvider.backendAddressPool.withIpAddressesMixin
withIpAddressesMixin(ipAddresses)
"A list of IP Addresses which should be part of the Backend Address Pool."
Note: This function appends passed data to existing values
fn spec.forProvider.backendAddressPool.withName
withName(name)
"The name of the Backend Address Pool."
obj spec.forProvider.backendHttpSettings
"One or more backend_http_settings blocks as defined below."
fn spec.forProvider.backendHttpSettings.withAffinityCookieName
withAffinityCookieName(affinityCookieName)
"The name of the affinity cookie."
fn spec.forProvider.backendHttpSettings.withAuthenticationCertificate
withAuthenticationCertificate(authenticationCertificate)
"One or more authentication_certificate blocks as defined below."
fn spec.forProvider.backendHttpSettings.withAuthenticationCertificateMixin
withAuthenticationCertificateMixin(authenticationCertificate)
"One or more authentication_certificate blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.backendHttpSettings.withConnectionDraining
withConnectionDraining(connectionDraining)
"A connection_draining block as defined below."
fn spec.forProvider.backendHttpSettings.withConnectionDrainingMixin
withConnectionDrainingMixin(connectionDraining)
"A connection_draining block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.backendHttpSettings.withCookieBasedAffinity
withCookieBasedAffinity(cookieBasedAffinity)
"Is Cookie-Based Affinity enabled? Possible values are Enabled and Disabled."
fn spec.forProvider.backendHttpSettings.withHostName
withHostName(hostName)
"Host header to be sent to the backend servers. Cannot be set if pick_host_name_from_backend_address is set to true."
fn spec.forProvider.backendHttpSettings.withName
withName(name)
"The name of the Backend HTTP Settings Collection."
fn spec.forProvider.backendHttpSettings.withPath
withPath(path)
"The Path which should be used as a prefix for all HTTP requests."
fn spec.forProvider.backendHttpSettings.withPickHostNameFromBackendAddress
withPickHostNameFromBackendAddress(pickHostNameFromBackendAddress)
"Whether host header should be picked from the host name of the backend server. Defaults to false."
fn spec.forProvider.backendHttpSettings.withPort
withPort(port)
"The port which should be used for this Backend HTTP Settings Collection."
fn spec.forProvider.backendHttpSettings.withProbeName
withProbeName(probeName)
"The name of an associated HTTP Probe."
fn spec.forProvider.backendHttpSettings.withProtocol
withProtocol(protocol)
"The Protocol which should be used. Possible values are Http and Https."
fn spec.forProvider.backendHttpSettings.withRequestTimeout
withRequestTimeout(requestTimeout)
"The request timeout in seconds, which must be between 1 and 86400 seconds. Defaults to 30."
fn spec.forProvider.backendHttpSettings.withTrustedRootCertificateNames
withTrustedRootCertificateNames(trustedRootCertificateNames)
"A list of trusted_root_certificate names."
fn spec.forProvider.backendHttpSettings.withTrustedRootCertificateNamesMixin
withTrustedRootCertificateNamesMixin(trustedRootCertificateNames)
"A list of trusted_root_certificate names."
Note: This function appends passed data to existing values
obj spec.forProvider.backendHttpSettings.authenticationCertificate
"One or more authentication_certificate blocks as defined below."
fn spec.forProvider.backendHttpSettings.authenticationCertificate.withName
withName(name)
"The Name of the URL Path Map."
obj spec.forProvider.backendHttpSettings.connectionDraining
"A connection_draining block as defined below."
fn spec.forProvider.backendHttpSettings.connectionDraining.withDrainTimeoutSec
withDrainTimeoutSec(drainTimeoutSec)
"The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds."
fn spec.forProvider.backendHttpSettings.connectionDraining.withEnabled
withEnabled(enabled)
"Is the Web Application Firewall enabled?"
obj spec.forProvider.customErrorConfiguration
"One or more custom_error_configuration blocks as defined below."
fn spec.forProvider.customErrorConfiguration.withCustomErrorPageUrl
withCustomErrorPageUrl(customErrorPageUrl)
"Error page URL of the application gateway customer error."
fn spec.forProvider.customErrorConfiguration.withStatusCode
withStatusCode(statusCode)
"Status code of the application gateway customer error. Possible values are HttpStatus403 and HttpStatus502"
obj spec.forProvider.frontendIpConfiguration
"One or more frontend_ip_configuration blocks as defined below."
fn spec.forProvider.frontendIpConfiguration.withName
withName(name)
"The name of the Frontend IP Configuration."
fn spec.forProvider.frontendIpConfiguration.withPrivateIpAddress
withPrivateIpAddress(privateIpAddress)
"The Private IP Address to use for the Application Gateway."
fn spec.forProvider.frontendIpConfiguration.withPrivateIpAddressAllocation
withPrivateIpAddressAllocation(privateIpAddressAllocation)
"The Allocation Method for the Private IP Address. Possible values are Dynamic and Static."
fn spec.forProvider.frontendIpConfiguration.withPrivateLinkConfigurationName
withPrivateLinkConfigurationName(privateLinkConfigurationName)
"The name of the private link configuration to use for this frontend IP configuration."
fn spec.forProvider.frontendIpConfiguration.withPublicIpAddressId
withPublicIpAddressId(publicIpAddressId)
"The ID of a Public IP Address which the Application Gateway should use. The allocation method for the Public IP Address depends on the sku of this Application Gateway. Please refer to the Azure documentation for public IP addresses for details."
fn spec.forProvider.frontendIpConfiguration.withSubnetId
withSubnetId(subnetId)
"The ID of the Subnet."
obj spec.forProvider.frontendIpConfiguration.publicIpAddressIdRef
"Reference to a PublicIP to populate publicIpAddressId."
fn spec.forProvider.frontendIpConfiguration.publicIpAddressIdRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.frontendIpConfiguration.publicIpAddressIdRef.policy
"Policies for referencing."
fn spec.forProvider.frontendIpConfiguration.publicIpAddressIdRef.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.frontendIpConfiguration.publicIpAddressIdRef.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.frontendIpConfiguration.publicIpAddressIdSelector
"Selector for a PublicIP to populate publicIpAddressId."
fn spec.forProvider.frontendIpConfiguration.publicIpAddressIdSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.frontendIpConfiguration.publicIpAddressIdSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.frontendIpConfiguration.publicIpAddressIdSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.frontendIpConfiguration.publicIpAddressIdSelector.policy
"Policies for selection."
fn spec.forProvider.frontendIpConfiguration.publicIpAddressIdSelector.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.frontendIpConfiguration.publicIpAddressIdSelector.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.frontendIpConfiguration.subnetIdRef
"Reference to a Subnet to populate subnetId."
fn spec.forProvider.frontendIpConfiguration.subnetIdRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.frontendIpConfiguration.subnetIdRef.policy
"Policies for referencing."
fn spec.forProvider.frontendIpConfiguration.subnetIdRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.frontendIpConfiguration.subnetIdRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.frontendIpConfiguration.subnetIdSelector
"Selector for a Subnet to populate subnetId."
fn spec.forProvider.frontendIpConfiguration.subnetIdSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.frontendIpConfiguration.subnetIdSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.frontendIpConfiguration.subnetIdSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.frontendIpConfiguration.subnetIdSelector.policy
"Policies for selection."
fn spec.forProvider.frontendIpConfiguration.subnetIdSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.frontendIpConfiguration.subnetIdSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.frontendPort
"One or more frontend_port blocks as defined below."
fn spec.forProvider.frontendPort.withName
withName(name)
"The name of the Frontend Port."
fn spec.forProvider.frontendPort.withPort
withPort(port)
"The port used for this Frontend Port."
obj spec.forProvider.gatewayIpConfiguration
"One or more gateway_ip_configuration blocks as defined below."
fn spec.forProvider.gatewayIpConfiguration.withName
withName(name)
"The Name of this Gateway IP Configuration."
fn spec.forProvider.gatewayIpConfiguration.withSubnetId
withSubnetId(subnetId)
"The ID of the Subnet which the Application Gateway should be connected to."
obj spec.forProvider.gatewayIpConfiguration.subnetIdRef
"Reference to a Subnet in network to populate subnetId."
fn spec.forProvider.gatewayIpConfiguration.subnetIdRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.gatewayIpConfiguration.subnetIdRef.policy
"Policies for referencing."
fn spec.forProvider.gatewayIpConfiguration.subnetIdRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.gatewayIpConfiguration.subnetIdRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.gatewayIpConfiguration.subnetIdSelector
"Selector for a Subnet in network to populate subnetId."
fn spec.forProvider.gatewayIpConfiguration.subnetIdSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.gatewayIpConfiguration.subnetIdSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.gatewayIpConfiguration.subnetIdSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.gatewayIpConfiguration.subnetIdSelector.policy
"Policies for selection."
fn spec.forProvider.gatewayIpConfiguration.subnetIdSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.gatewayIpConfiguration.subnetIdSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.global
"A global block as defined below."
fn spec.forProvider.global.withRequestBufferingEnabled
withRequestBufferingEnabled(requestBufferingEnabled)
"Whether Application Gateway's Request buffer is enabled."
fn spec.forProvider.global.withResponseBufferingEnabled
withResponseBufferingEnabled(responseBufferingEnabled)
"Whether Application Gateway's Response buffer is enabled."
obj spec.forProvider.httpListener
"One or more http_listener blocks as defined below."
fn spec.forProvider.httpListener.withCustomErrorConfiguration
withCustomErrorConfiguration(customErrorConfiguration)
"One or more custom_error_configuration blocks as defined below."
fn spec.forProvider.httpListener.withCustomErrorConfigurationMixin
withCustomErrorConfigurationMixin(customErrorConfiguration)
"One or more custom_error_configuration blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.httpListener.withFirewallPolicyId
withFirewallPolicyId(firewallPolicyId)
"The ID of the Web Application Firewall Policy which should be used for this HTTP Listener."
fn spec.forProvider.httpListener.withFrontendIpConfigurationName
withFrontendIpConfigurationName(frontendIpConfigurationName)
"The Name of the Frontend IP Configuration used for this HTTP Listener."
fn spec.forProvider.httpListener.withFrontendPortName
withFrontendPortName(frontendPortName)
"The Name of the Frontend Port use for this HTTP Listener."
fn spec.forProvider.httpListener.withHostName
withHostName(hostName)
"The Hostname which should be used for this HTTP Listener. Setting this value changes Listener Type to 'Multi site'."
fn spec.forProvider.httpListener.withHostNames
withHostNames(hostNames)
"A list of Hostname(s) should be used for this HTTP Listener. It allows special wildcard characters."
fn spec.forProvider.httpListener.withHostNamesMixin
withHostNamesMixin(hostNames)
"A list of Hostname(s) should be used for this HTTP Listener. It allows special wildcard characters."
Note: This function appends passed data to existing values
fn spec.forProvider.httpListener.withName
withName(name)
"The Name of the HTTP Listener."
fn spec.forProvider.httpListener.withProtocol
withProtocol(protocol)
"The Protocol to use for this HTTP Listener. Possible values are Http and Https."
fn spec.forProvider.httpListener.withRequireSni
withRequireSni(requireSni)
"Should Server Name Indication be Required?"
fn spec.forProvider.httpListener.withSslCertificateName
withSslCertificateName(sslCertificateName)
"The name of the associated SSL Certificate which should be used for this HTTP Listener."
fn spec.forProvider.httpListener.withSslProfileName
withSslProfileName(sslProfileName)
"The name of the associated SSL Profile which should be used for this HTTP Listener."
obj spec.forProvider.httpListener.customErrorConfiguration
"One or more custom_error_configuration blocks as defined below."
fn spec.forProvider.httpListener.customErrorConfiguration.withCustomErrorPageUrl
withCustomErrorPageUrl(customErrorPageUrl)
"Error page URL of the application gateway customer error."
fn spec.forProvider.httpListener.customErrorConfiguration.withStatusCode
withStatusCode(statusCode)
"A list of allowed status codes for this Health Probe."
obj spec.forProvider.identity
"An identity block as defined below."
fn spec.forProvider.identity.withIdentityIds
withIdentityIds(identityIds)
"Specifies a list of User Assigned Managed Identity IDs to be assigned to this Application Gateway."
fn spec.forProvider.identity.withIdentityIdsMixin
withIdentityIdsMixin(identityIds)
"Specifies a list of User Assigned Managed Identity IDs to be assigned to this Application Gateway."
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 Application Gateway. Only possible value is UserAssigned."
obj spec.forProvider.privateLinkConfiguration
"One or more private_link_configuration blocks as defined below."
fn spec.forProvider.privateLinkConfiguration.withIpConfiguration
withIpConfiguration(ipConfiguration)
"One or more ip_configuration blocks as defined below."
fn spec.forProvider.privateLinkConfiguration.withIpConfigurationMixin
withIpConfigurationMixin(ipConfiguration)
"One or more ip_configuration blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.privateLinkConfiguration.withName
withName(name)
"The name of the private link configuration."
obj spec.forProvider.privateLinkConfiguration.ipConfiguration
"One or more ip_configuration blocks as defined below."
fn spec.forProvider.privateLinkConfiguration.ipConfiguration.withName
withName(name)
"The Name of the URL Path Map."
fn spec.forProvider.privateLinkConfiguration.ipConfiguration.withPrimary
withPrimary(primary)
"Is this the Primary IP Configuration?"
fn spec.forProvider.privateLinkConfiguration.ipConfiguration.withPrivateIpAddress
withPrivateIpAddress(privateIpAddress)
"The Static IP Address which should be used."
fn spec.forProvider.privateLinkConfiguration.ipConfiguration.withPrivateIpAddressAllocation
withPrivateIpAddressAllocation(privateIpAddressAllocation)
"The allocation method used for the Private IP Address. Possible values are Dynamic and Static."
fn spec.forProvider.privateLinkConfiguration.ipConfiguration.withSubnetId
withSubnetId(subnetId)
"The ID of the subnet the private link configuration should connect to."
obj spec.forProvider.privateLinkConfiguration.ipConfiguration.subnetIdRef
"Reference to a Subnet to populate subnetId."
fn spec.forProvider.privateLinkConfiguration.ipConfiguration.subnetIdRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.privateLinkConfiguration.ipConfiguration.subnetIdRef.policy
"Policies for referencing."
fn spec.forProvider.privateLinkConfiguration.ipConfiguration.subnetIdRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.privateLinkConfiguration.ipConfiguration.subnetIdRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.privateLinkConfiguration.ipConfiguration.subnetIdSelector
"Selector for a Subnet to populate subnetId."
fn spec.forProvider.privateLinkConfiguration.ipConfiguration.subnetIdSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.privateLinkConfiguration.ipConfiguration.subnetIdSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.privateLinkConfiguration.ipConfiguration.subnetIdSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.privateLinkConfiguration.ipConfiguration.subnetIdSelector.policy
"Policies for selection."
fn spec.forProvider.privateLinkConfiguration.ipConfiguration.subnetIdSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.privateLinkConfiguration.ipConfiguration.subnetIdSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.probe
"One or more probe blocks as defined below."
fn spec.forProvider.probe.withHost
withHost(host)
"The Hostname used for this Probe. If the Application Gateway is configured for a single site, by default the Host name should be specified as ‘127.0.0.1’, unless otherwise configured in custom probe. Cannot be set if pick_host_name_from_backend_http_settings is set to true."
fn spec.forProvider.probe.withInterval
withInterval(interval)
"The Interval between two consecutive probes in seconds. Possible values range from 1 second to a maximum of 86,400 seconds."
fn spec.forProvider.probe.withMatch
withMatch(match)
"A match block as defined above."
fn spec.forProvider.probe.withMatchMixin
withMatchMixin(match)
"A match block as defined above."
Note: This function appends passed data to existing values
fn spec.forProvider.probe.withMinimumServers
withMinimumServers(minimumServers)
"The minimum number of servers that are always marked as healthy. Defaults to 0."
fn spec.forProvider.probe.withName
withName(name)
"The Name of the Probe."
fn spec.forProvider.probe.withPath
withPath(path)
"The Path used for this Probe."
fn spec.forProvider.probe.withPickHostNameFromBackendHttpSettings
withPickHostNameFromBackendHttpSettings(pickHostNameFromBackendHttpSettings)
"Whether the host header should be picked from the backend HTTP settings. Defaults to false."
fn spec.forProvider.probe.withPort
withPort(port)
"Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from HTTP settings will be used. This property is valid for Standard_v2 and WAF_v2 only."
fn spec.forProvider.probe.withProtocol
withProtocol(protocol)
"The Protocol used for this Probe. Possible values are Http and Https."
fn spec.forProvider.probe.withTimeout
withTimeout(timeout)
"The Timeout used for this Probe, which indicates when a probe becomes unhealthy. Possible values range from 1 second to a maximum of 86,400 seconds."
fn spec.forProvider.probe.withUnhealthyThreshold
withUnhealthyThreshold(unhealthyThreshold)
"The Unhealthy Threshold for this Probe, which indicates the amount of retries which should be attempted before a node is deemed unhealthy. Possible values are from 1 to 20."
obj spec.forProvider.probe.match
"A match block as defined above."
fn spec.forProvider.probe.match.withBody
withBody(body)
"A snippet from the Response Body which must be present in the Response."
fn spec.forProvider.probe.match.withStatusCode
withStatusCode(statusCode)
"A list of allowed status codes for this Health Probe."
fn spec.forProvider.probe.match.withStatusCodeMixin
withStatusCodeMixin(statusCode)
"A list of allowed status codes for this Health Probe."
Note: This function appends passed data to existing values
obj spec.forProvider.redirectConfiguration
"One or more redirect_configuration blocks as defined below."
fn spec.forProvider.redirectConfiguration.withIncludePath
withIncludePath(includePath)
"Whether or not to include the path in the redirected Url. Defaults to false"
fn spec.forProvider.redirectConfiguration.withIncludeQueryString
withIncludeQueryString(includeQueryString)
"Whether or not to include the query string in the redirected Url. Default to false"
fn spec.forProvider.redirectConfiguration.withName
withName(name)
"Unique name of the redirect configuration block"
fn spec.forProvider.redirectConfiguration.withRedirectType
withRedirectType(redirectType)
"The type of redirect. Possible values are Permanent, Temporary, Found and SeeOther"
fn spec.forProvider.redirectConfiguration.withTargetListenerName
withTargetListenerName(targetListenerName)
"The name of the listener to redirect to. Cannot be set if target_url is set."
fn spec.forProvider.redirectConfiguration.withTargetUrl
withTargetUrl(targetUrl)
"The Url to redirect the request to. Cannot be set if target_listener_name is set."
obj spec.forProvider.requestRoutingRule
"One or more request_routing_rule blocks as defined below."
fn spec.forProvider.requestRoutingRule.withBackendAddressPoolName
withBackendAddressPoolName(backendAddressPoolName)
"The Name of the Backend Address Pool which should be used for this Routing Rule. Cannot be set if redirect_configuration_name is set."
fn spec.forProvider.requestRoutingRule.withBackendHttpSettingsName
withBackendHttpSettingsName(backendHttpSettingsName)
"The Name of the Backend HTTP Settings Collection which should be used for this Routing Rule. Cannot be set if redirect_configuration_name is set."
fn spec.forProvider.requestRoutingRule.withHttpListenerName
withHttpListenerName(httpListenerName)
"The Name of the HTTP Listener which should be used for this Routing Rule."
fn spec.forProvider.requestRoutingRule.withName
withName(name)
"The Name of this Request Routing Rule."
fn spec.forProvider.requestRoutingRule.withPriority
withPriority(priority)
"Rule evaluation order can be dictated by specifying an integer value from 1 to 20000 with 1 being the highest priority and 20000 being the lowest priority."
fn spec.forProvider.requestRoutingRule.withRedirectConfigurationName
withRedirectConfigurationName(redirectConfigurationName)
"The Name of the Redirect Configuration which should be used for this Routing Rule. Cannot be set if either backend_address_pool_name or backend_http_settings_name is set."
fn spec.forProvider.requestRoutingRule.withRewriteRuleSetName
withRewriteRuleSetName(rewriteRuleSetName)
"The Name of the Rewrite Rule Set which should be used for this Routing Rule. Only valid for v2 SKUs."
fn spec.forProvider.requestRoutingRule.withRuleType
withRuleType(ruleType)
"The Type of Routing that should be used for this Rule. Possible values are Basic and PathBasedRouting."
fn spec.forProvider.requestRoutingRule.withUrlPathMapName
withUrlPathMapName(urlPathMapName)
"The Name of the URL Path Map which should be associated with this Routing Rule."
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.rewriteRuleSet
"One or more rewrite_rule_set blocks as defined below. Only valid for v2 SKUs."
fn spec.forProvider.rewriteRuleSet.withName
withName(name)
"Unique name of the rewrite rule set block"
fn spec.forProvider.rewriteRuleSet.withRewriteRule
withRewriteRule(rewriteRule)
"One or more rewrite_rule blocks as defined above."
fn spec.forProvider.rewriteRuleSet.withRewriteRuleMixin
withRewriteRuleMixin(rewriteRule)
"One or more rewrite_rule blocks as defined above."
Note: This function appends passed data to existing values
obj spec.forProvider.rewriteRuleSet.rewriteRule
"One or more rewrite_rule blocks as defined above."
fn spec.forProvider.rewriteRuleSet.rewriteRule.withCondition
withCondition(condition)
"One or more condition blocks as defined above."
fn spec.forProvider.rewriteRuleSet.rewriteRule.withConditionMixin
withConditionMixin(condition)
"One or more condition blocks as defined above."
Note: This function appends passed data to existing values
fn spec.forProvider.rewriteRuleSet.rewriteRule.withName
withName(name)
"The Name of the URL Path Map."
fn spec.forProvider.rewriteRuleSet.rewriteRule.withRequestHeaderConfiguration
withRequestHeaderConfiguration(requestHeaderConfiguration)
"One or more request_header_configuration blocks as defined above."
fn spec.forProvider.rewriteRuleSet.rewriteRule.withRequestHeaderConfigurationMixin
withRequestHeaderConfigurationMixin(requestHeaderConfiguration)
"One or more request_header_configuration blocks as defined above."
Note: This function appends passed data to existing values
fn spec.forProvider.rewriteRuleSet.rewriteRule.withResponseHeaderConfiguration
withResponseHeaderConfiguration(responseHeaderConfiguration)
"One or more response_header_configuration blocks as defined above."
fn spec.forProvider.rewriteRuleSet.rewriteRule.withResponseHeaderConfigurationMixin
withResponseHeaderConfigurationMixin(responseHeaderConfiguration)
"One or more response_header_configuration blocks as defined above."
Note: This function appends passed data to existing values
fn spec.forProvider.rewriteRuleSet.rewriteRule.withRuleSequence
withRuleSequence(ruleSequence)
"Rule sequence of the rewrite rule that determines the order of execution in a set."
fn spec.forProvider.rewriteRuleSet.rewriteRule.withUrl
withUrl(url)
"One url block as defined above"
fn spec.forProvider.rewriteRuleSet.rewriteRule.withUrlMixin
withUrlMixin(url)
"One url block as defined above"
Note: This function appends passed data to existing values
obj spec.forProvider.rewriteRuleSet.rewriteRule.condition
"One or more condition blocks as defined above."
fn spec.forProvider.rewriteRuleSet.rewriteRule.condition.withIgnoreCase
withIgnoreCase(ignoreCase)
"Perform a case in-sensitive comparison. Defaults to false"
fn spec.forProvider.rewriteRuleSet.rewriteRule.condition.withNegate
withNegate(negate)
"Negate the result of the condition evaluation. Defaults to false"
fn spec.forProvider.rewriteRuleSet.rewriteRule.condition.withPattern
withPattern(pattern)
"The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition."
fn spec.forProvider.rewriteRuleSet.rewriteRule.condition.withVariable
withVariable(variable)
"The variable of the condition."
obj spec.forProvider.rewriteRuleSet.rewriteRule.requestHeaderConfiguration
"One or more request_header_configuration blocks as defined above."
fn spec.forProvider.rewriteRuleSet.rewriteRule.requestHeaderConfiguration.withHeaderName
withHeaderName(headerName)
"Header name of the header configuration."
fn spec.forProvider.rewriteRuleSet.rewriteRule.requestHeaderConfiguration.withHeaderValue
withHeaderValue(headerValue)
"Header value of the header configuration. To delete a response header set this property to an empty string."
obj spec.forProvider.rewriteRuleSet.rewriteRule.responseHeaderConfiguration
"One or more response_header_configuration blocks as defined above."
fn spec.forProvider.rewriteRuleSet.rewriteRule.responseHeaderConfiguration.withHeaderName
withHeaderName(headerName)
"Header name of the header configuration."
fn spec.forProvider.rewriteRuleSet.rewriteRule.responseHeaderConfiguration.withHeaderValue
withHeaderValue(headerValue)
"Header value of the header configuration. To delete a response header set this property to an empty string."
obj spec.forProvider.rewriteRuleSet.rewriteRule.url
"One url block as defined above"
fn spec.forProvider.rewriteRuleSet.rewriteRule.url.withComponents
withComponents(components)
"The components used to rewrite the URL. Possible values are path_only and query_string_only to limit the rewrite to the URL Path or URL Query String only."
fn spec.forProvider.rewriteRuleSet.rewriteRule.url.withPath
withPath(path)
"The URL path to rewrite."
fn spec.forProvider.rewriteRuleSet.rewriteRule.url.withQueryString
withQueryString(queryString)
"The query string to rewrite."
fn spec.forProvider.rewriteRuleSet.rewriteRule.url.withReroute
withReroute(reroute)
"Whether the URL path map should be reevaluated after this rewrite has been applied. More info on rewrite configutation"
obj spec.forProvider.sku
"A sku block as defined below."
fn spec.forProvider.sku.withCapacity
withCapacity(capacity)
"The Capacity of the SKU to use for this Application Gateway. When using a V1 SKU this value must be between 1 and 32, and 1 to 125 for a V2 SKU. This property is optional if autoscale_configuration is set."
fn spec.forProvider.sku.withName
withName(name)
"The Name of the SKU to use for this Application Gateway. Possible values are Standard_Small, Standard_Medium, Standard_Large, Standard_v2, WAF_Medium, WAF_Large, and WAF_v2."
fn spec.forProvider.sku.withTier
withTier(tier)
"The Tier of the SKU to use for this Application Gateway. Possible values are Standard, Standard_v2, WAF and WAF_v2."
obj spec.forProvider.sslCertificate
"One or more ssl_certificate blocks as defined below."
fn spec.forProvider.sslCertificate.withKeyVaultSecretId
withKeyVaultSecretId(keyVaultSecretId)
"Secret Id of (base-64 encoded unencrypted pfx) Secret or Certificate object stored in Azure KeyVault. You need to enable soft delete for keyvault to use this feature. Required if data is not set."
fn spec.forProvider.sslCertificate.withName
withName(name)
"The Name of the SSL certificate that is unique within this Application Gateway"
obj spec.forProvider.sslCertificate.dataSecretRef
"PFX certificate. Required if key_vault_secret_id is not set."
fn spec.forProvider.sslCertificate.dataSecretRef.withKey
withKey(key)
"The key to select."
fn spec.forProvider.sslCertificate.dataSecretRef.withName
withName(name)
"Name of the secret."
fn spec.forProvider.sslCertificate.dataSecretRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."
obj spec.forProvider.sslCertificate.passwordSecretRef
"Password for the pfx file specified in data. Required if data is set."
fn spec.forProvider.sslCertificate.passwordSecretRef.withKey
withKey(key)
"The key to select."
fn spec.forProvider.sslCertificate.passwordSecretRef.withName
withName(name)
"Name of the secret."
fn spec.forProvider.sslCertificate.passwordSecretRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."
obj spec.forProvider.sslPolicy
"a ssl_policy block as defined below."
fn spec.forProvider.sslPolicy.withCipherSuites
withCipherSuites(cipherSuites)
"A List of accepted cipher suites. Possible values are: TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA, TLS_DHE_DSS_WITH_AES_128_CBC_SHA, TLS_DHE_DSS_WITH_AES_128_CBC_SHA256, TLS_DHE_DSS_WITH_AES_256_CBC_SHA, TLS_DHE_DSS_WITH_AES_256_CBC_SHA256, TLS_DHE_RSA_WITH_AES_128_CBC_SHA, TLS_DHE_RSA_WITH_AES_128_GCM_SHA256, TLS_DHE_RSA_WITH_AES_256_CBC_SHA, TLS_DHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA256 and TLS_RSA_WITH_AES_256_GCM_SHA384."
fn spec.forProvider.sslPolicy.withCipherSuitesMixin
withCipherSuitesMixin(cipherSuites)
"A List of accepted cipher suites. Possible values are: TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA, TLS_DHE_DSS_WITH_AES_128_CBC_SHA, TLS_DHE_DSS_WITH_AES_128_CBC_SHA256, TLS_DHE_DSS_WITH_AES_256_CBC_SHA, TLS_DHE_DSS_WITH_AES_256_CBC_SHA256, TLS_DHE_RSA_WITH_AES_128_CBC_SHA, TLS_DHE_RSA_WITH_AES_128_GCM_SHA256, TLS_DHE_RSA_WITH_AES_256_CBC_SHA, TLS_DHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA256 and TLS_RSA_WITH_AES_256_GCM_SHA384."
Note: This function appends passed data to existing values
fn spec.forProvider.sslPolicy.withDisabledProtocols
withDisabledProtocols(disabledProtocols)
"A list of SSL Protocols which should be disabled on this Application Gateway. Possible values are TLSv1_0, TLSv1_1, TLSv1_2 and TLSv1_3."
fn spec.forProvider.sslPolicy.withDisabledProtocolsMixin
withDisabledProtocolsMixin(disabledProtocols)
"A list of SSL Protocols which should be disabled on this Application Gateway. Possible values are TLSv1_0, TLSv1_1, TLSv1_2 and TLSv1_3."
Note: This function appends passed data to existing values
fn spec.forProvider.sslPolicy.withMinProtocolVersion
withMinProtocolVersion(minProtocolVersion)
"The minimal TLS version. Possible values are TLSv1_0, TLSv1_1, TLSv1_2 and TLSv1_3."
fn spec.forProvider.sslPolicy.withPolicyName
withPolicyName(policyName)
"The Name of the Policy e.g AppGwSslPolicy20170401S. Required if policy_type is set to Predefined. Possible values can change over time and are published here https://docs.microsoft.com/azure/application-gateway/application-gateway-ssl-policy-overview. Not compatible with disabled_protocols."
fn spec.forProvider.sslPolicy.withPolicyType
withPolicyType(policyType)
"The Type of the Policy. Possible values are Predefined, Custom and CustomV2."
obj spec.forProvider.sslProfile
"One or more ssl_profile blocks as defined below."
fn spec.forProvider.sslProfile.withName
withName(name)
"The name of the SSL Profile that is unique within this Application Gateway."
fn spec.forProvider.sslProfile.withSslPolicy
withSslPolicy(sslPolicy)
"a ssl_policy block as defined below."
fn spec.forProvider.sslProfile.withSslPolicyMixin
withSslPolicyMixin(sslPolicy)
"a ssl_policy block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.sslProfile.withTrustedClientCertificateNames
withTrustedClientCertificateNames(trustedClientCertificateNames)
"The name of the Trusted Client Certificate that will be used to authenticate requests from clients."
fn spec.forProvider.sslProfile.withTrustedClientCertificateNamesMixin
withTrustedClientCertificateNamesMixin(trustedClientCertificateNames)
"The name of the Trusted Client Certificate that will be used to authenticate requests from clients."
Note: This function appends passed data to existing values
fn spec.forProvider.sslProfile.withVerifyClientCertIssuerDn
withVerifyClientCertIssuerDn(verifyClientCertIssuerDn)
"Should client certificate issuer DN be verified? Defaults to false."
obj spec.forProvider.sslProfile.sslPolicy
"a ssl_policy block as defined below."
fn spec.forProvider.sslProfile.sslPolicy.withCipherSuites
withCipherSuites(cipherSuites)
"A List of accepted cipher suites. Possible values are: TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA, TLS_DHE_DSS_WITH_AES_128_CBC_SHA, TLS_DHE_DSS_WITH_AES_128_CBC_SHA256, TLS_DHE_DSS_WITH_AES_256_CBC_SHA, TLS_DHE_DSS_WITH_AES_256_CBC_SHA256, TLS_DHE_RSA_WITH_AES_128_CBC_SHA, TLS_DHE_RSA_WITH_AES_128_GCM_SHA256, TLS_DHE_RSA_WITH_AES_256_CBC_SHA, TLS_DHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA256 and TLS_RSA_WITH_AES_256_GCM_SHA384."
fn spec.forProvider.sslProfile.sslPolicy.withCipherSuitesMixin
withCipherSuitesMixin(cipherSuites)
"A List of accepted cipher suites. Possible values are: TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA, TLS_DHE_DSS_WITH_AES_128_CBC_SHA, TLS_DHE_DSS_WITH_AES_128_CBC_SHA256, TLS_DHE_DSS_WITH_AES_256_CBC_SHA, TLS_DHE_DSS_WITH_AES_256_CBC_SHA256, TLS_DHE_RSA_WITH_AES_128_CBC_SHA, TLS_DHE_RSA_WITH_AES_128_GCM_SHA256, TLS_DHE_RSA_WITH_AES_256_CBC_SHA, TLS_DHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA256 and TLS_RSA_WITH_AES_256_GCM_SHA384."
Note: This function appends passed data to existing values
fn spec.forProvider.sslProfile.sslPolicy.withDisabledProtocols
withDisabledProtocols(disabledProtocols)
"A list of SSL Protocols which should be disabled on this Application Gateway. Possible values are TLSv1_0, TLSv1_1, TLSv1_2 and TLSv1_3."
fn spec.forProvider.sslProfile.sslPolicy.withDisabledProtocolsMixin
withDisabledProtocolsMixin(disabledProtocols)
"A list of SSL Protocols which should be disabled on this Application Gateway. Possible values are TLSv1_0, TLSv1_1, TLSv1_2 and TLSv1_3."
Note: This function appends passed data to existing values
fn spec.forProvider.sslProfile.sslPolicy.withMinProtocolVersion
withMinProtocolVersion(minProtocolVersion)
"The minimal TLS version. Possible values are TLSv1_0, TLSv1_1, TLSv1_2 and TLSv1_3."
fn spec.forProvider.sslProfile.sslPolicy.withPolicyName
withPolicyName(policyName)
"The Name of the Policy e.g AppGwSslPolicy20170401S. Required if policy_type is set to Predefined. Possible values can change over time and are published here https://docs.microsoft.com/azure/application-gateway/application-gateway-ssl-policy-overview. Not compatible with disabled_protocols."
fn spec.forProvider.sslProfile.sslPolicy.withPolicyType
withPolicyType(policyType)
"The Type of the Policy. Possible values are Predefined, Custom and CustomV2."
obj spec.forProvider.trustedClientCertificate
"One or more trusted_client_certificate blocks as defined below."
fn spec.forProvider.trustedClientCertificate.withName
withName(name)
"The name of the Trusted Client Certificate that is unique within this Application Gateway."
obj spec.forProvider.trustedClientCertificate.dataSecretRef
"The base-64 encoded certificate."
fn spec.forProvider.trustedClientCertificate.dataSecretRef.withKey
withKey(key)
"The key to select."
fn spec.forProvider.trustedClientCertificate.dataSecretRef.withName
withName(name)
"Name of the secret."
fn spec.forProvider.trustedClientCertificate.dataSecretRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."
obj spec.forProvider.trustedRootCertificate
"One or more trusted_root_certificate blocks as defined below."
fn spec.forProvider.trustedRootCertificate.withKeyVaultSecretId
withKeyVaultSecretId(keyVaultSecretId)
"The Secret ID of (base-64 encoded unencrypted pfx) Secret or Certificate object stored in Azure KeyVault. You need to enable soft delete for the Key Vault to use this feature. Required if data is not set."
fn spec.forProvider.trustedRootCertificate.withName
withName(name)
"The Name of the Trusted Root Certificate to use."
obj spec.forProvider.trustedRootCertificate.dataSecretRef
"The contents of the Trusted Root Certificate which should be used. Required if key_vault_secret_id is not set."
fn spec.forProvider.trustedRootCertificate.dataSecretRef.withKey
withKey(key)
"The key to select."
fn spec.forProvider.trustedRootCertificate.dataSecretRef.withName
withName(name)
"Name of the secret."
fn spec.forProvider.trustedRootCertificate.dataSecretRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."
obj spec.forProvider.urlPathMap
"One or more url_path_map blocks as defined below."
fn spec.forProvider.urlPathMap.withDefaultBackendAddressPoolName
withDefaultBackendAddressPoolName(defaultBackendAddressPoolName)
"The Name of the Default Backend Address Pool which should be used for this URL Path Map. Cannot be set if default_redirect_configuration_name is set."
fn spec.forProvider.urlPathMap.withDefaultBackendHttpSettingsName
withDefaultBackendHttpSettingsName(defaultBackendHttpSettingsName)
"The Name of the Default Backend HTTP Settings Collection which should be used for this URL Path Map. Cannot be set if default_redirect_configuration_name is set."
fn spec.forProvider.urlPathMap.withDefaultRedirectConfigurationName
withDefaultRedirectConfigurationName(defaultRedirectConfigurationName)
"The Name of the Default Redirect Configuration which should be used for this URL Path Map. Cannot be set if either default_backend_address_pool_name or default_backend_http_settings_name is set."
fn spec.forProvider.urlPathMap.withDefaultRewriteRuleSetName
withDefaultRewriteRuleSetName(defaultRewriteRuleSetName)
"The Name of the Default Rewrite Rule Set which should be used for this URL Path Map. Only valid for v2 SKUs."
fn spec.forProvider.urlPathMap.withName
withName(name)
"The Name of the URL Path Map."
fn spec.forProvider.urlPathMap.withPathRule
withPathRule(pathRule)
"One or more path_rule blocks as defined above."
fn spec.forProvider.urlPathMap.withPathRuleMixin
withPathRuleMixin(pathRule)
"One or more path_rule blocks as defined above."
Note: This function appends passed data to existing values
obj spec.forProvider.urlPathMap.pathRule
"One or more path_rule blocks as defined above."
fn spec.forProvider.urlPathMap.pathRule.withBackendAddressPoolName
withBackendAddressPoolName(backendAddressPoolName)
"The Name of the Backend Address Pool which should be used for this Routing Rule. Cannot be set if redirect_configuration_name is set."
fn spec.forProvider.urlPathMap.pathRule.withBackendHttpSettingsName
withBackendHttpSettingsName(backendHttpSettingsName)
"The Name of the Backend HTTP Settings Collection which should be used for this Routing Rule. Cannot be set if redirect_configuration_name is set."
fn spec.forProvider.urlPathMap.pathRule.withFirewallPolicyId
withFirewallPolicyId(firewallPolicyId)
"The ID of the Web Application Firewall Policy which should be used as a HTTP Listener."
fn spec.forProvider.urlPathMap.pathRule.withName
withName(name)
"The Name of the URL Path Map."
fn spec.forProvider.urlPathMap.pathRule.withPaths
withPaths(paths)
"A list of Paths used in this Path Rule."
fn spec.forProvider.urlPathMap.pathRule.withPathsMixin
withPathsMixin(paths)
"A list of Paths used in this Path Rule."
Note: This function appends passed data to existing values
fn spec.forProvider.urlPathMap.pathRule.withRedirectConfigurationName
withRedirectConfigurationName(redirectConfigurationName)
"The Name of the Redirect Configuration which should be used for this Routing Rule. Cannot be set if either backend_address_pool_name or backend_http_settings_name is set."
fn spec.forProvider.urlPathMap.pathRule.withRewriteRuleSetName
withRewriteRuleSetName(rewriteRuleSetName)
"The Name of the Rewrite Rule Set which should be used for this Routing Rule. Only valid for v2 SKUs."
obj spec.forProvider.wafConfiguration
"A waf_configuration block as defined below."
fn spec.forProvider.wafConfiguration.withDisabledRuleGroup
withDisabledRuleGroup(disabledRuleGroup)
"one or more disabled_rule_group blocks as defined below."
fn spec.forProvider.wafConfiguration.withDisabledRuleGroupMixin
withDisabledRuleGroupMixin(disabledRuleGroup)
"one or more disabled_rule_group blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.wafConfiguration.withEnabled
withEnabled(enabled)
"Is the Web Application Firewall enabled?"
fn spec.forProvider.wafConfiguration.withExclusion
withExclusion(exclusion)
"one or more exclusion blocks as defined below."
fn spec.forProvider.wafConfiguration.withExclusionMixin
withExclusionMixin(exclusion)
"one or more exclusion blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.wafConfiguration.withFileUploadLimitMb
withFileUploadLimitMb(fileUploadLimitMb)
"The File Upload Limit in MB. Accepted values are in the range 1MB to 750MB for the WAF_v2 SKU, and 1MB to 500MB for all other SKUs. Defaults to 100MB."
fn spec.forProvider.wafConfiguration.withFirewallMode
withFirewallMode(firewallMode)
"The Web Application Firewall Mode. Possible values are Detection and Prevention."
fn spec.forProvider.wafConfiguration.withMaxRequestBodySizeKb
withMaxRequestBodySizeKb(maxRequestBodySizeKb)
"The Maximum Request Body Size in KB. Accepted values are in the range 1KB to 128KB. Defaults to 128KB."
fn spec.forProvider.wafConfiguration.withRequestBodyCheck
withRequestBodyCheck(requestBodyCheck)
"Is Request Body Inspection enabled? Defaults to true."
fn spec.forProvider.wafConfiguration.withRuleSetType
withRuleSetType(ruleSetType)
"The Type of the Rule Set used for this Web Application Firewall. Possible values are OWASP and Microsoft_BotManagerRuleSet."
fn spec.forProvider.wafConfiguration.withRuleSetVersion
withRuleSetVersion(ruleSetVersion)
"The Version of the Rule Set used for this Web Application Firewall. Possible values are 0.1, 1.0, 2.2.9, 3.0, 3.1 and 3.2."
obj spec.forProvider.wafConfiguration.disabledRuleGroup
"one or more disabled_rule_group blocks as defined below."
fn spec.forProvider.wafConfiguration.disabledRuleGroup.withRuleGroupName
withRuleGroupName(ruleGroupName)
"The rule group where specific rules should be disabled. Possible values are BadBots, crs_20_protocol_violations, crs_21_protocol_anomalies, crs_23_request_limits, crs_30_http_policy, crs_35_bad_robots, crs_40_generic_attacks, crs_41_sql_injection_attacks, crs_41_xss_attacks, crs_42_tight_security, crs_45_trojans, General, GoodBots, Known-CVEs, REQUEST-911-METHOD-ENFORCEMENT, REQUEST-913-SCANNER-DETECTION, REQUEST-920-PROTOCOL-ENFORCEMENT, REQUEST-921-PROTOCOL-ATTACK, REQUEST-930-APPLICATION-ATTACK-LFI, REQUEST-931-APPLICATION-ATTACK-RFI, REQUEST-932-APPLICATION-ATTACK-RCE, REQUEST-933-APPLICATION-ATTACK-PHP, REQUEST-941-APPLICATION-ATTACK-XSS, REQUEST-942-APPLICATION-ATTACK-SQLI, REQUEST-943-APPLICATION-ATTACK-SESSION-FIXATION, REQUEST-944-APPLICATION-ATTACK-JAVA and UnknownBots."
fn spec.forProvider.wafConfiguration.disabledRuleGroup.withRules
withRules(rules)
"A list of rules which should be disabled in that group. Disables all rules in the specified group if rules is not specified."
fn spec.forProvider.wafConfiguration.disabledRuleGroup.withRulesMixin
withRulesMixin(rules)
"A list of rules which should be disabled in that group. Disables all rules in the specified group if rules is not specified."
Note: This function appends passed data to existing values
obj spec.forProvider.wafConfiguration.exclusion
"one or more exclusion blocks as defined below."
fn spec.forProvider.wafConfiguration.exclusion.withMatchVariable
withMatchVariable(matchVariable)
"Match variable of the exclusion rule to exclude header, cookie or GET arguments. Possible values are RequestArgKeys, RequestArgNames, RequestArgValues, RequestCookieKeys, RequestCookieNames, RequestCookieValues, RequestHeaderKeys, RequestHeaderNames and RequestHeaderValues"
fn spec.forProvider.wafConfiguration.exclusion.withSelector
withSelector(selector)
"String value which will be used for the filter operation. If empty will exclude all traffic on this match_variable"
fn spec.forProvider.wafConfiguration.exclusion.withSelectorMatchOperator
withSelectorMatchOperator(selectorMatchOperator)
"Operator which will be used to search in the variable content. Possible values are Contains, EndsWith, Equals, EqualsAny and StartsWith. If empty will exclude all traffic on this match_variable"
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."