apimanagement.v1beta1.management
"Management is the Schema for the Managements API. Manages an API Management Service."
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 withAdditionalLocation(additionalLocation)
fn withAdditionalLocationMixin(additionalLocation)
fn withCertificate(certificate)
fn withCertificateMixin(certificate)
fn withClientCertificateEnabled(clientCertificateEnabled)
fn withDelegation(delegation)
fn withDelegationMixin(delegation)
fn withGatewayDisabled(gatewayDisabled)
fn withIdentity(identity)
fn withIdentityMixin(identity)
fn withLocation(location)
fn withMinApiVersion(minApiVersion)
fn withNotificationSenderEmail(notificationSenderEmail)
fn withPolicy(policy)
fn withPolicyMixin(policy)
fn withProtocols(protocols)
fn withProtocolsMixin(protocols)
fn withPublicIpAddressId(publicIpAddressId)
fn withPublicNetworkAccessEnabled(publicNetworkAccessEnabled)
fn withPublisherEmail(publisherEmail)
fn withPublisherName(publisherName)
fn withResourceGroupName(resourceGroupName)
fn withSecurity(security)
fn withSecurityMixin(security)
fn withSignIn(signIn)
fn withSignInMixin(signIn)
fn withSignUp(signUp)
fn withSignUpMixin(signUp)
fn withSkuName(skuName)
fn withTags(tags)
fn withTagsMixin(tags)
fn withTenantAccess(tenantAccess)
fn withTenantAccessMixin(tenantAccess)
fn withVirtualNetworkConfiguration(virtualNetworkConfiguration)
fn withVirtualNetworkConfigurationMixin(virtualNetworkConfiguration)
fn withVirtualNetworkType(virtualNetworkType)
fn withZones(zones)
fn withZonesMixin(zones)
obj spec.forProvider.additionalLocation
fn withCapacity(capacity)
fn withGatewayDisabled(gatewayDisabled)
fn withLocation(location)
fn withPublicIpAddressId(publicIpAddressId)
fn withVirtualNetworkConfiguration(virtualNetworkConfiguration)
fn withVirtualNetworkConfigurationMixin(virtualNetworkConfiguration)
fn withZones(zones)
fn withZonesMixin(zones)
obj spec.forProvider.additionalLocation.virtualNetworkConfiguration
obj spec.forProvider.certificate
obj spec.forProvider.delegation
obj spec.forProvider.identity
obj spec.forProvider.policy
obj spec.forProvider.protocols
obj spec.forProvider.resourceGroupNameRef
obj spec.forProvider.resourceGroupNameSelector
obj spec.forProvider.security
fn withEnableBackendSsl30(enableBackendSsl30)
fn withEnableBackendTls10(enableBackendTls10)
fn withEnableBackendTls11(enableBackendTls11)
fn withEnableFrontendSsl30(enableFrontendSsl30)
fn withEnableFrontendTls10(enableFrontendTls10)
fn withEnableFrontendTls11(enableFrontendTls11)
fn withTlsEcdheEcdsaWithAes128CbcShaCiphersEnabled(tlsEcdheEcdsaWithAes128CbcShaCiphersEnabled)
fn withTlsEcdheEcdsaWithAes256CbcShaCiphersEnabled(tlsEcdheEcdsaWithAes256CbcShaCiphersEnabled)
fn withTlsEcdheRsaWithAes128CbcShaCiphersEnabled(tlsEcdheRsaWithAes128CbcShaCiphersEnabled)
fn withTlsEcdheRsaWithAes256CbcShaCiphersEnabled(tlsEcdheRsaWithAes256CbcShaCiphersEnabled)
fn withTlsRsaWithAes128CbcSha256CiphersEnabled(tlsRsaWithAes128CbcSha256CiphersEnabled)
fn withTlsRsaWithAes128CbcShaCiphersEnabled(tlsRsaWithAes128CbcShaCiphersEnabled)
fn withTlsRsaWithAes128GcmSha256CiphersEnabled(tlsRsaWithAes128GcmSha256CiphersEnabled)
fn withTlsRsaWithAes256CbcSha256CiphersEnabled(tlsRsaWithAes256CbcSha256CiphersEnabled)
fn withTlsRsaWithAes256CbcShaCiphersEnabled(tlsRsaWithAes256CbcShaCiphersEnabled)
fn withTlsRsaWithAes256GcmSha384CiphersEnabled(tlsRsaWithAes256GcmSha384CiphersEnabled)
fn withTripleDesCiphersEnabled(tripleDesCiphersEnabled)
obj spec.forProvider.signIn
obj spec.forProvider.signUp
obj spec.forProvider.tenantAccess
obj spec.forProvider.virtualNetworkConfiguration
obj spec.providerConfigRef
obj spec.providerRef
obj spec.publishConnectionDetailsTo
obj spec.writeConnectionSecretToRef
Fields
fn new
new(name)
new returns an instance of Management
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
"ManagementSpec defines the desired state of Management"
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.withAdditionalLocation
withAdditionalLocation(additionalLocation)
"One or more additional_location blocks as defined below."
fn spec.forProvider.withAdditionalLocationMixin
withAdditionalLocationMixin(additionalLocation)
"One or more additional_location blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withCertificate
withCertificate(certificate)
"One or more (up to 10) certificate blocks as defined below."
fn spec.forProvider.withCertificateMixin
withCertificateMixin(certificate)
"One or more (up to 10) certificate blocks as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withClientCertificateEnabled
withClientCertificateEnabled(clientCertificateEnabled)
"Enforce a client certificate to be presented on each request to the gateway? This is only supported when SKU type is Consumption."
fn spec.forProvider.withDelegation
withDelegation(delegation)
"A delegation block as defined below."
fn spec.forProvider.withDelegationMixin
withDelegationMixin(delegation)
"A delegation block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withGatewayDisabled
withGatewayDisabled(gatewayDisabled)
"Disable the gateway in main region? This is only supported when additional_location is set."
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 location where the API Management Service exists. Changing this forces a new resource to be created."
fn spec.forProvider.withMinApiVersion
withMinApiVersion(minApiVersion)
"The version which the control plane API calls to API Management service are limited with version equal to or newer than."
fn spec.forProvider.withNotificationSenderEmail
withNotificationSenderEmail(notificationSenderEmail)
"Email address from which the notification will be sent."
fn spec.forProvider.withPolicy
withPolicy(policy)
"A policy block as defined below."
fn spec.forProvider.withPolicyMixin
withPolicyMixin(policy)
"A policy block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withProtocols
withProtocols(protocols)
"A protocols block as defined below."
fn spec.forProvider.withProtocolsMixin
withProtocolsMixin(protocols)
"A protocols block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withPublicIpAddressId
withPublicIpAddressId(publicIpAddressId)
"ID of a standard SKU IPv4 Public IP."
fn spec.forProvider.withPublicNetworkAccessEnabled
withPublicNetworkAccessEnabled(publicNetworkAccessEnabled)
"Is public access to the service allowed?. Defaults to true"
fn spec.forProvider.withPublisherEmail
withPublisherEmail(publisherEmail)
"The email of publisher/company."
fn spec.forProvider.withPublisherName
withPublisherName(publisherName)
"The name of publisher/company."
fn spec.forProvider.withResourceGroupName
withResourceGroupName(resourceGroupName)
"The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created."
fn spec.forProvider.withSecurity
withSecurity(security)
"A security block as defined below."
fn spec.forProvider.withSecurityMixin
withSecurityMixin(security)
"A security block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withSignIn
withSignIn(signIn)
"A sign_in block as defined below."
fn spec.forProvider.withSignInMixin
withSignInMixin(signIn)
"A sign_in block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withSignUp
withSignUp(signUp)
"A sign_up block as defined below."
fn spec.forProvider.withSignUpMixin
withSignUpMixin(signUp)
"A sign_up block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withSkuName
withSkuName(skuName)
"sku_name is a string consisting of two parts separated by an underscore(_). The first part is the name, valid values include: Consumption, Developer, Basic, Standard and Premium. The second part is the capacity (e.g. the number of deployed units of the sku), which must be a positive integer (e.g. Developer_1)."
fn spec.forProvider.withTags
withTags(tags)
"A mapping of tags assigned to the resource."
fn spec.forProvider.withTagsMixin
withTagsMixin(tags)
"A mapping of tags assigned to the resource."
Note: This function appends passed data to existing values
fn spec.forProvider.withTenantAccess
withTenantAccess(tenantAccess)
"A tenant_access block as defined below."
fn spec.forProvider.withTenantAccessMixin
withTenantAccessMixin(tenantAccess)
"A tenant_access block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withVirtualNetworkConfiguration
withVirtualNetworkConfiguration(virtualNetworkConfiguration)
"A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal."
fn spec.forProvider.withVirtualNetworkConfigurationMixin
withVirtualNetworkConfigurationMixin(virtualNetworkConfiguration)
"A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal."
Note: This function appends passed data to existing values
fn spec.forProvider.withVirtualNetworkType
withVirtualNetworkType(virtualNetworkType)
"The type of virtual network you want to use, valid values include: None, External, Internal."
fn spec.forProvider.withZones
withZones(zones)
"Specifies a list of Availability Zones in which this API Management service should be located. Changing this forces a new API Management service to be created."
fn spec.forProvider.withZonesMixin
withZonesMixin(zones)
"Specifies a list of Availability Zones in which this API Management service should be located. Changing this forces a new API Management service to be created."
Note: This function appends passed data to existing values
obj spec.forProvider.additionalLocation
"One or more additional_location blocks as defined below."
fn spec.forProvider.additionalLocation.withCapacity
withCapacity(capacity)
"The number of compute units in this region. Defaults to the capacity of the main region."
fn spec.forProvider.additionalLocation.withGatewayDisabled
withGatewayDisabled(gatewayDisabled)
"Only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location."
fn spec.forProvider.additionalLocation.withLocation
withLocation(location)
"The name of the Azure Region in which the API Management Service should be expanded to."
fn spec.forProvider.additionalLocation.withPublicIpAddressId
withPublicIpAddressId(publicIpAddressId)
"ID of a standard SKU IPv4 Public IP."
fn spec.forProvider.additionalLocation.withVirtualNetworkConfiguration
withVirtualNetworkConfiguration(virtualNetworkConfiguration)
"A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal."
fn spec.forProvider.additionalLocation.withVirtualNetworkConfigurationMixin
withVirtualNetworkConfigurationMixin(virtualNetworkConfiguration)
"A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal."
Note: This function appends passed data to existing values
fn spec.forProvider.additionalLocation.withZones
withZones(zones)
"A list of availability zones. Changing this forces a new resource to be created."
fn spec.forProvider.additionalLocation.withZonesMixin
withZonesMixin(zones)
"A list of availability zones. Changing this forces a new resource to be created."
Note: This function appends passed data to existing values
obj spec.forProvider.additionalLocation.virtualNetworkConfiguration
"A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal."
fn spec.forProvider.additionalLocation.virtualNetworkConfiguration.withSubnetId
withSubnetId(subnetId)
"The id of the subnet that will be used for the API Management."
obj spec.forProvider.additionalLocation.virtualNetworkConfiguration.subnetIdRef
"Reference to a Subnet in network to populate subnetId."
fn spec.forProvider.additionalLocation.virtualNetworkConfiguration.subnetIdRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.additionalLocation.virtualNetworkConfiguration.subnetIdRef.policy
"Policies for referencing."
fn spec.forProvider.additionalLocation.virtualNetworkConfiguration.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.additionalLocation.virtualNetworkConfiguration.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.additionalLocation.virtualNetworkConfiguration.subnetIdSelector
"Selector for a Subnet in network to populate subnetId."
fn spec.forProvider.additionalLocation.virtualNetworkConfiguration.subnetIdSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.additionalLocation.virtualNetworkConfiguration.subnetIdSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.additionalLocation.virtualNetworkConfiguration.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.additionalLocation.virtualNetworkConfiguration.subnetIdSelector.policy
"Policies for selection."
fn spec.forProvider.additionalLocation.virtualNetworkConfiguration.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.additionalLocation.virtualNetworkConfiguration.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.certificate
"One or more (up to 10) certificate blocks as defined below."
fn spec.forProvider.certificate.withStoreName
withStoreName(storeName)
"The name of the Certificate Store where this certificate should be stored. Possible values are CertificateAuthority and Root."
obj spec.forProvider.certificate.certificatePasswordSecretRef
"The password for the certificate."
fn spec.forProvider.certificate.certificatePasswordSecretRef.withKey
withKey(key)
"The key to select."
fn spec.forProvider.certificate.certificatePasswordSecretRef.withName
withName(name)
"Name of the secret."
fn spec.forProvider.certificate.certificatePasswordSecretRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."
obj spec.forProvider.certificate.encodedCertificateSecretRef
"The Base64 Encoded PFX or Base64 Encoded X.509 Certificate."
fn spec.forProvider.certificate.encodedCertificateSecretRef.withKey
withKey(key)
"The key to select."
fn spec.forProvider.certificate.encodedCertificateSecretRef.withName
withName(name)
"Name of the secret."
fn spec.forProvider.certificate.encodedCertificateSecretRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."
obj spec.forProvider.delegation
"A delegation block as defined below."
fn spec.forProvider.delegation.withSubscriptionsEnabled
withSubscriptionsEnabled(subscriptionsEnabled)
"Should subscription requests be delegated to an external url? Defaults to false."
fn spec.forProvider.delegation.withUrl
withUrl(url)
"The delegation URL."
fn spec.forProvider.delegation.withUserRegistrationEnabled
withUserRegistrationEnabled(userRegistrationEnabled)
"Should user registration requests be delegated to an external url? Defaults to false."
obj spec.forProvider.delegation.validationKeySecretRef
"A base64-encoded validation key to validate, that a request is coming from Azure API Management."
fn spec.forProvider.delegation.validationKeySecretRef.withKey
withKey(key)
"The key to select."
fn spec.forProvider.delegation.validationKeySecretRef.withName
withName(name)
"Name of the secret."
fn spec.forProvider.delegation.validationKeySecretRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."
obj spec.forProvider.identity
"An identity block as defined below."
fn spec.forProvider.identity.withIdentityIds
withIdentityIds(identityIds)
"A list of User Assigned Managed Identity IDs to be assigned to this API Management Service."
fn spec.forProvider.identity.withIdentityIdsMixin
withIdentityIdsMixin(identityIds)
"A list of User Assigned Managed Identity IDs to be assigned to this API Management Service."
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 API Management Service. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both)."
obj spec.forProvider.policy
"A policy block as defined below."
fn spec.forProvider.policy.withXmlContent
withXmlContent(xmlContent)
"The XML Content for this Policy."
fn spec.forProvider.policy.withXmlLink
withXmlLink(xmlLink)
"A link to an API Management Policy XML Document, which must be publicly available."
obj spec.forProvider.protocols
"A protocols block as defined below."
fn spec.forProvider.protocols.withEnableHttp2
withEnableHttp2(enableHttp2)
"Should HTTP/2 be supported by the API Management Service? Defaults to false."
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.security
"A security block as defined below."
fn spec.forProvider.security.withEnableBackendSsl30
withEnableBackendSsl30(enableBackendSsl30)
"Should SSL 3.0 be enabled on the backend of the gateway? Defaults to false."
fn spec.forProvider.security.withEnableBackendTls10
withEnableBackendTls10(enableBackendTls10)
"Should TLS 1.0 be enabled on the backend of the gateway? Defaults to false."
fn spec.forProvider.security.withEnableBackendTls11
withEnableBackendTls11(enableBackendTls11)
"Should TLS 1.1 be enabled on the backend of the gateway? Defaults to false."
fn spec.forProvider.security.withEnableFrontendSsl30
withEnableFrontendSsl30(enableFrontendSsl30)
"Should SSL 3.0 be enabled on the frontend of the gateway? Defaults to false."
fn spec.forProvider.security.withEnableFrontendTls10
withEnableFrontendTls10(enableFrontendTls10)
"Should TLS 1.0 be enabled on the frontend of the gateway? Defaults to false."
fn spec.forProvider.security.withEnableFrontendTls11
withEnableFrontendTls11(enableFrontendTls11)
"Should TLS 1.1 be enabled on the frontend of the gateway? Defaults to false."
fn spec.forProvider.security.withTlsEcdheEcdsaWithAes128CbcShaCiphersEnabled
withTlsEcdheEcdsaWithAes128CbcShaCiphersEnabled(tlsEcdheEcdsaWithAes128CbcShaCiphersEnabled)
"Should the TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false."
fn spec.forProvider.security.withTlsEcdheEcdsaWithAes256CbcShaCiphersEnabled
withTlsEcdheEcdsaWithAes256CbcShaCiphersEnabled(tlsEcdheEcdsaWithAes256CbcShaCiphersEnabled)
"Should the TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false."
fn spec.forProvider.security.withTlsEcdheRsaWithAes128CbcShaCiphersEnabled
withTlsEcdheRsaWithAes128CbcShaCiphersEnabled(tlsEcdheRsaWithAes128CbcShaCiphersEnabled)
"Should the TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false."
fn spec.forProvider.security.withTlsEcdheRsaWithAes256CbcShaCiphersEnabled
withTlsEcdheRsaWithAes256CbcShaCiphersEnabled(tlsEcdheRsaWithAes256CbcShaCiphersEnabled)
"Should the TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false."
fn spec.forProvider.security.withTlsRsaWithAes128CbcSha256CiphersEnabled
withTlsRsaWithAes128CbcSha256CiphersEnabled(tlsRsaWithAes128CbcSha256CiphersEnabled)
"Should the TLS_RSA_WITH_AES_128_CBC_SHA256 cipher be enabled? Defaults to false."
fn spec.forProvider.security.withTlsRsaWithAes128CbcShaCiphersEnabled
withTlsRsaWithAes128CbcShaCiphersEnabled(tlsRsaWithAes128CbcShaCiphersEnabled)
"Should the TLS_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false."
fn spec.forProvider.security.withTlsRsaWithAes128GcmSha256CiphersEnabled
withTlsRsaWithAes128GcmSha256CiphersEnabled(tlsRsaWithAes128GcmSha256CiphersEnabled)
"Should the TLS_RSA_WITH_AES_128_GCM_SHA256 cipher be enabled? Defaults to false."
fn spec.forProvider.security.withTlsRsaWithAes256CbcSha256CiphersEnabled
withTlsRsaWithAes256CbcSha256CiphersEnabled(tlsRsaWithAes256CbcSha256CiphersEnabled)
"Should the TLS_RSA_WITH_AES_256_CBC_SHA256 cipher be enabled? Defaults to false."
fn spec.forProvider.security.withTlsRsaWithAes256CbcShaCiphersEnabled
withTlsRsaWithAes256CbcShaCiphersEnabled(tlsRsaWithAes256CbcShaCiphersEnabled)
"Should the TLS_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false."
fn spec.forProvider.security.withTlsRsaWithAes256GcmSha384CiphersEnabled
withTlsRsaWithAes256GcmSha384CiphersEnabled(tlsRsaWithAes256GcmSha384CiphersEnabled)
"Should the TLS_RSA_WITH_AES_256_GCM_SHA384 cipher be enabled? Defaults to false."
fn spec.forProvider.security.withTripleDesCiphersEnabled
withTripleDesCiphersEnabled(tripleDesCiphersEnabled)
"Should the TLS_RSA_WITH_3DES_EDE_CBC_SHA cipher be enabled for alL TLS versions (1.0, 1.1 and 1.2)?"
obj spec.forProvider.signIn
"A sign_in block as defined below."
fn spec.forProvider.signIn.withEnabled
withEnabled(enabled)
"Should anonymous users be redirected to the sign in page?"
obj spec.forProvider.signUp
"A sign_up block as defined below."
fn spec.forProvider.signUp.withEnabled
withEnabled(enabled)
"Can users sign up on the development portal?"
fn spec.forProvider.signUp.withTermsOfService
withTermsOfService(termsOfService)
"A terms_of_service block as defined below."
fn spec.forProvider.signUp.withTermsOfServiceMixin
withTermsOfServiceMixin(termsOfService)
"A terms_of_service block as defined below."
Note: This function appends passed data to existing values
obj spec.forProvider.signUp.termsOfService
"A terms_of_service block as defined below."
fn spec.forProvider.signUp.termsOfService.withConsentRequired
withConsentRequired(consentRequired)
"Should the user be asked for consent during sign up?"
fn spec.forProvider.signUp.termsOfService.withEnabled
withEnabled(enabled)
"Should Terms of Service be displayed during sign up?."
fn spec.forProvider.signUp.termsOfService.withText
withText(text)
"The Terms of Service which users are required to agree to in order to sign up."
obj spec.forProvider.tenantAccess
"A tenant_access block as defined below."
fn spec.forProvider.tenantAccess.withEnabled
withEnabled(enabled)
"Should the access to the management API be enabled?"
obj spec.forProvider.virtualNetworkConfiguration
"A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal."
fn spec.forProvider.virtualNetworkConfiguration.withSubnetId
withSubnetId(subnetId)
"The id of the subnet that will be used for the API Management."
obj spec.forProvider.virtualNetworkConfiguration.subnetIdRef
"Reference to a Subnet in network to populate subnetId."
fn spec.forProvider.virtualNetworkConfiguration.subnetIdRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.virtualNetworkConfiguration.subnetIdRef.policy
"Policies for referencing."
fn spec.forProvider.virtualNetworkConfiguration.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.virtualNetworkConfiguration.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.virtualNetworkConfiguration.subnetIdSelector
"Selector for a Subnet in network to populate subnetId."
fn spec.forProvider.virtualNetworkConfiguration.subnetIdSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.virtualNetworkConfiguration.subnetIdSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.virtualNetworkConfiguration.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.virtualNetworkConfiguration.subnetIdSelector.policy
"Policies for selection."
fn spec.forProvider.virtualNetworkConfiguration.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.virtualNetworkConfiguration.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.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."