APIOperation is the Schema for the APIOperations API. Manages an API Operation within an API Management Service.
Type
CRD
Group
apimanagement.azure.upbound.io
Version
v1beta1
apiVersion: apimanagement.azure.upbound.io/v1beta1
kind: APIOperation
APIOperationSpec defines the desired state of APIOperation
No description provided.
Reference to a Management to populate apiManagementName.
Policies for referencing.
Selector for a Management to populate apiManagementName.
Policies for selection.
Reference to a API to populate apiName.
Policies for referencing.
Selector for a API to populate apiName.
Policies for selection.
A request block as defined below.
One or more header blocks as defined above.
One or more example blocks as defined above.
One or more acceptable values for this Template Parameter.
One or more query_parameter blocks as defined above.
One or more example blocks as defined above.
One or more acceptable values for this Template Parameter.
One or more representation blocks as defined below.
One or more example blocks as defined above.
One or more form_parameter block as defined above.
One or more example blocks as defined above.
One or more acceptable values for this Template Parameter.
Reference to a ResourceGroup in azure to populate resourceGroupName.
Policies for referencing.
Selector for a ResourceGroup in azure to populate resourceGroupName.
Policies for selection.
One or more response blocks as defined below.
One or more header blocks as defined above.
One or more example blocks as defined above.
One or more acceptable values for this Template Parameter.
One or more representation blocks as defined below.
One or more example blocks as defined above.
One or more form_parameter block as defined above.
One or more example blocks as defined above.
One or more acceptable values for this Template Parameter.
One or more template_parameter blocks as defined below. Required if url_template contains one or more parameters.
One or more example blocks as defined above.
One or more acceptable values for this Template Parameter.
THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. 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 request block as defined below.
One or more header blocks as defined above.
One or more example blocks as defined above.
One or more acceptable values for this Template Parameter.
One or more query_parameter blocks as defined above.
One or more example blocks as defined above.
One or more acceptable values for this Template Parameter.
One or more representation blocks as defined below.
One or more example blocks as defined above.
One or more form_parameter block as defined above.
One or more example blocks as defined above.
One or more acceptable values for this Template Parameter.
One or more response blocks as defined below.
One or more header blocks as defined above.
One or more example blocks as defined above.
One or more acceptable values for this Template Parameter.
One or more representation blocks as defined below.
One or more example blocks as defined above.
One or more form_parameter block as defined above.
One or more example blocks as defined above.
One or more acceptable values for this Template Parameter.
One or more template_parameter blocks as defined below. Required if url_template contains one or more parameters.
One or more example blocks as defined above.
One or more acceptable values for this Template Parameter.
THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. 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.
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.
APIOperationStatus defines the observed state of APIOperation.
No description provided.
A request block as defined below.
One or more header blocks as defined above.
One or more example blocks as defined above.
One or more acceptable values for this Template Parameter.
One or more query_parameter blocks as defined above.
One or more example blocks as defined above.
One or more acceptable values for this Template Parameter.
One or more representation blocks as defined below.
One or more example blocks as defined above.
One or more form_parameter block as defined above.
One or more example blocks as defined above.
One or more acceptable values for this Template Parameter.
One or more response blocks as defined below.
One or more header blocks as defined above.
One or more example blocks as defined above.
One or more acceptable values for this Template Parameter.
One or more representation blocks as defined below.
One or more example blocks as defined above.
One or more form_parameter block as defined above.
One or more example blocks as defined above.
One or more acceptable values for this Template Parameter.
One or more template_parameter blocks as defined below. Required if url_template contains one or more parameters.
One or more example blocks as defined above.
One or more acceptable values for this Template Parameter.
Conditions of the resource.
user-delete
apiVersion: apimanagement.azure.upbound.io/v1beta1
kind: APIOperation
metadata:
annotations:
meta.upbound.io/example-id: apimanagement/v1beta1/apioperationtag
labels:
testing.upbound.io/example-name: example
name: user-delete
spec:
forProvider:
apiManagementNameSelector:
matchLabels:
testing.upbound.io/example-name: example
apiNameSelector:
matchLabels:
testing.upbound.io/example-name: example
description: This can only be done by the logged in user.
displayName: Delete User Operation
method: DELETE
resourceGroupNameSelector:
matchLabels:
testing.upbound.io/example-name: example
response:
- statusCode: 200
urlTemplate: /users/delete
acctest-operation
apiVersion: apimanagement.azure.upbound.io/v1beta1
kind: APIOperation
metadata:
annotations:
meta.upbound.io/example-id: apimanagement/v1beta1/apioperationpolicy
labels:
testing.upbound.io/example-name: example
name: acctest-operation
spec:
forProvider:
apiManagementNameSelector:
matchLabels:
testing.upbound.io/example-name: example
apiNameSelector:
matchLabels:
testing.upbound.io/example-name: example
displayName: DELETE Resource
method: DELETE
resourceGroupNameSelector:
matchLabels:
testing.upbound.io/example-name: example
urlTemplate: /resource
user-delete
apiVersion: apimanagement.azure.upbound.io/v1beta1
kind: APIOperation
metadata:
annotations:
meta.upbound.io/example-id: apimanagement/v1beta1/apioperation
labels:
testing.upbound.io/example-name: example
name: user-delete
spec:
forProvider:
apiManagementNameSelector:
matchLabels:
testing.upbound.io/example-name: example
apiNameSelector:
matchLabels:
testing.upbound.io/example-name: example
description: This can only be done by the logged in user.
displayName: Delete User Operation
method: DELETE
resourceGroupNameSelector:
matchLabels:
testing.upbound.io/example-name: example
response:
- statusCode: 200
urlTemplate: /users/delete
© 2022 Upbound, Inc.
Discover the building blocksfor your internal cloud platform.