Skip to content

eventgrid.v1beta1.eventSubscription

"EventSubscription is the Schema for the EventSubscriptions API. Manages an EventGrid Event Subscription"

Index

Fields

fn new

new(name)

new returns an instance of EventSubscription

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"

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

"EventSubscriptionSpec defines the desired state of EventSubscription"

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

withAdvancedFilter(advancedFilter)

"A advanced_filter block as defined below."

fn spec.forProvider.withAdvancedFilterMixin

withAdvancedFilterMixin(advancedFilter)

"A advanced_filter block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withAdvancedFilteringOnArraysEnabled

withAdvancedFilteringOnArraysEnabled(advancedFilteringOnArraysEnabled)

"Specifies whether advanced filters should be evaluated against an array of values instead of expecting a singular value. Defaults to false."

fn spec.forProvider.withAzureFunctionEndpoint

withAzureFunctionEndpoint(azureFunctionEndpoint)

"An azure_function_endpoint block as defined below."

fn spec.forProvider.withAzureFunctionEndpointMixin

withAzureFunctionEndpointMixin(azureFunctionEndpoint)

"An azure_function_endpoint block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withDeadLetterIdentity

withDeadLetterIdentity(deadLetterIdentity)

"A dead_letter_identity block as defined below."

fn spec.forProvider.withDeadLetterIdentityMixin

withDeadLetterIdentityMixin(deadLetterIdentity)

"A dead_letter_identity block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withDeliveryIdentity

withDeliveryIdentity(deliveryIdentity)

"A delivery_identity block as defined below."

fn spec.forProvider.withDeliveryIdentityMixin

withDeliveryIdentityMixin(deliveryIdentity)

"A delivery_identity block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withDeliveryProperty

withDeliveryProperty(deliveryProperty)

"One or more delivery_property blocks as defined below."

fn spec.forProvider.withDeliveryPropertyMixin

withDeliveryPropertyMixin(deliveryProperty)

"One or more delivery_property blocks as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withEventDeliverySchema

withEventDeliverySchema(eventDeliverySchema)

"Specifies the event delivery schema for the event subscription. Possible values include: EventGridSchema, CloudEventSchemaV1_0, CustomInputSchema. Defaults to EventGridSchema. Changing this forces a new resource to be created."

fn spec.forProvider.withEventhubEndpointId

withEventhubEndpointId(eventhubEndpointId)

"Specifies the id where the Event Hub is located."

fn spec.forProvider.withExpirationTimeUtc

withExpirationTimeUtc(expirationTimeUtc)

"Specifies the expiration time of the event subscription (Datetime Format RFC 3339)."

fn spec.forProvider.withHybridConnectionEndpointId

withHybridConnectionEndpointId(hybridConnectionEndpointId)

"Specifies the id where the Hybrid Connection is located."

fn spec.forProvider.withIncludedEventTypes

withIncludedEventTypes(includedEventTypes)

"A list of applicable event types that need to be part of the event subscription."

fn spec.forProvider.withIncludedEventTypesMixin

withIncludedEventTypesMixin(includedEventTypes)

"A list of applicable event types that need to be part of the event subscription."

Note: This function appends passed data to existing values

fn spec.forProvider.withLabels

withLabels(labels)

"A list of labels to assign to the event subscription."

fn spec.forProvider.withLabelsMixin

withLabelsMixin(labels)

"A list of labels to assign to the event subscription."

Note: This function appends passed data to existing values

fn spec.forProvider.withName

withName(name)

"Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created."

fn spec.forProvider.withRetryPolicy

withRetryPolicy(retryPolicy)

"A retry_policy block as defined below."

fn spec.forProvider.withRetryPolicyMixin

withRetryPolicyMixin(retryPolicy)

"A retry_policy block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withScope

withScope(scope)

"Specifies the scope at which the EventGrid Event Subscription should be created. Changing this forces a new resource to be created."

fn spec.forProvider.withServiceBusQueueEndpointId

withServiceBusQueueEndpointId(serviceBusQueueEndpointId)

"Specifies the id where the Service Bus Queue is located."

fn spec.forProvider.withServiceBusTopicEndpointId

withServiceBusTopicEndpointId(serviceBusTopicEndpointId)

"Specifies the id where the Service Bus Topic is located."

