apimanagement.v1beta1.api

"API is the Schema for the APIs API. Manages an API within an API Management Service."

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of API

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

"APISpec defines the desired state of API"

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

withApiManagementName(apiManagementName)

"The Name of the API Management Service where this API should be created. Changing this forces a new resource to be created."

fn spec.forProvider.withApiType

withApiType(apiType)

"Type of API. Possible values are graphql, http, soap, and websocket. Defaults to http."

fn spec.forProvider.withContact

withContact(contact)

"A contact block as documented below."

fn spec.forProvider.withContactMixin

withContactMixin(contact)

"A contact block as documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withDescription

withDescription(description)

"A description of the API Management API, which may include HTML formatting tags."

fn spec.forProvider.withDisplayName

withDisplayName(displayName)

"The display name of the API."

fn spec.forProvider.withImport

withImport(Import)

"A import block as documented below."

fn spec.forProvider.withImportMixin

withImportMixin(Import)

"A import block as documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withLicense

withLicense(license)

"A license block as documented below."

fn spec.forProvider.withLicenseMixin

withLicenseMixin(license)

"A license block as documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withOauth2Authorization

withOauth2Authorization(oauth2Authorization)

"An oauth2_authorization block as documented below."

fn spec.forProvider.withOauth2AuthorizationMixin

withOauth2AuthorizationMixin(oauth2Authorization)

"An oauth2_authorization block as documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withOpenidAuthentication

withOpenidAuthentication(openidAuthentication)

"An openid_authentication block as documented below."

fn spec.forProvider.withOpenidAuthenticationMixin

withOpenidAuthenticationMixin(openidAuthentication)

"An openid_authentication block as documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withPath

withPath(path)

"The Path for this API Management API, which is a relative URL which uniquely identifies this API and all of its resource paths within the API Management Service."

fn spec.forProvider.withProtocols

withProtocols(protocols)

"A list of protocols the operations in this API can be invoked. Possible values are http, https, ws, and wss."

fn spec.forProvider.withProtocolsMixin

withProtocolsMixin(protocols)

"A list of protocols the operations in this API can be invoked. Possible values are http, https, ws, and wss."

Note: This function appends passed data to existing values

fn spec.forProvider.withResourceGroupName

withResourceGroupName(resourceGroupName)

"The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created."

fn spec.forProvider.withRevision

withRevision(revision)

"The Revision which used for this API. Changing this forces a new resource to be created."

fn spec.forProvider.withRevisionDescription

withRevisionDescription(revisionDescription)

"The description of the API Revision of the API Management API."

fn spec.forProvider.withServiceUrl

withServiceUrl(serviceUrl)

"Absolute URL of the backend service implementing this API."

fn spec.forProvider.withSoapPassThrough

withSoapPassThrough(soapPassThrough)

"Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to false."

fn spec.forProvider.withSourceApiId

withSourceApiId(sourceApiId)

"The API id of the source API, which could be in format azurerm_api_management_api.example.id or in format azurerm_api_management_api.example.id;rev=1"

fn spec.forProvider.withSubscriptionKeyParameterNames

withSubscriptionKeyParameterNames(subscriptionKeyParameterNames)

"A subscription_key_parameter_names block as documented below."

fn spec.forProvider.withSubscriptionKeyParameterNamesMixin

withSubscriptionKeyParameterNamesMixin(subscriptionKeyParameterNames)

"A subscription_key_parameter_names block as documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withSubscriptionRequired

withSubscriptionRequired(subscriptionRequired)

"Should this API require a subscription key? Defaults to true."

fn spec.forProvider.withTermsOfServiceUrl

withTermsOfServiceUrl(termsOfServiceUrl)

"Absolute URL of the Terms of Service for the API."

fn spec.forProvider.withVersion

withVersion(version)

"The Version number of this API, if this API is versioned."

fn spec.forProvider.withVersionDescription

withVersionDescription(versionDescription)

"The description of the API Version of the API Management API."

fn spec.forProvider.withVersionSetId

withVersionSetId(versionSetId)

"The ID of the Version Set which this API is associated with."

obj spec.forProvider.apiManagementNameRef

"Reference to a Management in apimanagement to populate apiManagementName."

