API is the Schema for the APIs API. Manages an API within an API Management Service.
Type
CRD
Group
apimanagement.azure.upbound.io
Version
v1beta1
apiVersion: apimanagement.azure.upbound.io/v1beta1
kind: API
APISpec defines the desired state of API
No description provided.
Reference to a Management in apimanagement to populate apiManagementName.
Policies for referencing.
Selector for a Management in apimanagement to populate apiManagementName.
Policies for selection.
A import block as documented below.
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.
An oauth2_authorization block as documented below.
An openid_authentication block as documented below.
How to send token to the server. A list of zero or more methods. Valid values are authorizationHeader and query.
A list of protocols the operations in this API can be invoked. Possible values are http, https, ws, and wss.
Reference to a ResourceGroup in azure to populate resourceGroupName.
Policies for referencing.
Selector for a ResourceGroup in azure to populate resourceGroupName.
Policies for selection.
THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.
A import block as documented below.
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.
An oauth2_authorization block as documented below.
An openid_authentication block as documented below.
How to send token to the server. A list of zero or more methods. Valid values are authorizationHeader and query.
A list of protocols the operations in this API can be invoked. Possible values are http, https, ws, and wss.
THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.
Policies for referencing.
ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef
Policies for referencing.
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.
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.
APIStatus defines the observed state of API.
No description provided.
A import block as documented below.
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.
An oauth2_authorization block as documented below.
An openid_authentication block as documented below.
How to send token to the server. A list of zero or more methods. Valid values are authorizationHeader and query.
A list of protocols the operations in this API can be invoked. Possible values are http, https, ws, and wss.
Conditions of the resource.
api-example
apiVersion: apimanagement.azure.upbound.io/v1beta1
kind: API
metadata:
annotations:
meta.upbound.io/example-id: apimanagement/v1beta1/apitag
labels:
testing.upbound.io/example-name: example
name: api-example
spec:
forProvider:
apiManagementNameSelector:
matchLabels:
testing.upbound.io/example-name: example
displayName: Example API
protocols:
- https
resourceGroupNameSelector:
matchLabels:
testing.upbound.io/example-name: example
revision: "1"
search-api
apiVersion: apimanagement.azure.upbound.io/v1beta1
kind: API
metadata:
annotations:
meta.upbound.io/example-id: apimanagement/v1beta1/productapi
labels:
testing.upbound.io/example-name: example
name: search-api
spec:
forProvider:
apiManagementNameSelector:
matchLabels:
testing.upbound.io/example-name: example
displayName: Example API
protocols:
- https
resourceGroupNameSelector:
matchLabels:
testing.upbound.io/example-name: example
revision: "2"
search-api
apiVersion: apimanagement.azure.upbound.io/v1beta1
kind: API
metadata:
annotations:
meta.upbound.io/example-id: apimanagement/v1beta1/apioperationtag
labels:
testing.upbound.io/example-name: example
name: search-api
spec:
forProvider:
apiManagementNameSelector:
matchLabels:
testing.upbound.io/example-name: example
displayName: Example API
protocols:
- https
resourceGroupNameSelector:
matchLabels:
testing.upbound.io/example-name: example
revision: "2"
example-api
apiVersion: apimanagement.azure.upbound.io/v1beta1
kind: API
metadata:
annotations:
meta.upbound.io/example-id: apimanagement/v1beta1/apirelease
labels:
testing.upbound.io/example-name: example
name: example-api
spec:
forProvider:
apiManagementNameSelector:
matchLabels:
testing.upbound.io/example-name: example
displayName: Example API
import:
- contentFormat: swagger-link-json
contentValue: http://conferenceapi.azurewebsites.net/?format=json
path: example
protocols:
- https
resourceGroupNameSelector:
matchLabels:
testing.upbound.io/example-name: example
revision: "1"
example
apiVersion: apimanagement.azure.upbound.io/v1beta1
kind: API
metadata:
annotations:
meta.upbound.io/example-id: apimanagement/v1beta1/api
labels:
testing.upbound.io/example-name: example
name: example
spec:
forProvider:
apiManagementNameSelector:
matchLabels:
testing.upbound.io/example-name: example
displayName: Example API
import:
- contentFormat: swagger-link-json
contentValue: http://conferenceapi.azurewebsites.net/?format=json
path: example
protocols:
- https
resourceGroupNameSelector:
matchLabels:
testing.upbound.io/example-name: example
revision: "1"
example-api
apiVersion: apimanagement.azure.upbound.io/v1beta1
kind: API
metadata:
annotations:
meta.upbound.io/example-id: apimanagement/v1beta1/apioperationpolicy
labels:
testing.upbound.io/example-name: example
name: example-api
spec:
forProvider:
apiManagementNameSelector:
matchLabels:
testing.upbound.io/example-name: example
displayName: Example API
protocols:
- https
resourceGroupNameSelector:
matchLabels:
testing.upbound.io/example-name: example
revision: "1"
example
apiVersion: apimanagement.azure.upbound.io/v1beta1
kind: API
metadata:
annotations:
meta.upbound.io/example-id: apimanagement/v1beta1/apidiagnostic
labels:
testing.upbound.io/example-name: example
name: example
spec:
forProvider:
apiManagementNameSelector:
matchLabels:
testing.upbound.io/example-name: example
displayName: Example API
import:
- contentFormat: swagger-link-json
contentValue: http://conferenceapi.azurewebsites.net/?format=json
path: example
protocols:
- https
resourceGroupNameSelector:
matchLabels:
testing.upbound.io/example-name: example
revision: "1"
gapiexample
apiVersion: apimanagement.azure.upbound.io/v1beta1
kind: API
metadata:
annotations:
meta.upbound.io/example-id: apimanagement/v1beta1/gatewayapi
labels:
testing.upbound.io/example-name: example
name: gapiexample
spec:
forProvider:
apiManagementNameSelector:
matchLabels:
testing.upbound.io/example-name: example
displayName: Example API
import:
- contentFormat: swagger-link-json
contentValue: http://conferenceapi.azurewebsites.net/?format=json
path: example
protocols:
- https
resourceGroupNameSelector:
matchLabels:
testing.upbound.io/example-name: example
revision: "1"
my-api
apiVersion: apimanagement.azure.upbound.io/v1beta1
kind: API
metadata:
annotations:
meta.upbound.io/example-id: apimanagement/v1beta1/apipolicy
labels:
testing.upbound.io/example-name: example
name: my-api
spec:
forProvider:
apiManagementNameSelector:
matchLabels:
testing.upbound.io/example-name: example
displayName: Example API
protocols:
- https
resourceGroupNameSelector:
matchLabels:
testing.upbound.io/example-name: example
revision: "2"
search-api
apiVersion: apimanagement.azure.upbound.io/v1beta1
kind: API
metadata:
annotations:
meta.upbound.io/example-id: apimanagement/v1beta1/apischema
labels:
testing.upbound.io/example-name: example
name: search-api
spec:
forProvider:
apiManagementNameSelector:
matchLabels:
testing.upbound.io/example-name: example
displayName: Example API
protocols:
- https
resourceGroupNameSelector:
matchLabels:
testing.upbound.io/example-name: example
revision: "2"
example
apiVersion: apimanagement.azure.upbound.io/v1beta1
kind: API
metadata:
annotations:
meta.upbound.io/example-id: apimanagement/v1beta1/apioperation
labels:
testing.upbound.io/example-name: example
name: example
spec:
forProvider:
apiManagementNameSelector:
matchLabels:
testing.upbound.io/example-name: example
displayName: Example API
import:
- contentFormat: swagger-link-json
contentValue: http://conferenceapi.azurewebsites.net/?format=json
path: example
protocols:
- https
resourceGroupNameSelector:
matchLabels:
testing.upbound.io/example-name: example
revision: "1"
© 2022 Upbound, Inc.
Discover the building blocksfor your internal cloud platform.