fn spec.forProvider.withStorageBlobDeadLetterDestination

withStorageBlobDeadLetterDestination(storageBlobDeadLetterDestination)

"A storage_blob_dead_letter_destination block as defined below."

fn spec.forProvider.withStorageBlobDeadLetterDestinationMixin

withStorageBlobDeadLetterDestinationMixin(storageBlobDeadLetterDestination)

"A storage_blob_dead_letter_destination block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withStorageQueueEndpoint

withStorageQueueEndpoint(storageQueueEndpoint)

"A storage_queue_endpoint block as defined below."

fn spec.forProvider.withStorageQueueEndpointMixin

withStorageQueueEndpointMixin(storageQueueEndpoint)

"A storage_queue_endpoint block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withSubjectFilter

withSubjectFilter(subjectFilter)

"A subject_filter block as defined below."

fn spec.forProvider.withSubjectFilterMixin

withSubjectFilterMixin(subjectFilter)

"A subject_filter block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withWebhookEndpoint

withWebhookEndpoint(webhookEndpoint)

"A webhook_endpoint block as defined below."

fn spec.forProvider.withWebhookEndpointMixin

withWebhookEndpointMixin(webhookEndpoint)

"A webhook_endpoint block as defined below."

Note: This function appends passed data to existing values

obj spec.forProvider.advancedFilter

"A advanced_filter block as defined below."

fn spec.forProvider.advancedFilter.withBoolEquals

withBoolEquals(boolEquals)

"Compares a value of an event using a single boolean value."

fn spec.forProvider.advancedFilter.withBoolEqualsMixin

withBoolEqualsMixin(boolEquals)

"Compares a value of an event using a single boolean value."

Note: This function appends passed data to existing values

fn spec.forProvider.advancedFilter.withIsNotNull

withIsNotNull(isNotNull)

"Evaluates if a value of an event isn't NULL or undefined."

fn spec.forProvider.advancedFilter.withIsNotNullMixin

withIsNotNullMixin(isNotNull)

"Evaluates if a value of an event isn't NULL or undefined."

Note: This function appends passed data to existing values

fn spec.forProvider.advancedFilter.withIsNullOrUndefined

withIsNullOrUndefined(isNullOrUndefined)

"Evaluates if a value of an event is NULL or undefined."

fn spec.forProvider.advancedFilter.withIsNullOrUndefinedMixin

withIsNullOrUndefinedMixin(isNullOrUndefined)

"Evaluates if a value of an event is NULL or undefined."

Note: This function appends passed data to existing values

fn spec.forProvider.advancedFilter.withNumberGreaterThan

withNumberGreaterThan(numberGreaterThan)

"Compares a value of an event using a single floating point number."

fn spec.forProvider.advancedFilter.withNumberGreaterThanMixin

withNumberGreaterThanMixin(numberGreaterThan)

"Compares a value of an event using a single floating point number."

Note: This function appends passed data to existing values

fn spec.forProvider.advancedFilter.withNumberGreaterThanOrEquals

withNumberGreaterThanOrEquals(numberGreaterThanOrEquals)

"Compares a value of an event using a single floating point number."

fn spec.forProvider.advancedFilter.withNumberGreaterThanOrEqualsMixin

withNumberGreaterThanOrEqualsMixin(numberGreaterThanOrEquals)

"Compares a value of an event using a single floating point number."

Note: This function appends passed data to existing values

fn spec.forProvider.advancedFilter.withNumberIn

withNumberIn(numberIn)

"Compares a value of an event using multiple floating point numbers."

fn spec.forProvider.advancedFilter.withNumberInMixin

withNumberInMixin(numberIn)

"Compares a value of an event using multiple floating point numbers."

Note: This function appends passed data to existing values

fn spec.forProvider.advancedFilter.withNumberInRange

withNumberInRange(numberInRange)

"Compares a value of an event using multiple floating point number ranges."

fn spec.forProvider.advancedFilter.withNumberInRangeMixin

withNumberInRangeMixin(numberInRange)

"Compares a value of an event using multiple floating point number ranges."

Note: This function appends passed data to existing values

fn spec.forProvider.advancedFilter.withNumberLessThan

withNumberLessThan(numberLessThan)

"Compares a value of an event using a single floating point number."

fn spec.forProvider.advancedFilter.withNumberLessThanMixin