fn spec.forProvider.apiManagementNameRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.apiManagementNameRef.policy

"Policies for referencing."

fn spec.forProvider.apiManagementNameRef.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.apiManagementNameRef.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.apiManagementNameSelector

"Selector for a Management in apimanagement to populate apiManagementName."

fn spec.forProvider.apiManagementNameSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.apiManagementNameSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.apiManagementNameSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.apiManagementNameSelector.policy

"Policies for selection."

fn spec.forProvider.apiManagementNameSelector.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.apiManagementNameSelector.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.contact

"A contact block as documented below."

fn spec.forProvider.contact.withEmail

withEmail(email)

"The email address of the contact person/organization."

fn spec.forProvider.contact.withName

withName(name)

"The name of the contact person/organization."

fn spec.forProvider.contact.withUrl

withUrl(url)

"Absolute URL of the contact information."

obj spec.forProvider.import

"A import block as documented below."

fn spec.forProvider.import.withContentFormat

withContentFormat(contentFormat)

"The format of the content from which the API Definition should be imported. Possible values are: openapi, openapi+json, openapi+json-link, openapi-link, swagger-json, swagger-link-json, wadl-link-json, wadl-xml, wsdl and wsdl-link."

fn spec.forProvider.import.withContentValue

withContentValue(contentValue)

"The Content from which the API Definition should be imported. When a content_format of -link- is specified this must be a URL, otherwise this must be defined inline."

fn spec.forProvider.import.withWsdlSelector

withWsdlSelector(wsdlSelector)

"A wsdl_selector block as defined below, which allows you to limit the import of a WSDL to only a subset of the document. This can only be specified when content_format is wsdl or wsdl-link."

fn spec.forProvider.import.withWsdlSelectorMixin

withWsdlSelectorMixin(wsdlSelector)

"A wsdl_selector block as defined below, which allows you to limit the import of a WSDL to only a subset of the document. This can only be specified when content_format is wsdl or wsdl-link."

Note: This function appends passed data to existing values

obj spec.forProvider.import.wsdlSelector

"A wsdl_selector block as defined below, which allows you to limit the import of a WSDL to only a subset of the document. This can only be specified when content_format is wsdl or wsdl-link."

fn spec.forProvider.import.wsdlSelector.withEndpointName

withEndpointName(endpointName)

"The name of endpoint (port) to import from WSDL."

fn spec.forProvider.import.wsdlSelector.withServiceName

withServiceName(serviceName)

"The name of service to import from WSDL."

obj spec.forProvider.license

"A license block as documented below."

fn spec.forProvider.license.withName

withName(name)

"The name of the license ."

fn spec.forProvider.license.withUrl

withUrl(url)

"Absolute URL of the license."

obj spec.forProvider.oauth2Authorization

"An oauth2_authorization block as documented below."

fn spec.forProvider.oauth2Authorization.withAuthorizationServerName

withAuthorizationServerName(authorizationServerName)

"OAuth authorization server identifier. The name of an OAuth2 Authorization Server."

fn spec.forProvider.oauth2Authorization.withScope

withScope(scope)

"Operations scope."

obj spec.forProvider.openidAuthentication

"An openid_authentication block as documented below."

fn spec.forProvider.openidAuthentication.withBearerTokenSendingMethods

withBearerTokenSendingMethods(bearerTokenSendingMethods)

"How to send token to the server. A list of zero or more methods. Valid values are authorizationHeader and query."

fn spec.forProvider.openidAuthentication.withBearerTokenSendingMethodsMixin

withBearerTokenSendingMethodsMixin(bearerTokenSendingMethods)

"How to send token to the server. A list of zero or more methods. Valid values are authorizationHeader and query."

Note: This function appends passed data to existing values

fn spec.forProvider.openidAuthentication.withOpenidProviderName

withOpenidProviderName(openidProviderName)

"OpenID Connect provider identifier. The name of an OpenID Connect Provider."

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

"A subscription_key_parameter_names block as documented below."

fn spec.forProvider.subscriptionKeyParameterNames.withHeader

withHeader(header)

"The name of the HTTP Header which should be used for the Subscription Key."

fn spec.forProvider.subscriptionKeyParameterNames.withQuery

withQuery(query)

"The name of the QueryString parameter which should be used for the Subscription Key."

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