eventgrid.azure.com/v1api20200601
APIVersion
| Value | Description |
|---|---|
| “2020-06-01” |
Domain
Generator information: - Generated from: /eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/EventGrid.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}
Used by: DomainList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Domain_Spec Optional |
|
| status | Domain_STATUS Optional |
Domain_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| inboundIpRules | This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. | InboundIpRule[] Optional |
| inputSchema | This determines the format that Event Grid should expect for incoming events published to the domain. | DomainProperties_InputSchema Optional |
| inputSchemaMapping | Information about the InputSchemaMapping which specified the info about mapping event payload. | InputSchemaMapping Optional |
| location | Location of the resource. | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | DomainOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| publicNetworkAccess | This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring |
DomainProperties_PublicNetworkAccess Optional |
| tags | Tags of the resource. | map[string]string Optional |
Domain_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| endpoint | Endpoint for the domain. | string Optional |
| id | Fully qualified identifier of the resource. | string Optional |
| inboundIpRules | This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. | InboundIpRule_STATUS[] Optional |
| inputSchema | This determines the format that Event Grid should expect for incoming events published to the domain. | DomainProperties_InputSchema_STATUS Optional |
| inputSchemaMapping | Information about the InputSchemaMapping which specified the info about mapping event payload. | InputSchemaMapping_STATUS Optional |
| location | Location of the resource. | string Optional |
| metricResourceId | Metric resource id for the domain. | string Optional |
| name | Name of the resource. | string Optional |
| privateEndpointConnections | List of private endpoint connections. | PrivateEndpointConnection_STATUS_Domain_SubResourceEmbedded[] Optional |
| provisioningState | Provisioning state of the domain. | DomainProperties_ProvisioningState_STATUS Optional |
| publicNetworkAccess | This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring |
DomainProperties_PublicNetworkAccess_STATUS Optional |
| systemData | The system metadata relating to Domain resource. | SystemData_STATUS Optional |
| tags | Tags of the resource. | map[string]string Optional |
| type | Type of the resource. | string Optional |
DomainList
Generator information: - Generated from: /eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/EventGrid.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Domain[] Optional |
DomainsTopic
Generator information: - Generated from: /eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/EventGrid.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}
Used by: DomainsTopicList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | DomainsTopic_Spec Optional |
|
| status | DomainsTopic_STATUS Optional |
DomainsTopic_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | DomainsTopicOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a eventgrid.azure.com/Domain resource | genruntime.KnownResourceReference Required |
DomainsTopic_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified identifier of the resource. | string Optional |
| name | Name of the resource. | string Optional |
| provisioningState | Provisioning state of the domain topic. | DomainTopicProperties_ProvisioningState_STATUS Optional |
| systemData | The system metadata relating to Domain Topic resource. | SystemData_STATUS Optional |
| type | Type of the resource. | string Optional |
DomainsTopicList
Generator information: - Generated from: /eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/EventGrid.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | DomainsTopic[] Optional |
EventSubscription
Generator information: - Generated from: /eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/EventGrid.json - ARM URI: /{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}
Used by: EventSubscriptionList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | EventSubscription_Spec Optional |
|
| status | EventSubscription_STATUS Optional |
EventSubscription_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| deadLetterDestination | The DeadLetter destination of the event subscription. | DeadLetterDestination Optional |
| destination | Information about the destination where events have to be delivered for the event subscription. | EventSubscriptionDestination Optional |
| eventDeliverySchema | The event delivery schema for the event subscription. | EventSubscriptionProperties_EventDeliverySchema Optional |
| expirationTimeUtc | Expiration time of the event subscription. | string Optional |
| filter | Information about the filter for the event subscription. | EventSubscriptionFilter Optional |
| labels | List of user defined labels. | string[] Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | EventSubscriptionOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. This resource is an extension resource, which means that any other Azure resource can be its owner. | genruntime.ArbitraryOwnerReference Required |
| retryPolicy | The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. | RetryPolicy Optional |
EventSubscription_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| deadLetterDestination | The DeadLetter destination of the event subscription. | DeadLetterDestination_STATUS Optional |
| destination | Information about the destination where events have to be delivered for the event subscription. | EventSubscriptionDestination_STATUS Optional |
| eventDeliverySchema | The event delivery schema for the event subscription. | EventSubscriptionProperties_EventDeliverySchema_STATUS Optional |
| expirationTimeUtc | Expiration time of the event subscription. | string Optional |
| filter | Information about the filter for the event subscription. | EventSubscriptionFilter_STATUS Optional |
| id | Fully qualified identifier of the resource. | string Optional |
| labels | List of user defined labels. | string[] Optional |
| name | Name of the resource. | string Optional |
| provisioningState | Provisioning state of the event subscription. | EventSubscriptionProperties_ProvisioningState_STATUS Optional |
| retryPolicy | The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. | RetryPolicy_STATUS Optional |
| systemData | The system metadata relating to Event Subscription resource. | SystemData_STATUS Optional |
| topic | Name of the topic of the event subscription. | string Optional |
| type | Type of the resource. | string Optional |
EventSubscriptionList
Generator information: - Generated from: /eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/EventGrid.json - ARM URI: /{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | EventSubscription[] Optional |
Topic
Generator information: - Generated from: /eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/EventGrid.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}
Used by: TopicList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Topic_Spec Optional |
|
| status | Topic_STATUS Optional |
Topic_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| inboundIpRules | This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. | InboundIpRule[] Optional |
| inputSchema | This determines the format that Event Grid should expect for incoming events published to the topic. | TopicProperties_InputSchema Optional |
| inputSchemaMapping | This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema. | InputSchemaMapping Optional |
| location | Location of the resource. | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | TopicOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| publicNetworkAccess | This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring |
TopicProperties_PublicNetworkAccess Optional |
| tags | Tags of the resource. | map[string]string Optional |
Topic_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| endpoint | Endpoint for the topic. | string Optional |
| id | Fully qualified identifier of the resource. | string Optional |
| inboundIpRules | This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. | InboundIpRule_STATUS[] Optional |
| inputSchema | This determines the format that Event Grid should expect for incoming events published to the topic. | TopicProperties_InputSchema_STATUS Optional |
| inputSchemaMapping | This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema. | InputSchemaMapping_STATUS Optional |
| location | Location of the resource. | string Optional |
| metricResourceId | Metric resource id for the topic. | string Optional |
| name | Name of the resource. | string Optional |
| privateEndpointConnections | PrivateEndpointConnection_STATUS_Topic_SubResourceEmbedded[] Optional |
|
| provisioningState | Provisioning state of the topic. | TopicProperties_ProvisioningState_STATUS Optional |
| publicNetworkAccess | This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring |
TopicProperties_PublicNetworkAccess_STATUS Optional |
| systemData | The system metadata relating to Topic resource. | SystemData_STATUS Optional |
| tags | Tags of the resource. | map[string]string Optional |
| type | Type of the resource. | string Optional |
TopicList
Generator information: - Generated from: /eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/EventGrid.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Topic[] Optional |
Domain_Spec
Used by: Domain.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| inboundIpRules | This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. | InboundIpRule[] Optional |
| inputSchema | This determines the format that Event Grid should expect for incoming events published to the domain. | DomainProperties_InputSchema Optional |
| inputSchemaMapping | Information about the InputSchemaMapping which specified the info about mapping event payload. | InputSchemaMapping Optional |
| location | Location of the resource. | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | DomainOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| publicNetworkAccess | This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring |
DomainProperties_PublicNetworkAccess Optional |
| tags | Tags of the resource. | map[string]string Optional |
Domain_STATUS
EventGrid Domain.
Used by: Domain.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| endpoint | Endpoint for the domain. | string Optional |
| id | Fully qualified identifier of the resource. | string Optional |
| inboundIpRules | This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. | InboundIpRule_STATUS[] Optional |
| inputSchema | This determines the format that Event Grid should expect for incoming events published to the domain. | DomainProperties_InputSchema_STATUS Optional |
| inputSchemaMapping | Information about the InputSchemaMapping which specified the info about mapping event payload. | InputSchemaMapping_STATUS Optional |
| location | Location of the resource. | string Optional |
| metricResourceId | Metric resource id for the domain. | string Optional |
| name | Name of the resource. | string Optional |
| privateEndpointConnections | List of private endpoint connections. | PrivateEndpointConnection_STATUS_Domain_SubResourceEmbedded[] Optional |
| provisioningState | Provisioning state of the domain. | DomainProperties_ProvisioningState_STATUS Optional |
| publicNetworkAccess | This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring |
DomainProperties_PublicNetworkAccess_STATUS Optional |
| systemData | The system metadata relating to Domain resource. | SystemData_STATUS Optional |
| tags | Tags of the resource. | map[string]string Optional |
| type | Type of the resource. | string Optional |
DomainsTopic_Spec
Used by: DomainsTopic.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | DomainsTopicOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a eventgrid.azure.com/Domain resource | genruntime.KnownResourceReference Required |
DomainsTopic_STATUS
Used by: DomainsTopic.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified identifier of the resource. | string Optional |
| name | Name of the resource. | string Optional |
| provisioningState | Provisioning state of the domain topic. | DomainTopicProperties_ProvisioningState_STATUS Optional |
| systemData | The system metadata relating to Domain Topic resource. | SystemData_STATUS Optional |
| type | Type of the resource. | string Optional |
EventSubscription_Spec
Used by: EventSubscription.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| deadLetterDestination | The DeadLetter destination of the event subscription. | DeadLetterDestination Optional |
| destination | Information about the destination where events have to be delivered for the event subscription. | EventSubscriptionDestination Optional |
| eventDeliverySchema | The event delivery schema for the event subscription. | EventSubscriptionProperties_EventDeliverySchema Optional |
| expirationTimeUtc | Expiration time of the event subscription. | string Optional |
| filter | Information about the filter for the event subscription. | EventSubscriptionFilter Optional |
| labels | List of user defined labels. | string[] Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | EventSubscriptionOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. This resource is an extension resource, which means that any other Azure resource can be its owner. | genruntime.ArbitraryOwnerReference Required |
| retryPolicy | The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. | RetryPolicy Optional |
EventSubscription_STATUS
Event Subscription
Used by: EventSubscription.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| deadLetterDestination | The DeadLetter destination of the event subscription. | DeadLetterDestination_STATUS Optional |
| destination | Information about the destination where events have to be delivered for the event subscription. | EventSubscriptionDestination_STATUS Optional |
| eventDeliverySchema | The event delivery schema for the event subscription. | EventSubscriptionProperties_EventDeliverySchema_STATUS Optional |
| expirationTimeUtc | Expiration time of the event subscription. | string Optional |
| filter | Information about the filter for the event subscription. | EventSubscriptionFilter_STATUS Optional |
| id | Fully qualified identifier of the resource. | string Optional |
| labels | List of user defined labels. | string[] Optional |
| name | Name of the resource. | string Optional |
| provisioningState | Provisioning state of the event subscription. | EventSubscriptionProperties_ProvisioningState_STATUS Optional |
| retryPolicy | The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. | RetryPolicy_STATUS Optional |
| systemData | The system metadata relating to Event Subscription resource. | SystemData_STATUS Optional |
| topic | Name of the topic of the event subscription. | string Optional |
| type | Type of the resource. | string Optional |
Topic_Spec
Used by: Topic.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| inboundIpRules | This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. | InboundIpRule[] Optional |
| inputSchema | This determines the format that Event Grid should expect for incoming events published to the topic. | TopicProperties_InputSchema Optional |
| inputSchemaMapping | This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema. | InputSchemaMapping Optional |
| location | Location of the resource. | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | TopicOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| publicNetworkAccess | This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring |
TopicProperties_PublicNetworkAccess Optional |
| tags | Tags of the resource. | map[string]string Optional |
Topic_STATUS
EventGrid Topic
Used by: Topic.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| endpoint | Endpoint for the topic. | string Optional |
| id | Fully qualified identifier of the resource. | string Optional |
| inboundIpRules | This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. | InboundIpRule_STATUS[] Optional |
| inputSchema | This determines the format that Event Grid should expect for incoming events published to the topic. | TopicProperties_InputSchema_STATUS Optional |
| inputSchemaMapping | This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema. | InputSchemaMapping_STATUS Optional |
| location | Location of the resource. | string Optional |
| metricResourceId | Metric resource id for the topic. | string Optional |
| name | Name of the resource. | string Optional |
| privateEndpointConnections | PrivateEndpointConnection_STATUS_Topic_SubResourceEmbedded[] Optional |
|
| provisioningState | Provisioning state of the topic. | TopicProperties_ProvisioningState_STATUS Optional |
| publicNetworkAccess | This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring |
TopicProperties_PublicNetworkAccess_STATUS Optional |
| systemData | The system metadata relating to Topic resource. | SystemData_STATUS Optional |
| tags | Tags of the resource. | map[string]string Optional |
| type | Type of the resource. | string Optional |
DeadLetterDestination
Used by: EventSubscription_Spec.
| Property | Description | Type |
|---|---|---|
| storageBlob | Mutually exclusive with all other properties | StorageBlobDeadLetterDestination Optional |
DeadLetterDestination_STATUS
Used by: EventSubscription_STATUS.
| Property | Description | Type |
|---|---|---|
| storageBlob | Mutually exclusive with all other properties | StorageBlobDeadLetterDestination_STATUS Optional |
DomainOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Domain_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
DomainProperties_InputSchema
Used by: Domain_Spec.
| Value | Description |
|---|---|
| “CloudEventSchemaV1_0” | |
| “CustomEventSchema” | |
| “EventGridSchema” |
DomainProperties_InputSchema_STATUS
Used by: Domain_STATUS.
| Value | Description |
|---|---|
| “CloudEventSchemaV1_0” | |
| “CustomEventSchema” | |
| “EventGridSchema” |
DomainProperties_ProvisioningState_STATUS
Used by: Domain_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |
DomainProperties_PublicNetworkAccess
Used by: Domain_Spec.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
DomainProperties_PublicNetworkAccess_STATUS
Used by: Domain_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
DomainsTopicOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: DomainsTopic_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
DomainTopicProperties_ProvisioningState_STATUS
Used by: DomainsTopic_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |
EventSubscriptionDestination
Used by: EventSubscription_Spec.
| Property | Description | Type |
|---|---|---|
| azureFunction | Mutually exclusive with all other properties | AzureFunctionEventSubscriptionDestination Optional |
| eventHub | Mutually exclusive with all other properties | EventHubEventSubscriptionDestination Optional |
| hybridConnection | Mutually exclusive with all other properties | HybridConnectionEventSubscriptionDestination Optional |
| serviceBusQueue | Mutually exclusive with all other properties | ServiceBusQueueEventSubscriptionDestination Optional |
| serviceBusTopic | Mutually exclusive with all other properties | ServiceBusTopicEventSubscriptionDestination Optional |
| storageQueue | Mutually exclusive with all other properties | StorageQueueEventSubscriptionDestination Optional |
| webHook | Mutually exclusive with all other properties | WebHookEventSubscriptionDestination Optional |
EventSubscriptionDestination_STATUS
Used by: EventSubscription_STATUS.
| Property | Description | Type |
|---|---|---|
| azureFunction | Mutually exclusive with all other properties | AzureFunctionEventSubscriptionDestination_STATUS Optional |
| eventHub | Mutually exclusive with all other properties | EventHubEventSubscriptionDestination_STATUS Optional |
| hybridConnection | Mutually exclusive with all other properties | HybridConnectionEventSubscriptionDestination_STATUS Optional |
| serviceBusQueue | Mutually exclusive with all other properties | ServiceBusQueueEventSubscriptionDestination_STATUS Optional |
| serviceBusTopic | Mutually exclusive with all other properties | ServiceBusTopicEventSubscriptionDestination_STATUS Optional |
| storageQueue | Mutually exclusive with all other properties | StorageQueueEventSubscriptionDestination_STATUS Optional |
| webHook | Mutually exclusive with all other properties | WebHookEventSubscriptionDestination_STATUS Optional |
EventSubscriptionFilter
Filter for the Event Subscription.
Used by: EventSubscription_Spec.
| Property | Description | Type |
|---|---|---|
| advancedFilters | An array of advanced filters that are used for filtering event subscriptions. | AdvancedFilter[] Optional |
| includedEventTypes | A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all default event types, set the IncludedEventTypes to null. | string[] Optional |
| isSubjectCaseSensitive | Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. | bool Optional |
| subjectBeginsWith | An optional string to filter events for an event subscription based on a resource path prefix. The format of this depends on the publisher of the events. Wildcard characters are not supported in this path. | string Optional |
| subjectEndsWith | An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. | string Optional |
EventSubscriptionFilter_STATUS
Filter for the Event Subscription.
Used by: EventSubscription_STATUS.
| Property | Description | Type |
|---|---|---|
| advancedFilters | An array of advanced filters that are used for filtering event subscriptions. | AdvancedFilter_STATUS[] Optional |
| includedEventTypes | A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all default event types, set the IncludedEventTypes to null. | string[] Optional |
| isSubjectCaseSensitive | Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. | bool Optional |
| subjectBeginsWith | An optional string to filter events for an event subscription based on a resource path prefix. The format of this depends on the publisher of the events. Wildcard characters are not supported in this path. | string Optional |
| subjectEndsWith | An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. | string Optional |
EventSubscriptionOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: EventSubscription_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
EventSubscriptionProperties_EventDeliverySchema
Used by: EventSubscription_Spec.
| Value | Description |
|---|---|
| “CloudEventSchemaV1_0” | |
| “CustomInputSchema” | |
| “EventGridSchema” |
EventSubscriptionProperties_EventDeliverySchema_STATUS
Used by: EventSubscription_STATUS.
| Value | Description |
|---|---|
| “CloudEventSchemaV1_0” | |
| “CustomInputSchema” | |
| “EventGridSchema” |
EventSubscriptionProperties_ProvisioningState_STATUS
Used by: EventSubscription_STATUS.
| Value | Description |
|---|---|
| “AwaitingManualAction” | |
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |
InboundIpRule
Used by: Domain_Spec, and Topic_Spec.
| Property | Description | Type |
|---|---|---|
| action | Action to perform based on the match or no match of the IpMask. | InboundIpRule_Action Optional |
| ipMask | IP Address in CIDR notation e.g., 10.0.0.0/8. | string Optional |
InboundIpRule_STATUS
Used by: Domain_STATUS, and Topic_STATUS.
| Property | Description | Type |
|---|---|---|
| action | Action to perform based on the match or no match of the IpMask. | InboundIpRule_Action_STATUS Optional |
| ipMask | IP Address in CIDR notation e.g., 10.0.0.0/8. | string Optional |
InputSchemaMapping
Used by: Domain_Spec, and Topic_Spec.
| Property | Description | Type |
|---|---|---|
| json | Mutually exclusive with all other properties | JsonInputSchemaMapping Optional |
InputSchemaMapping_STATUS
Used by: Domain_STATUS, and Topic_STATUS.
| Property | Description | Type |
|---|---|---|
| json | Mutually exclusive with all other properties | JsonInputSchemaMapping_STATUS Optional |
PrivateEndpointConnection_STATUS_Domain_SubResourceEmbedded
Used by: Domain_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Fully qualified identifier of the resource. | string Optional |
PrivateEndpointConnection_STATUS_Topic_SubResourceEmbedded
Used by: Topic_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Fully qualified identifier of the resource. | string Optional |
RetryPolicy
Information about the retry policy for an event subscription.
Used by: EventSubscription_Spec.
| Property | Description | Type |
|---|---|---|
| eventTimeToLiveInMinutes | Time To Live (in minutes) for events. | int Optional |
| maxDeliveryAttempts | Maximum number of delivery retry attempts for events. | int Optional |
RetryPolicy_STATUS
Information about the retry policy for an event subscription.
Used by: EventSubscription_STATUS.
| Property | Description | Type |
|---|---|---|
| eventTimeToLiveInMinutes | Time To Live (in minutes) for events. | int Optional |
| maxDeliveryAttempts | Maximum number of delivery retry attempts for events. | int Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: Domain_STATUS, DomainsTopic_STATUS, EventSubscription_STATUS, and Topic_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
TopicOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Topic_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| configMaps | configures where to place operator written ConfigMaps. | TopicOperatorConfigMaps Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
| secrets | configures where to place Azure generated secrets. | TopicOperatorSecrets Optional |
TopicProperties_InputSchema
Used by: Topic_Spec.
| Value | Description |
|---|---|
| “CloudEventSchemaV1_0” | |
| “CustomEventSchema” | |
| “EventGridSchema” |
TopicProperties_InputSchema_STATUS
Used by: Topic_STATUS.
| Value | Description |
|---|---|
| “CloudEventSchemaV1_0” | |
| “CustomEventSchema” | |
| “EventGridSchema” |
TopicProperties_ProvisioningState_STATUS
Used by: Topic_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |
TopicProperties_PublicNetworkAccess
Used by: Topic_Spec.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
TopicProperties_PublicNetworkAccess_STATUS
Used by: Topic_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
AdvancedFilter
Used by: EventSubscriptionFilter.
| Property | Description | Type |
|---|---|---|
| boolEquals | Mutually exclusive with all other properties | BoolEqualsAdvancedFilter Optional |
| numberGreaterThan | Mutually exclusive with all other properties | NumberGreaterThanAdvancedFilter Optional |
| numberGreaterThanOrEquals | Mutually exclusive with all other properties | NumberGreaterThanOrEqualsAdvancedFilter Optional |
| numberIn | Mutually exclusive with all other properties | NumberInAdvancedFilter Optional |
| numberLessThan | Mutually exclusive with all other properties | NumberLessThanAdvancedFilter Optional |
| numberLessThanOrEquals | Mutually exclusive with all other properties | NumberLessThanOrEqualsAdvancedFilter Optional |
| numberNotIn | Mutually exclusive with all other properties | NumberNotInAdvancedFilter Optional |
| stringBeginsWith | Mutually exclusive with all other properties | StringBeginsWithAdvancedFilter Optional |
| stringContains | Mutually exclusive with all other properties | StringContainsAdvancedFilter Optional |
| stringEndsWith | Mutually exclusive with all other properties | StringEndsWithAdvancedFilter Optional |
| stringIn | Mutually exclusive with all other properties | StringInAdvancedFilter Optional |
| stringNotIn | Mutually exclusive with all other properties | StringNotInAdvancedFilter Optional |
AdvancedFilter_STATUS
Used by: EventSubscriptionFilter_STATUS.
| Property | Description | Type |
|---|---|---|
| boolEquals | Mutually exclusive with all other properties | BoolEqualsAdvancedFilter_STATUS Optional |
| numberGreaterThan | Mutually exclusive with all other properties | NumberGreaterThanAdvancedFilter_STATUS Optional |
| numberGreaterThanOrEquals | Mutually exclusive with all other properties | NumberGreaterThanOrEqualsAdvancedFilter_STATUS Optional |
| numberIn | Mutually exclusive with all other properties | NumberInAdvancedFilter_STATUS Optional |
| numberLessThan | Mutually exclusive with all other properties | NumberLessThanAdvancedFilter_STATUS Optional |
| numberLessThanOrEquals | Mutually exclusive with all other properties | NumberLessThanOrEqualsAdvancedFilter_STATUS Optional |
| numberNotIn | Mutually exclusive with all other properties | NumberNotInAdvancedFilter_STATUS Optional |
| stringBeginsWith | Mutually exclusive with all other properties | StringBeginsWithAdvancedFilter_STATUS Optional |
| stringContains | Mutually exclusive with all other properties | StringContainsAdvancedFilter_STATUS Optional |
| stringEndsWith | Mutually exclusive with all other properties | StringEndsWithAdvancedFilter_STATUS Optional |
| stringIn | Mutually exclusive with all other properties | StringInAdvancedFilter_STATUS Optional |
| stringNotIn | Mutually exclusive with all other properties | StringNotInAdvancedFilter_STATUS Optional |
AzureFunctionEventSubscriptionDestination
Used by: EventSubscriptionDestination.
| Property | Description | Type |
|---|---|---|
| endpointType | Type of the endpoint for the event subscription destination. | AzureFunctionEventSubscriptionDestination_EndpointType Required |
| maxEventsPerBatch | Maximum number of events per batch. | int Optional |
| preferredBatchSizeInKilobytes | Preferred batch size in Kilobytes. | int Optional |
| resourceReference | The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription. | genruntime.ResourceReference Optional |
AzureFunctionEventSubscriptionDestination_STATUS
Used by: EventSubscriptionDestination_STATUS.
| Property | Description | Type |
|---|---|---|
| endpointType | Type of the endpoint for the event subscription destination. | AzureFunctionEventSubscriptionDestination_EndpointType_STATUS Optional |
| maxEventsPerBatch | Maximum number of events per batch. | int Optional |
| preferredBatchSizeInKilobytes | Preferred batch size in Kilobytes. | int Optional |
| resourceId | The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription. | string Optional |
EventHubEventSubscriptionDestination
Used by: EventSubscriptionDestination.
| Property | Description | Type |
|---|---|---|
| endpointType | Type of the endpoint for the event subscription destination. | EventHubEventSubscriptionDestination_EndpointType Required |
| resourceReference | The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. | genruntime.ResourceReference Optional |
EventHubEventSubscriptionDestination_STATUS
Used by: EventSubscriptionDestination_STATUS.
| Property | Description | Type |
|---|---|---|
| endpointType | Type of the endpoint for the event subscription destination. | EventHubEventSubscriptionDestination_EndpointType_STATUS Optional |
| resourceId | The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. | string Optional |
HybridConnectionEventSubscriptionDestination
Used by: EventSubscriptionDestination.
| Property | Description | Type |
|---|---|---|
| endpointType | Type of the endpoint for the event subscription destination. | HybridConnectionEventSubscriptionDestination_EndpointType Required |
| resourceReference | The Azure Resource ID of an hybrid connection that is the destination of an event subscription. | genruntime.ResourceReference Optional |
HybridConnectionEventSubscriptionDestination_STATUS
Used by: EventSubscriptionDestination_STATUS.
| Property | Description | Type |
|---|---|---|
| endpointType | Type of the endpoint for the event subscription destination. | HybridConnectionEventSubscriptionDestination_EndpointType_STATUS Optional |
| resourceId | The Azure Resource ID of an hybrid connection that is the destination of an event subscription. | string Optional |
InboundIpRule_Action
Used by: InboundIpRule.
| Value | Description |
|---|---|
| “Allow” |
InboundIpRule_Action_STATUS
Used by: InboundIpRule_STATUS.
| Value | Description |
|---|---|
| “Allow” |
JsonInputSchemaMapping
Used by: InputSchemaMapping.
| Property | Description | Type |
|---|---|---|
| dataVersion | The mapping information for the DataVersion property of the Event Grid Event. | JsonFieldWithDefault Optional |
| eventTime | The mapping information for the EventTime property of the Event Grid Event. | JsonField Optional |
| eventType | The mapping information for the EventType property of the Event Grid Event. | JsonFieldWithDefault Optional |
| id | The mapping information for the Id property of the Event Grid Event. | JsonField Optional |
| inputSchemaMappingType | Type of the custom mapping | JsonInputSchemaMapping_InputSchemaMappingType Required |
| subject | The mapping information for the Subject property of the Event Grid Event. | JsonFieldWithDefault Optional |
| topic | The mapping information for the Topic property of the Event Grid Event. | JsonField Optional |
JsonInputSchemaMapping_STATUS
Used by: InputSchemaMapping_STATUS.
| Property | Description | Type |
|---|---|---|
| dataVersion | The mapping information for the DataVersion property of the Event Grid Event. | JsonFieldWithDefault_STATUS Optional |
| eventTime | The mapping information for the EventTime property of the Event Grid Event. | JsonField_STATUS Optional |
| eventType | The mapping information for the EventType property of the Event Grid Event. | JsonFieldWithDefault_STATUS Optional |
| id | The mapping information for the Id property of the Event Grid Event. | JsonField_STATUS Optional |
| inputSchemaMappingType | Type of the custom mapping | JsonInputSchemaMapping_InputSchemaMappingType_STATUS Optional |
| subject | The mapping information for the Subject property of the Event Grid Event. | JsonFieldWithDefault_STATUS Optional |
| topic | The mapping information for the Topic property of the Event Grid Event. | JsonField_STATUS Optional |
ServiceBusQueueEventSubscriptionDestination
Used by: EventSubscriptionDestination.
| Property | Description | Type |
|---|---|---|
| endpointType | Type of the endpoint for the event subscription destination. | ServiceBusQueueEventSubscriptionDestination_EndpointType Required |
| resourceReference | The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. | genruntime.ResourceReference Optional |
ServiceBusQueueEventSubscriptionDestination_STATUS
Used by: EventSubscriptionDestination_STATUS.
| Property | Description | Type |
|---|---|---|
| endpointType | Type of the endpoint for the event subscription destination. | ServiceBusQueueEventSubscriptionDestination_EndpointType_STATUS Optional |
| resourceId | The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. | string Optional |
ServiceBusTopicEventSubscriptionDestination
Used by: EventSubscriptionDestination.
| Property | Description | Type |
|---|---|---|
| endpointType | Type of the endpoint for the event subscription destination. | ServiceBusTopicEventSubscriptionDestination_EndpointType Required |
| resourceReference | The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. | genruntime.ResourceReference Optional |
ServiceBusTopicEventSubscriptionDestination_STATUS
Used by: EventSubscriptionDestination_STATUS.
| Property | Description | Type |
|---|---|---|
| endpointType | Type of the endpoint for the event subscription destination. | ServiceBusTopicEventSubscriptionDestination_EndpointType_STATUS Optional |
| resourceId | The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. | string Optional |
StorageBlobDeadLetterDestination
Used by: DeadLetterDestination.
| Property | Description | Type |
|---|---|---|
| blobContainerName | The name of the Storage blob container that is the destination of the deadletter events | string Optional |
| endpointType | Type of the endpoint for the dead letter destination | StorageBlobDeadLetterDestination_EndpointType Required |
| resourceReference | The Azure Resource ID of the storage account that is the destination of the deadletter events | genruntime.ResourceReference Optional |
StorageBlobDeadLetterDestination_STATUS
Used by: DeadLetterDestination_STATUS.
| Property | Description | Type |
|---|---|---|
| blobContainerName | The name of the Storage blob container that is the destination of the deadletter events | string Optional |
| endpointType | Type of the endpoint for the dead letter destination | StorageBlobDeadLetterDestination_EndpointType_STATUS Optional |
| resourceId | The Azure Resource ID of the storage account that is the destination of the deadletter events | string Optional |
StorageQueueEventSubscriptionDestination
Used by: EventSubscriptionDestination.
| Property | Description | Type |
|---|---|---|
| endpointType | Type of the endpoint for the event subscription destination. | StorageQueueEventSubscriptionDestination_EndpointType Required |
| queueName | The name of the Storage queue under a storage account that is the destination of an event subscription. | string Optional |
| resourceReference | The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. | genruntime.ResourceReference Optional |
StorageQueueEventSubscriptionDestination_STATUS
Used by: EventSubscriptionDestination_STATUS.
| Property | Description | Type |
|---|---|---|
| endpointType | Type of the endpoint for the event subscription destination. | StorageQueueEventSubscriptionDestination_EndpointType_STATUS Optional |
| queueName | The name of the Storage queue under a storage account that is the destination of an event subscription. | string Optional |
| resourceId | The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. | string Optional |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
TopicOperatorConfigMaps
Used by: TopicOperatorSpec.
| Property | Description | Type |
|---|---|---|
| endpoint | indicates where the Endpoint config map should be placed. If omitted, no config map will be created. | genruntime.ConfigMapDestination Optional |
TopicOperatorSecrets
Used by: TopicOperatorSpec.
| Property | Description | Type |
|---|---|---|
| key1 | indicates where the Key1 secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| key2 | indicates where the Key2 secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
WebHookEventSubscriptionDestination
Used by: EventSubscriptionDestination.
| Property | Description | Type |
|---|---|---|
| azureActiveDirectoryApplicationIdOrUri | The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests. | string Optional |
| azureActiveDirectoryTenantId | The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. | string Optional |
| endpointType | Type of the endpoint for the event subscription destination. | WebHookEventSubscriptionDestination_EndpointType Required |
| endpointUrl | The URL that represents the endpoint of the destination of an event subscription. | genruntime.SecretReference Optional |
| maxEventsPerBatch | Maximum number of events per batch. | int Optional |
| preferredBatchSizeInKilobytes | Preferred batch size in Kilobytes. | int Optional |
WebHookEventSubscriptionDestination_STATUS
Used by: EventSubscriptionDestination_STATUS.
| Property | Description | Type |
|---|---|---|
| azureActiveDirectoryApplicationIdOrUri | The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests. | string Optional |
| azureActiveDirectoryTenantId | The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. | string Optional |
| endpointBaseUrl | The base URL that represents the endpoint of the destination of an event subscription. | string Optional |
| endpointType | Type of the endpoint for the event subscription destination. | WebHookEventSubscriptionDestination_EndpointType_STATUS Optional |
| maxEventsPerBatch | Maximum number of events per batch. | int Optional |
| preferredBatchSizeInKilobytes | Preferred batch size in Kilobytes. | int Optional |
AzureFunctionEventSubscriptionDestination_EndpointType
Used by: AzureFunctionEventSubscriptionDestination.
| Value | Description |
|---|---|
| “AzureFunction” |
AzureFunctionEventSubscriptionDestination_EndpointType_STATUS
Used by: AzureFunctionEventSubscriptionDestination_STATUS.
| Value | Description |
|---|---|
| “AzureFunction” |
BoolEqualsAdvancedFilter
Used by: AdvancedFilter.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | BoolEqualsAdvancedFilter_OperatorType Required |
| value | The boolean filter value. | bool Optional |
BoolEqualsAdvancedFilter_STATUS
Used by: AdvancedFilter_STATUS.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | BoolEqualsAdvancedFilter_OperatorType_STATUS Optional |
| value | The boolean filter value. | bool Optional |
EventHubEventSubscriptionDestination_EndpointType
Used by: EventHubEventSubscriptionDestination.
| Value | Description |
|---|---|
| “EventHub” |
EventHubEventSubscriptionDestination_EndpointType_STATUS
Used by: EventHubEventSubscriptionDestination_STATUS.
| Value | Description |
|---|---|
| “EventHub” |
HybridConnectionEventSubscriptionDestination_EndpointType
Used by: HybridConnectionEventSubscriptionDestination.
| Value | Description |
|---|---|
| “HybridConnection” |
HybridConnectionEventSubscriptionDestination_EndpointType_STATUS
Used by: HybridConnectionEventSubscriptionDestination_STATUS.
| Value | Description |
|---|---|
| “HybridConnection” |
JsonField
This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the ‘id’, ’topic’ and ’eventtime’ properties. This represents a field in the input event schema.
Used by: JsonInputSchemaMapping, JsonInputSchemaMapping, and JsonInputSchemaMapping.
| Property | Description | Type |
|---|---|---|
| sourceField | Name of a field in the input event schema that’s to be used as the source of a mapping. | string Optional |
JsonField_STATUS
This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the ‘id’, ’topic’ and ’eventtime’ properties. This represents a field in the input event schema.
Used by: JsonInputSchemaMapping_STATUS, JsonInputSchemaMapping_STATUS, and JsonInputSchemaMapping_STATUS.
| Property | Description | Type |
|---|---|---|
| sourceField | Name of a field in the input event schema that’s to be used as the source of a mapping. | string Optional |
JsonFieldWithDefault
This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the ‘subject’, ’eventtype’ and ‘dataversion’ properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.
Used by: JsonInputSchemaMapping, JsonInputSchemaMapping, and JsonInputSchemaMapping.
| Property | Description | Type |
|---|---|---|
| defaultValue | The default value to be used for mapping when a SourceField is not provided or if there’s no property with the specified name in the published JSON event payload. | string Optional |
| sourceField | Name of a field in the input event schema that’s to be used as the source of a mapping. | string Optional |
JsonFieldWithDefault_STATUS
This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the ‘subject’, ’eventtype’ and ‘dataversion’ properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.
Used by: JsonInputSchemaMapping_STATUS, JsonInputSchemaMapping_STATUS, and JsonInputSchemaMapping_STATUS.
| Property | Description | Type |
|---|---|---|
| defaultValue | The default value to be used for mapping when a SourceField is not provided or if there’s no property with the specified name in the published JSON event payload. | string Optional |
| sourceField | Name of a field in the input event schema that’s to be used as the source of a mapping. | string Optional |
JsonInputSchemaMapping_InputSchemaMappingType
Used by: JsonInputSchemaMapping.
| Value | Description |
|---|---|
| “Json” |
JsonInputSchemaMapping_InputSchemaMappingType_STATUS
Used by: JsonInputSchemaMapping_STATUS.
| Value | Description |
|---|---|
| “Json” |
NumberGreaterThanAdvancedFilter
Used by: AdvancedFilter.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | NumberGreaterThanAdvancedFilter_OperatorType Required |
| value | The filter value. | float64 Optional |
NumberGreaterThanAdvancedFilter_STATUS
Used by: AdvancedFilter_STATUS.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | NumberGreaterThanAdvancedFilter_OperatorType_STATUS Optional |
| value | The filter value. | float64 Optional |
NumberGreaterThanOrEqualsAdvancedFilter
Used by: AdvancedFilter.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | NumberGreaterThanOrEqualsAdvancedFilter_OperatorType Required |
| value | The filter value. | float64 Optional |
NumberGreaterThanOrEqualsAdvancedFilter_STATUS
Used by: AdvancedFilter_STATUS.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | NumberGreaterThanOrEqualsAdvancedFilter_OperatorType_STATUS Optional |
| value | The filter value. | float64 Optional |
NumberInAdvancedFilter
Used by: AdvancedFilter.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | NumberInAdvancedFilter_OperatorType Required |
| values | The set of filter values. | float64[] Optional |
NumberInAdvancedFilter_STATUS
Used by: AdvancedFilter_STATUS.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | NumberInAdvancedFilter_OperatorType_STATUS Optional |
| values | The set of filter values. | float64[] Optional |
NumberLessThanAdvancedFilter
Used by: AdvancedFilter.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | NumberLessThanAdvancedFilter_OperatorType Required |
| value | The filter value. | float64 Optional |
NumberLessThanAdvancedFilter_STATUS
Used by: AdvancedFilter_STATUS.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | NumberLessThanAdvancedFilter_OperatorType_STATUS Optional |
| value | The filter value. | float64 Optional |
NumberLessThanOrEqualsAdvancedFilter
Used by: AdvancedFilter.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | NumberLessThanOrEqualsAdvancedFilter_OperatorType Required |
| value | The filter value. | float64 Optional |
NumberLessThanOrEqualsAdvancedFilter_STATUS
Used by: AdvancedFilter_STATUS.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | NumberLessThanOrEqualsAdvancedFilter_OperatorType_STATUS Optional |
| value | The filter value. | float64 Optional |
NumberNotInAdvancedFilter
Used by: AdvancedFilter.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | NumberNotInAdvancedFilter_OperatorType Required |
| values | The set of filter values. | float64[] Optional |
NumberNotInAdvancedFilter_STATUS
Used by: AdvancedFilter_STATUS.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | NumberNotInAdvancedFilter_OperatorType_STATUS Optional |
| values | The set of filter values. | float64[] Optional |
ServiceBusQueueEventSubscriptionDestination_EndpointType
Used by: ServiceBusQueueEventSubscriptionDestination.
| Value | Description |
|---|---|
| “ServiceBusQueue” |
ServiceBusQueueEventSubscriptionDestination_EndpointType_STATUS
Used by: ServiceBusQueueEventSubscriptionDestination_STATUS.
| Value | Description |
|---|---|
| “ServiceBusQueue” |
ServiceBusTopicEventSubscriptionDestination_EndpointType
Used by: ServiceBusTopicEventSubscriptionDestination.
| Value | Description |
|---|---|
| “ServiceBusTopic” |
ServiceBusTopicEventSubscriptionDestination_EndpointType_STATUS
Used by: ServiceBusTopicEventSubscriptionDestination_STATUS.
| Value | Description |
|---|---|
| “ServiceBusTopic” |
StorageBlobDeadLetterDestination_EndpointType
Used by: StorageBlobDeadLetterDestination.
| Value | Description |
|---|---|
| “StorageBlob” |
StorageBlobDeadLetterDestination_EndpointType_STATUS
Used by: StorageBlobDeadLetterDestination_STATUS.
| Value | Description |
|---|---|
| “StorageBlob” |
StorageQueueEventSubscriptionDestination_EndpointType
Used by: StorageQueueEventSubscriptionDestination.
| Value | Description |
|---|---|
| “StorageQueue” |
StorageQueueEventSubscriptionDestination_EndpointType_STATUS
Used by: StorageQueueEventSubscriptionDestination_STATUS.
| Value | Description |
|---|---|
| “StorageQueue” |
StringBeginsWithAdvancedFilter
Used by: AdvancedFilter.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | StringBeginsWithAdvancedFilter_OperatorType Required |
| values | The set of filter values. | string[] Optional |
StringBeginsWithAdvancedFilter_STATUS
Used by: AdvancedFilter_STATUS.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | StringBeginsWithAdvancedFilter_OperatorType_STATUS Optional |
| values | The set of filter values. | string[] Optional |
StringContainsAdvancedFilter
Used by: AdvancedFilter.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | StringContainsAdvancedFilter_OperatorType Required |
| values | The set of filter values. | string[] Optional |
StringContainsAdvancedFilter_STATUS
Used by: AdvancedFilter_STATUS.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | StringContainsAdvancedFilter_OperatorType_STATUS Optional |
| values | The set of filter values. | string[] Optional |
StringEndsWithAdvancedFilter
Used by: AdvancedFilter.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | StringEndsWithAdvancedFilter_OperatorType Required |
| values | The set of filter values. | string[] Optional |
StringEndsWithAdvancedFilter_STATUS
Used by: AdvancedFilter_STATUS.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | StringEndsWithAdvancedFilter_OperatorType_STATUS Optional |
| values | The set of filter values. | string[] Optional |
StringInAdvancedFilter
Used by: AdvancedFilter.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | StringInAdvancedFilter_OperatorType Required |
| values | The set of filter values. | string[] Optional |
StringInAdvancedFilter_STATUS
Used by: AdvancedFilter_STATUS.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | StringInAdvancedFilter_OperatorType_STATUS Optional |
| values | The set of filter values. | string[] Optional |
StringNotInAdvancedFilter
Used by: AdvancedFilter.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | StringNotInAdvancedFilter_OperatorType Required |
| values | The set of filter values. | string[] Optional |
StringNotInAdvancedFilter_STATUS
Used by: AdvancedFilter_STATUS.
| Property | Description | Type |
|---|---|---|
| key | The field/property in the event based on which you want to filter. | string Optional |
| operatorType | The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. | StringNotInAdvancedFilter_OperatorType_STATUS Optional |
| values | The set of filter values. | string[] Optional |
WebHookEventSubscriptionDestination_EndpointType
Used by: WebHookEventSubscriptionDestination.
| Value | Description |
|---|---|
| “WebHook” |
WebHookEventSubscriptionDestination_EndpointType_STATUS
Used by: WebHookEventSubscriptionDestination_STATUS.
| Value | Description |
|---|---|
| “WebHook” |
BoolEqualsAdvancedFilter_OperatorType
Used by: BoolEqualsAdvancedFilter.
| Value | Description |
|---|---|
| “BoolEquals” |
BoolEqualsAdvancedFilter_OperatorType_STATUS
Used by: BoolEqualsAdvancedFilter_STATUS.
| Value | Description |
|---|---|
| “BoolEquals” |
NumberGreaterThanAdvancedFilter_OperatorType
Used by: NumberGreaterThanAdvancedFilter.
| Value | Description |
|---|---|
| “NumberGreaterThan” |
NumberGreaterThanAdvancedFilter_OperatorType_STATUS
Used by: NumberGreaterThanAdvancedFilter_STATUS.
| Value | Description |
|---|---|
| “NumberGreaterThan” |
NumberGreaterThanOrEqualsAdvancedFilter_OperatorType
Used by: NumberGreaterThanOrEqualsAdvancedFilter.
| Value | Description |
|---|---|
| “NumberGreaterThanOrEquals” |
NumberGreaterThanOrEqualsAdvancedFilter_OperatorType_STATUS
Used by: NumberGreaterThanOrEqualsAdvancedFilter_STATUS.
| Value | Description |
|---|---|
| “NumberGreaterThanOrEquals” |
NumberInAdvancedFilter_OperatorType
Used by: NumberInAdvancedFilter.
| Value | Description |
|---|---|
| “NumberIn” |
NumberInAdvancedFilter_OperatorType_STATUS
Used by: NumberInAdvancedFilter_STATUS.
| Value | Description |
|---|---|
| “NumberIn” |
NumberLessThanAdvancedFilter_OperatorType
Used by: NumberLessThanAdvancedFilter.
| Value | Description |
|---|---|
| “NumberLessThan” |
NumberLessThanAdvancedFilter_OperatorType_STATUS
Used by: NumberLessThanAdvancedFilter_STATUS.
| Value | Description |
|---|---|
| “NumberLessThan” |
NumberLessThanOrEqualsAdvancedFilter_OperatorType
Used by: NumberLessThanOrEqualsAdvancedFilter.
| Value | Description |
|---|---|
| “NumberLessThanOrEquals” |
NumberLessThanOrEqualsAdvancedFilter_OperatorType_STATUS
Used by: NumberLessThanOrEqualsAdvancedFilter_STATUS.
| Value | Description |
|---|---|
| “NumberLessThanOrEquals” |
NumberNotInAdvancedFilter_OperatorType
Used by: NumberNotInAdvancedFilter.
| Value | Description |
|---|---|
| “NumberNotIn” |
NumberNotInAdvancedFilter_OperatorType_STATUS
Used by: NumberNotInAdvancedFilter_STATUS.
| Value | Description |
|---|---|
| “NumberNotIn” |
StringBeginsWithAdvancedFilter_OperatorType
Used by: StringBeginsWithAdvancedFilter.
| Value | Description |
|---|---|
| “StringBeginsWith” |
StringBeginsWithAdvancedFilter_OperatorType_STATUS
Used by: StringBeginsWithAdvancedFilter_STATUS.
| Value | Description |
|---|---|
| “StringBeginsWith” |
StringContainsAdvancedFilter_OperatorType
Used by: StringContainsAdvancedFilter.
| Value | Description |
|---|---|
| “StringContains” |
StringContainsAdvancedFilter_OperatorType_STATUS
Used by: StringContainsAdvancedFilter_STATUS.
| Value | Description |
|---|---|
| “StringContains” |
StringEndsWithAdvancedFilter_OperatorType
Used by: StringEndsWithAdvancedFilter.
| Value | Description |
|---|---|
| “StringEndsWith” |
StringEndsWithAdvancedFilter_OperatorType_STATUS
Used by: StringEndsWithAdvancedFilter_STATUS.
| Value | Description |
|---|---|
| “StringEndsWith” |
StringInAdvancedFilter_OperatorType
Used by: StringInAdvancedFilter.
| Value | Description |
|---|---|
| “StringIn” |
StringInAdvancedFilter_OperatorType_STATUS
Used by: StringInAdvancedFilter_STATUS.
| Value | Description |
|---|---|
| “StringIn” |
StringNotInAdvancedFilter_OperatorType
Used by: StringNotInAdvancedFilter.
| Value | Description |
|---|---|
| “StringNotIn” |
StringNotInAdvancedFilter_OperatorType_STATUS
Used by: StringNotInAdvancedFilter_STATUS.
| Value | Description |
|---|---|
| “StringNotIn” |