withNumberLessThanMixin(numberLessThan)

"Compares a value of an event using a single floating point number."

Note: This function appends passed data to existing values

fn spec.forProvider.advancedFilter.withNumberLessThanOrEquals

withNumberLessThanOrEquals(numberLessThanOrEquals)

"Compares a value of an event using a single floating point number."

fn spec.forProvider.advancedFilter.withNumberLessThanOrEqualsMixin

withNumberLessThanOrEqualsMixin(numberLessThanOrEquals)

"Compares a value of an event using a single floating point number."

Note: This function appends passed data to existing values

fn spec.forProvider.advancedFilter.withNumberNotIn

withNumberNotIn(numberNotIn)

"Compares a value of an event using multiple floating point numbers."

fn spec.forProvider.advancedFilter.withNumberNotInMixin

withNumberNotInMixin(numberNotIn)

"Compares a value of an event using multiple floating point numbers."

Note: This function appends passed data to existing values

fn spec.forProvider.advancedFilter.withNumberNotInRange

withNumberNotInRange(numberNotInRange)

"Compares a value of an event using multiple floating point number ranges."

fn spec.forProvider.advancedFilter.withNumberNotInRangeMixin

withNumberNotInRangeMixin(numberNotInRange)

"Compares a value of an event using multiple floating point number ranges."

Note: This function appends passed data to existing values

fn spec.forProvider.advancedFilter.withStringBeginsWith

withStringBeginsWith(stringBeginsWith)

"Compares a value of an event using multiple string values."

fn spec.forProvider.advancedFilter.withStringBeginsWithMixin

withStringBeginsWithMixin(stringBeginsWith)

"Compares a value of an event using multiple string values."

Note: This function appends passed data to existing values

fn spec.forProvider.advancedFilter.withStringContains

withStringContains(stringContains)

"Compares a value of an event using multiple string values."

fn spec.forProvider.advancedFilter.withStringContainsMixin

withStringContainsMixin(stringContains)

"Compares a value of an event using multiple string values."

Note: This function appends passed data to existing values

fn spec.forProvider.advancedFilter.withStringEndsWith

withStringEndsWith(stringEndsWith)

"Compares a value of an event using multiple string values."

fn spec.forProvider.advancedFilter.withStringEndsWithMixin

withStringEndsWithMixin(stringEndsWith)

"Compares a value of an event using multiple string values."

Note: This function appends passed data to existing values

fn spec.forProvider.advancedFilter.withStringIn

withStringIn(stringIn)

"Compares a value of an event using multiple string values."

fn spec.forProvider.advancedFilter.withStringInMixin

withStringInMixin(stringIn)

"Compares a value of an event using multiple string values."

Note: This function appends passed data to existing values

fn spec.forProvider.advancedFilter.withStringNotBeginsWith

withStringNotBeginsWith(stringNotBeginsWith)

"Compares a value of an event using multiple string values."

fn spec.forProvider.advancedFilter.withStringNotBeginsWithMixin

withStringNotBeginsWithMixin(stringNotBeginsWith)

"Compares a value of an event using multiple string values."

Note: This function appends passed data to existing values

fn spec.forProvider.advancedFilter.withStringNotContains

withStringNotContains(stringNotContains)

"Compares a value of an event using multiple string values."

fn spec.forProvider.advancedFilter.withStringNotContainsMixin

withStringNotContainsMixin(stringNotContains)

"Compares a value of an event using multiple string values."

Note: This function appends passed data to existing values

fn spec.forProvider.advancedFilter.withStringNotEndsWith

withStringNotEndsWith(stringNotEndsWith)

"Compares a value of an event using multiple string values."

fn spec.forProvider.advancedFilter.withStringNotEndsWithMixin

withStringNotEndsWithMixin(stringNotEndsWith)

"Compares a value of an event using multiple string values."

Note: This function appends passed data to existing values

fn spec.forProvider.advancedFilter.withStringNotIn

withStringNotIn(stringNotIn)

"Compares a value of an event using multiple string values."

fn spec.forProvider.advancedFilter.withStringNotInMixin

withStringNotInMixin(stringNotIn)

"Compares a value of an event using multiple string values."

Note: This function appends passed data to existing values

obj spec.forProvider.advancedFilter.boolEquals

"Compares a value of an event using a single boolean value."

fn spec.forProvider.advancedFilter.boolEquals.withKey

withKey(key)

"Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string."

fn spec.forProvider.advancedFilter.boolEquals.withValue

withValue(value)

"Specifies a single value to compare to when using a single value operator."

obj spec.forProvider.advancedFilter.isNotNull

"Evaluates if a value of an event isn't NULL or undefined."

fn spec.forProvider.advancedFilter.isNotNull.withKey

withKey(key)

"Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string."

obj spec.forProvider.advancedFilter.isNullOrUndefined

"Evaluates if a value of an event is NULL or undefined."

fn spec.forProvider.advancedFilter.isNullOrUndefined.withKey

withKey(key)

"Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string."

obj spec.forProvider.advancedFilter.numberGreaterThan

"Compares a value of an event using a single floating point number."

fn spec.forProvider.advancedFilter.numberGreaterThan.withKey

withKey(key)

"Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string."

fn spec.forProvider.advancedFilter.numberGreaterThan.withValue

withValue(value)

"Specifies a single value to compare to when using a single value operator."

obj spec.forProvider.advancedFilter.numberGreaterThanOrEquals

"Compares a value of an event using a single floating point number."

fn spec.forProvider.advancedFilter.numberGreaterThanOrEquals.withKey

withKey(key)

"Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string."

fn spec.forProvider.advancedFilter.numberGreaterThanOrEquals.withValue

withValue(value)

"Specifies a single value to compare to when using a single value operator."

obj spec.forProvider.advancedFilter.numberIn

"Compares a value of an event using multiple floating point numbers."

fn spec.forProvider.advancedFilter.numberIn.withKey

withKey(key)

"Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string."

fn spec.forProvider.advancedFilter.numberIn.withValues

withValues(values)

"Specifies an array of values to compare to when using a multiple values operator."

fn spec.forProvider.advancedFilter.numberIn.withValuesMixin

withValuesMixin(values)

"Specifies an array of values to compare to when using a multiple values operator."

Note: This function appends passed data to existing values

obj spec.forProvider.advancedFilter.numberInRange

"Compares a value of an event using multiple floating point number ranges."

fn spec.forProvider.advancedFilter.numberInRange.withKey

withKey(key)

"Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string."

fn spec.forProvider.advancedFilter.numberInRange.withValues

withValues(values)

"Specifies an array of values to compare to when using a multiple values operator."

fn spec.forProvider.advancedFilter.numberInRange.withValuesMixin

withValuesMixin(values)

"Specifies an array of values to compare to when using a multiple values operator."

Note: This function appends passed data to existing values

obj spec.forProvider.advancedFilter.numberLessThan

"Compares a value of an event using a single floating point number."

fn spec.forProvider.advancedFilter.numberLessThan.withKey

withKey(key)

"Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string."

fn spec.forProvider.advancedFilter.numberLessThan.withValue

withValue(value)

"Specifies a single value to compare to when using a single value operator."

obj spec.forProvider.advancedFilter.numberLessThanOrEquals

"Compares a value of an event using a single floating point number."

fn spec.forProvider.advancedFilter.numberLessThanOrEquals.withKey

withKey(key)

"Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string."

fn spec.forProvider.advancedFilter.numberLessThanOrEquals.withValue

withValue(value)

"Specifies a single value to compare to when using a single value operator."

obj spec.forProvider.advancedFilter.numberNotIn

"Compares a value of an event using multiple floating point numbers."

fn spec.forProvider.advancedFilter.numberNotIn.withKey

withKey(key)

"Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string."

fn spec.forProvider.advancedFilter.numberNotIn.withValues

withValues(values)

"Specifies an array of values to compare to when using a multiple values operator."

fn spec.forProvider.advancedFilter.numberNotIn.withValuesMixin

withValuesMixin(values)

"Specifies an array of values to compare to when using a multiple values operator."

Note: This function appends passed data to existing values

obj spec.forProvider.advancedFilter.numberNotInRange

"Compares a value of an event using multiple floating point number ranges."

fn spec.forProvider.advancedFilter.numberNotInRange.withKey

withKey(key)

"Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string."

fn spec.forProvider.advancedFilter.numberNotInRange.withValues

withValues(values)

"Specifies an array of values to compare to when using a multiple values operator."

fn spec.forProvider.advancedFilter.numberNotInRange.withValuesMixin

withValuesMixin(values)

"Specifies an array of values to compare to when using a multiple values operator."

Note: This function appends passed data to existing values

obj spec.forProvider.advancedFilter.stringBeginsWith

"Compares a value of an event using multiple string values."

fn spec.forProvider.advancedFilter.stringBeginsWith.withKey

withKey(key)

"Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string."

fn spec.forProvider.advancedFilter.stringBeginsWith.withValues

withValues(values)

"Specifies an array of values to compare to when using a multiple values operator."

fn spec.forProvider.advancedFilter.stringBeginsWith.withValuesMixin

withValuesMixin(values)

"Specifies an array of values to compare to when using a multiple values operator."

Note: This function appends passed data to existing values

obj spec.forProvider.advancedFilter.stringContains

"Compares a value of an event using multiple string values."

fn spec.forProvider.advancedFilter.stringContains.withKey

withKey(key)

"Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string."

fn spec.forProvider.advancedFilter.stringContains.withValues

withValues(values)

"Specifies an array of values to compare to when using a multiple values operator."

fn spec.forProvider.advancedFilter.stringContains.withValuesMixin

withValuesMixin(values)

"Specifies an array of values to compare to when using a multiple values operator."

Note: This function appends passed data to existing values

obj spec.forProvider.advancedFilter.stringEndsWith

"Compares a value of an event using multiple string values."

fn spec.forProvider.advancedFilter.stringEndsWith.withKey

withKey(key)

"Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string."

fn spec.forProvider.advancedFilter.stringEndsWith.withValues

withValues(values)

"Specifies an array of values to compare to when using a multiple values operator."

fn spec.forProvider.advancedFilter.stringEndsWith.withValuesMixin

withValuesMixin(values)

"Specifies an array of values to compare to when using a multiple values operator."

Note: This function appends passed data to existing values

obj spec.forProvider.advancedFilter.stringIn

"Compares a value of an event using multiple string values."

fn spec.forProvider.advancedFilter.stringIn.withKey

withKey(key)

"Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string."

fn spec.forProvider.advancedFilter.stringIn.withValues

withValues(values)

"Specifies an array of values to compare to when using a multiple values operator."

fn spec.forProvider.advancedFilter.stringIn.withValuesMixin

withValuesMixin(values)

"Specifies an array of values to compare to when using a multiple values operator."

Note: This function appends passed data to existing values

obj spec.forProvider.advancedFilter.stringNotBeginsWith

"Compares a value of an event using multiple string values."

fn spec.forProvider.advancedFilter.stringNotBeginsWith.withKey

withKey(key)

"Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string."

fn spec.forProvider.advancedFilter.stringNotBeginsWith.withValues

withValues(values)

"Specifies an array of values to compare to when using a multiple values operator."

fn spec.forProvider.advancedFilter.stringNotBeginsWith.withValuesMixin

withValuesMixin(values)

"Specifies an array of values to compare to when using a multiple values operator."

Note: This function appends passed data to existing values

obj spec.forProvider.advancedFilter.stringNotContains

"Compares a value of an event using multiple string values."

fn spec.forProvider.advancedFilter.stringNotContains.withKey

withKey(key)

"Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string."

fn spec.forProvider.advancedFilter.stringNotContains.withValues

withValues(values)

"Specifies an array of values to compare to when using a multiple values operator."

fn spec.forProvider.advancedFilter.stringNotContains.withValuesMixin

withValuesMixin(values)

"Specifies an array of values to compare to when using a multiple values operator."

Note: This function appends passed data to existing values

obj spec.forProvider.advancedFilter.stringNotEndsWith

"Compares a value of an event using multiple string values."

fn spec.forProvider.advancedFilter.stringNotEndsWith.withKey

withKey(key)

"Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string."

fn spec.forProvider.advancedFilter.stringNotEndsWith.withValues

withValues(values)

"Specifies an array of values to compare to when using a multiple values operator."

fn spec.forProvider.advancedFilter.stringNotEndsWith.withValuesMixin

withValuesMixin(values)

"Specifies an array of values to compare to when using a multiple values operator."

Note: This function appends passed data to existing values

obj spec.forProvider.advancedFilter.stringNotIn

"Compares a value of an event using multiple string values."

fn spec.forProvider.advancedFilter.stringNotIn.withKey

withKey(key)

"Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string."

fn spec.forProvider.advancedFilter.stringNotIn.withValues

withValues(values)

"Specifies an array of values to compare to when using a multiple values operator."

fn spec.forProvider.advancedFilter.stringNotIn.withValuesMixin

withValuesMixin(values)

"Specifies an array of values to compare to when using a multiple values operator."

Note: This function appends passed data to existing values

obj spec.forProvider.azureFunctionEndpoint

"An azure_function_endpoint block as defined below."

fn spec.forProvider.azureFunctionEndpoint.withFunctionId

withFunctionId(functionId)

"Specifies the ID of the Function where the Event Subscription will receive events. This must be the functions ID in format {function_app.id}/functions/{name}."

fn spec.forProvider.azureFunctionEndpoint.withMaxEventsPerBatch

withMaxEventsPerBatch(maxEventsPerBatch)

"Maximum number of events per batch."

fn spec.forProvider.azureFunctionEndpoint.withPreferredBatchSizeInKilobytes

withPreferredBatchSizeInKilobytes(preferredBatchSizeInKilobytes)

"Preferred batch size in Kilobytes."

obj spec.forProvider.deadLetterIdentity

"A dead_letter_identity block as defined below."

fn spec.forProvider.deadLetterIdentity.withType

withType(type)

"Specifies the type of Managed Service Identity that is used for dead lettering. Allowed value is SystemAssigned, UserAssigned."

fn spec.forProvider.deadLetterIdentity.withUserAssignedIdentity

withUserAssignedIdentity(userAssignedIdentity)

"The user identity associated with the resource."

obj spec.forProvider.deliveryIdentity

"A delivery_identity block as defined below."

fn spec.forProvider.deliveryIdentity.withType

withType(type)

"Specifies the type of Managed Service Identity that is used for event delivery. Allowed value is SystemAssigned, UserAssigned."

fn spec.forProvider.deliveryIdentity.withUserAssignedIdentity

withUserAssignedIdentity(userAssignedIdentity)

"The user identity associated with the resource."

obj spec.forProvider.deliveryProperty

"One or more delivery_property blocks as defined below."

fn spec.forProvider.deliveryProperty.withHeaderName

withHeaderName(headerName)

"The name of the header to send on to the destination"

fn spec.forProvider.deliveryProperty.withSecret

withSecret(secret)

"True if the value is a secret and should be protected, otherwise false. If True, then this value won't be returned from Azure API calls"

fn spec.forProvider.deliveryProperty.withSourceField

withSourceField(sourceField)

"If the type is Dynamic, then provide the payload field to be used as the value. Valid source fields differ by subscription type."

fn spec.forProvider.deliveryProperty.withType

withType(type)

"Either Static or Dynamic"

obj spec.forProvider.deliveryProperty.valueSecretRef

"If the type is Static, then provide the value to use"

fn spec.forProvider.deliveryProperty.valueSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.deliveryProperty.valueSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.deliveryProperty.valueSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.retryPolicy

"A retry_policy block as defined below."

fn spec.forProvider.retryPolicy.withEventTimeToLive

withEventTimeToLive(eventTimeToLive)

"Specifies the time to live (in minutes) for events. Supported range is 1 to 1440. See official documentation for more details."

fn spec.forProvider.retryPolicy.withMaxDeliveryAttempts

withMaxDeliveryAttempts(maxDeliveryAttempts)

"Specifies the maximum number of delivery retry attempts for events."

obj spec.forProvider.scopeRef

"Reference to a ResourceGroup in azure to populate scope."

fn spec.forProvider.scopeRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.scopeRef.policy

"Policies for referencing."

fn spec.forProvider.scopeRef.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.scopeRef.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.scopeSelector

"Selector for a ResourceGroup in azure to populate scope."

fn spec.forProvider.scopeSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.scopeSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.scopeSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.scopeSelector.policy

"Policies for selection."

fn spec.forProvider.scopeSelector.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.scopeSelector.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.storageBlobDeadLetterDestination

"A storage_blob_dead_letter_destination block as defined below."

fn spec.forProvider.storageBlobDeadLetterDestination.withStorageAccountId

withStorageAccountId(storageAccountId)

"Specifies the id of the storage account id where the storage blob is located."

fn spec.forProvider.storageBlobDeadLetterDestination.withStorageBlobContainerName

withStorageBlobContainerName(storageBlobContainerName)

"Specifies the name of the Storage blob container that is the destination of the deadletter events."

obj spec.forProvider.storageQueueEndpoint

"A storage_queue_endpoint block as defined below."

fn spec.forProvider.storageQueueEndpoint.withQueueMessageTimeToLiveInSeconds

withQueueMessageTimeToLiveInSeconds(queueMessageTimeToLiveInSeconds)

"Storage queue message time to live in seconds."

fn spec.forProvider.storageQueueEndpoint.withQueueName

withQueueName(queueName)

"Specifies the name of the storage queue where the Event Subscription will receive events."

fn spec.forProvider.storageQueueEndpoint.withStorageAccountId

withStorageAccountId(storageAccountId)

"Specifies the id of the storage account id where the storage queue is located."

obj spec.forProvider.storageQueueEndpoint.queueNameRef

"Reference to a Queue in storage to populate queueName."

fn spec.forProvider.storageQueueEndpoint.queueNameRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.storageQueueEndpoint.queueNameRef.policy

"Policies for referencing."

fn spec.forProvider.storageQueueEndpoint.queueNameRef.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.storageQueueEndpoint.queueNameRef.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.storageQueueEndpoint.queueNameSelector

"Selector for a Queue in storage to populate queueName."

fn spec.forProvider.storageQueueEndpoint.queueNameSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.storageQueueEndpoint.queueNameSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.storageQueueEndpoint.queueNameSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.storageQueueEndpoint.queueNameSelector.policy

"Policies for selection."

fn spec.forProvider.storageQueueEndpoint.queueNameSelector.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.storageQueueEndpoint.queueNameSelector.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.storageQueueEndpoint.storageAccountIdRef

"Reference to a Account in storage to populate storageAccountId."

fn spec.forProvider.storageQueueEndpoint.storageAccountIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.storageQueueEndpoint.storageAccountIdRef.policy

"Policies for referencing."

fn spec.forProvider.storageQueueEndpoint.storageAccountIdRef.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.storageQueueEndpoint.storageAccountIdRef.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.storageQueueEndpoint.storageAccountIdSelector

"Selector for a Account in storage to populate storageAccountId."

fn spec.forProvider.storageQueueEndpoint.storageAccountIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.storageQueueEndpoint.storageAccountIdSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.storageQueueEndpoint.storageAccountIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.storageQueueEndpoint.storageAccountIdSelector.policy

"Policies for selection."

fn spec.forProvider.storageQueueEndpoint.storageAccountIdSelector.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.storageQueueEndpoint.storageAccountIdSelector.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.subjectFilter

"A subject_filter block as defined below."

fn spec.forProvider.subjectFilter.withCaseSensitive

withCaseSensitive(caseSensitive)

"Specifies if subject_begins_with and subject_ends_with case sensitive. This value"

fn spec.forProvider.subjectFilter.withSubjectBeginsWith

withSubjectBeginsWith(subjectBeginsWith)

"A string to filter events for an event subscription based on a resource path prefix."

fn spec.forProvider.subjectFilter.withSubjectEndsWith

withSubjectEndsWith(subjectEndsWith)

"A string to filter events for an event subscription based on a resource path suffix."

obj spec.forProvider.webhookEndpoint

"A webhook_endpoint block as defined below."

fn spec.forProvider.webhookEndpoint.withActiveDirectoryAppIdOrUri

withActiveDirectoryAppIdOrUri(activeDirectoryAppIdOrUri)

"The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests."

fn spec.forProvider.webhookEndpoint.withActiveDirectoryTenantId

withActiveDirectoryTenantId(activeDirectoryTenantId)

"The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests."

fn spec.forProvider.webhookEndpoint.withMaxEventsPerBatch

withMaxEventsPerBatch(maxEventsPerBatch)

"Maximum number of events per batch."

fn spec.forProvider.webhookEndpoint.withPreferredBatchSizeInKilobytes

withPreferredBatchSizeInKilobytes(preferredBatchSizeInKilobytes)

"Preferred batch size in Kilobytes."

fn spec.forProvider.webhookEndpoint.withUrl

withUrl(url)

"Specifies the url of the webhook where the Event Subscription will receive events."

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