eventgrid.azure.com/v1api20200601
eventgrid.azure.com/v1api20200601
Package v1api20200601 contains API Schema definitions for the eventgrid v1api20200601 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2020-06-01" |
AdvancedFilter
(Appears on:EventSubscriptionFilter)
Field | Description |
---|---|
boolEquals BoolEqualsAdvancedFilter |
BoolEquals: Mutually exclusive with all other properties |
numberGreaterThan NumberGreaterThanAdvancedFilter |
NumberGreaterThan: Mutually exclusive with all other properties |
numberGreaterThanOrEquals NumberGreaterThanOrEqualsAdvancedFilter |
NumberGreaterThanOrEquals: Mutually exclusive with all other properties |
numberIn NumberInAdvancedFilter |
NumberIn: Mutually exclusive with all other properties |
numberLessThan NumberLessThanAdvancedFilter |
NumberLessThan: Mutually exclusive with all other properties |
numberLessThanOrEquals NumberLessThanOrEqualsAdvancedFilter |
NumberLessThanOrEquals: Mutually exclusive with all other properties |
numberNotIn NumberNotInAdvancedFilter |
NumberNotIn: Mutually exclusive with all other properties |
stringBeginsWith StringBeginsWithAdvancedFilter |
StringBeginsWith: Mutually exclusive with all other properties |
stringContains StringContainsAdvancedFilter |
StringContains: Mutually exclusive with all other properties |
stringEndsWith StringEndsWithAdvancedFilter |
StringEndsWith: Mutually exclusive with all other properties |
stringIn StringInAdvancedFilter |
StringIn: Mutually exclusive with all other properties |
stringNotIn StringNotInAdvancedFilter |
StringNotIn: Mutually exclusive with all other properties |
AdvancedFilter_STATUS
(Appears on:EventSubscriptionFilter_STATUS)
Field | Description |
---|---|
boolEquals BoolEqualsAdvancedFilter_STATUS |
BoolEquals: Mutually exclusive with all other properties |
numberGreaterThan NumberGreaterThanAdvancedFilter_STATUS |
NumberGreaterThan: Mutually exclusive with all other properties |
numberGreaterThanOrEquals NumberGreaterThanOrEqualsAdvancedFilter_STATUS |
NumberGreaterThanOrEquals: Mutually exclusive with all other properties |
numberIn NumberInAdvancedFilter_STATUS |
NumberIn: Mutually exclusive with all other properties |
numberLessThan NumberLessThanAdvancedFilter_STATUS |
NumberLessThan: Mutually exclusive with all other properties |
numberLessThanOrEquals NumberLessThanOrEqualsAdvancedFilter_STATUS |
NumberLessThanOrEquals: Mutually exclusive with all other properties |
numberNotIn NumberNotInAdvancedFilter_STATUS |
NumberNotIn: Mutually exclusive with all other properties |
stringBeginsWith StringBeginsWithAdvancedFilter_STATUS |
StringBeginsWith: Mutually exclusive with all other properties |
stringContains StringContainsAdvancedFilter_STATUS |
StringContains: Mutually exclusive with all other properties |
stringEndsWith StringEndsWithAdvancedFilter_STATUS |
StringEndsWith: Mutually exclusive with all other properties |
stringIn StringInAdvancedFilter_STATUS |
StringIn: Mutually exclusive with all other properties |
stringNotIn StringNotInAdvancedFilter_STATUS |
StringNotIn: Mutually exclusive with all other properties |
AzureFunctionEventSubscriptionDestination
(Appears on:EventSubscriptionDestination)
Field | Description |
---|---|
endpointType AzureFunctionEventSubscriptionDestination_EndpointType |
EndpointType: Type of the endpoint for the event subscription destination. |
maxEventsPerBatch int |
MaxEventsPerBatch: Maximum number of events per batch. |
preferredBatchSizeInKilobytes int |
PreferredBatchSizeInKilobytes: Preferred batch size in Kilobytes. |
resourceReference genruntime.ResourceReference |
ResourceReference: The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription. |
AzureFunctionEventSubscriptionDestination_EndpointType
(string
alias)
(Appears on:AzureFunctionEventSubscriptionDestination)
Value | Description |
---|---|
"AzureFunction" |
AzureFunctionEventSubscriptionDestination_EndpointType_STATUS
(string
alias)
(Appears on:AzureFunctionEventSubscriptionDestination_STATUS)
Value | Description |
---|---|
"AzureFunction" |
AzureFunctionEventSubscriptionDestination_STATUS
(Appears on:EventSubscriptionDestination_STATUS)
Field | Description |
---|---|
endpointType AzureFunctionEventSubscriptionDestination_EndpointType_STATUS |
EndpointType: Type of the endpoint for the event subscription destination. |
maxEventsPerBatch int |
MaxEventsPerBatch: Maximum number of events per batch. |
preferredBatchSizeInKilobytes int |
PreferredBatchSizeInKilobytes: Preferred batch size in Kilobytes. |
resourceId string |
ResourceId: The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription. |
BoolEqualsAdvancedFilter
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType BoolEqualsAdvancedFilter_OperatorType |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
value bool |
Value: The boolean filter value. |
BoolEqualsAdvancedFilter_OperatorType
(string
alias)
(Appears on:BoolEqualsAdvancedFilter)
Value | Description |
---|---|
"BoolEquals" |
BoolEqualsAdvancedFilter_OperatorType_STATUS
(string
alias)
(Appears on:BoolEqualsAdvancedFilter_STATUS)
Value | Description |
---|---|
"BoolEquals" |
BoolEqualsAdvancedFilter_STATUS
(Appears on:AdvancedFilter_STATUS)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType BoolEqualsAdvancedFilter_OperatorType_STATUS |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
value bool |
Value: The boolean filter value. |
DeadLetterDestination
(Appears on:EventSubscription_Spec)
Field | Description |
---|---|
storageBlob StorageBlobDeadLetterDestination |
StorageBlob: Mutually exclusive with all other properties |
DeadLetterDestination_STATUS
(Appears on:EventSubscription_STATUS)
Field | Description |
---|---|
storageBlob StorageBlobDeadLetterDestination_STATUS |
StorageBlob: Mutually exclusive with all other properties |
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}p>
Field | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||
spec Domain_Spec |
|
||||||||||||||||||
status Domain_STATUS |
DomainOperatorSpec
(Appears on:Domain_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
DomainProperties_InputSchema
(string
alias)
(Appears on:Domain_Spec)
Value | Description |
---|---|
"CloudEventSchemaV1_0" |
|
"CustomEventSchema" |
|
"EventGridSchema" |
DomainProperties_InputSchema_STATUS
(string
alias)
(Appears on:Domain_STATUS)
Value | Description |
---|---|
"CloudEventSchemaV1_0" |
|
"CustomEventSchema" |
|
"EventGridSchema" |
DomainProperties_ProvisioningState_STATUS
(string
alias)
(Appears on:Domain_STATUS)
Value | Description |
---|---|
"Canceled" |
|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
DomainProperties_PublicNetworkAccess
(string
alias)
(Appears on:Domain_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
DomainProperties_PublicNetworkAccess_STATUS
(string
alias)
(Appears on:Domain_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
DomainTopicProperties_ProvisioningState_STATUS
(string
alias)
(Appears on:DomainsTopic_STATUS)
Value | Description |
---|---|
"Canceled" |
|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
Domain_STATUS
(Appears on:Domain)
EventGrid Domain.
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
endpoint string |
Endpoint: Endpoint for the domain. |
id string |
Id: Fully qualified identifier of the resource. |
inboundIpRules []InboundIpRule_STATUS |
InboundIpRules: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. |
inputSchema DomainProperties_InputSchema_STATUS |
InputSchema: This determines the format that Event Grid should expect for incoming events published to the domain. |
inputSchemaMapping InputSchemaMapping_STATUS |
InputSchemaMapping: Information about the InputSchemaMapping which specified the info about mapping event payload. |
location string |
Location: Location of the resource. |
metricResourceId string |
MetricResourceId: Metric resource id for the domain. |
name string |
Name: Name of the resource. |
privateEndpointConnections []PrivateEndpointConnection_STATUS_Domain_SubResourceEmbedded |
PrivateEndpointConnections: List of private endpoint connections. |
provisioningState DomainProperties_ProvisioningState_STATUS |
ProvisioningState: Provisioning state of the domain. |
publicNetworkAccess DomainProperties_PublicNetworkAccess_STATUS |
PublicNetworkAccess: This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring |
systemData SystemData_STATUS |
SystemData: The system metadata relating to Domain resource. |
tags map[string]string |
Tags: Tags of the resource. |
type string |
Type: Type of the resource. |
Domain_Spec
(Appears on:Domain)
Field | Description |
---|---|
azureName string |
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. |
inboundIpRules []InboundIpRule |
InboundIpRules: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. |
inputSchema DomainProperties_InputSchema |
InputSchema: This determines the format that Event Grid should expect for incoming events published to the domain. |
inputSchemaMapping InputSchemaMapping |
InputSchemaMapping: Information about the InputSchemaMapping which specified the info about mapping event payload. |
location string |
Location: Location of the resource. |
operatorSpec DomainOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
publicNetworkAccess DomainProperties_PublicNetworkAccess |
PublicNetworkAccess: This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring |
tags map[string]string |
Tags: Tags of the resource. |
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}p>
Field | Description | ||||||
---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||
spec DomainsTopic_Spec |
|
||||||
status DomainsTopic_STATUS |
DomainsTopicOperatorSpec
(Appears on:DomainsTopic_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
DomainsTopic_STATUS
(Appears on:DomainsTopic)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
id string |
Id: Fully qualified identifier of the resource. |
name string |
Name: Name of the resource. |
provisioningState DomainTopicProperties_ProvisioningState_STATUS |
ProvisioningState: Provisioning state of the domain topic. |
systemData SystemData_STATUS |
SystemData: The system metadata relating to Domain Topic resource. |
type string |
Type: Type of the resource. |
DomainsTopic_Spec
(Appears on:DomainsTopic)
Field | Description |
---|---|
azureName string |
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. |
operatorSpec DomainsTopicOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
EventHubEventSubscriptionDestination
(Appears on:EventSubscriptionDestination)
Field | Description |
---|---|
endpointType EventHubEventSubscriptionDestination_EndpointType |
EndpointType: Type of the endpoint for the event subscription destination. |
resourceReference genruntime.ResourceReference |
ResourceReference: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. |
EventHubEventSubscriptionDestination_EndpointType
(string
alias)
(Appears on:EventHubEventSubscriptionDestination)
Value | Description |
---|---|
"EventHub" |
EventHubEventSubscriptionDestination_EndpointType_STATUS
(string
alias)
(Appears on:EventHubEventSubscriptionDestination_STATUS)
Value | Description |
---|---|
"EventHub" |
EventHubEventSubscriptionDestination_STATUS
(Appears on:EventSubscriptionDestination_STATUS)
Field | Description |
---|---|
endpointType EventHubEventSubscriptionDestination_EndpointType_STATUS |
EndpointType: Type of the endpoint for the event subscription destination. |
resourceId string |
ResourceId: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. |
EventSubscription
Generator information: - Generated from: /eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/EventGrid.json - ARM URI: /{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}
Field | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||
spec EventSubscription_Spec |
|
||||||||||||||||||||
status EventSubscription_STATUS |
EventSubscriptionDestination
(Appears on:EventSubscription_Spec)
Field | Description |
---|---|
azureFunction AzureFunctionEventSubscriptionDestination |
AzureFunction: Mutually exclusive with all other properties |
eventHub EventHubEventSubscriptionDestination |
EventHub: Mutually exclusive with all other properties |
hybridConnection HybridConnectionEventSubscriptionDestination |
HybridConnection: Mutually exclusive with all other properties |
serviceBusQueue ServiceBusQueueEventSubscriptionDestination |
ServiceBusQueue: Mutually exclusive with all other properties |
serviceBusTopic ServiceBusTopicEventSubscriptionDestination |
ServiceBusTopic: Mutually exclusive with all other properties |
storageQueue StorageQueueEventSubscriptionDestination |
StorageQueue: Mutually exclusive with all other properties |
webHook WebHookEventSubscriptionDestination |
WebHook: Mutually exclusive with all other properties |
EventSubscriptionDestination_STATUS
(Appears on:EventSubscription_STATUS)
Field | Description |
---|---|
azureFunction AzureFunctionEventSubscriptionDestination_STATUS |
AzureFunction: Mutually exclusive with all other properties |
eventHub EventHubEventSubscriptionDestination_STATUS |
EventHub: Mutually exclusive with all other properties |
hybridConnection HybridConnectionEventSubscriptionDestination_STATUS |
HybridConnection: Mutually exclusive with all other properties |
serviceBusQueue ServiceBusQueueEventSubscriptionDestination_STATUS |
ServiceBusQueue: Mutually exclusive with all other properties |
serviceBusTopic ServiceBusTopicEventSubscriptionDestination_STATUS |
ServiceBusTopic: Mutually exclusive with all other properties |
storageQueue StorageQueueEventSubscriptionDestination_STATUS |
StorageQueue: Mutually exclusive with all other properties |
webHook WebHookEventSubscriptionDestination_STATUS |
WebHook: Mutually exclusive with all other properties |
EventSubscriptionFilter
(Appears on:EventSubscription_Spec)
Filter for the Event Subscription.
Field | Description |
---|---|
advancedFilters []AdvancedFilter |
AdvancedFilters: An array of advanced filters that are used for filtering event subscriptions. |
includedEventTypes []string |
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. |
isSubjectCaseSensitive bool |
IsSubjectCaseSensitive: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. |
subjectBeginsWith string |
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. |
subjectEndsWith string |
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. |
EventSubscriptionFilter_STATUS
(Appears on:EventSubscription_STATUS)
Filter for the Event Subscription.
Field | Description |
---|---|
advancedFilters []AdvancedFilter_STATUS |
AdvancedFilters: An array of advanced filters that are used for filtering event subscriptions. |
includedEventTypes []string |
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. |
isSubjectCaseSensitive bool |
IsSubjectCaseSensitive: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. |
subjectBeginsWith string |
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. |
subjectEndsWith string |
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. |
EventSubscriptionOperatorSpec
(Appears on:EventSubscription_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
EventSubscriptionProperties_EventDeliverySchema
(string
alias)
(Appears on:EventSubscription_Spec)
Value | Description |
---|---|
"CloudEventSchemaV1_0" |
|
"CustomInputSchema" |
|
"EventGridSchema" |
EventSubscriptionProperties_EventDeliverySchema_STATUS
(string
alias)
(Appears on:EventSubscription_STATUS)
Value | Description |
---|---|
"CloudEventSchemaV1_0" |
|
"CustomInputSchema" |
|
"EventGridSchema" |
EventSubscriptionProperties_ProvisioningState_STATUS
(string
alias)
(Appears on:EventSubscription_STATUS)
Value | Description |
---|---|
"AwaitingManualAction" |
|
"Canceled" |
|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
EventSubscription_STATUS
(Appears on:EventSubscription)
Event Subscription
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
deadLetterDestination DeadLetterDestination_STATUS |
DeadLetterDestination: The DeadLetter destination of the event subscription. |
destination EventSubscriptionDestination_STATUS |
Destination: Information about the destination where events have to be delivered for the event subscription. |
eventDeliverySchema EventSubscriptionProperties_EventDeliverySchema_STATUS |
EventDeliverySchema: The event delivery schema for the event subscription. |
expirationTimeUtc string |
ExpirationTimeUtc: Expiration time of the event subscription. |
filter EventSubscriptionFilter_STATUS |
Filter: Information about the filter for the event subscription. |
id string |
Id: Fully qualified identifier of the resource. |
labels []string |
Labels: List of user defined labels. |
name string |
Name: Name of the resource. |
provisioningState EventSubscriptionProperties_ProvisioningState_STATUS |
ProvisioningState: Provisioning state of the event subscription. |
retryPolicy RetryPolicy_STATUS |
RetryPolicy: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. |
systemData SystemData_STATUS |
SystemData: The system metadata relating to Event Subscription resource. |
topic string |
Topic: Name of the topic of the event subscription. |
type string |
Type: Type of the resource. |
EventSubscription_Spec
(Appears on:EventSubscription)
Field | Description |
---|---|
azureName string |
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. |
deadLetterDestination DeadLetterDestination |
DeadLetterDestination: The DeadLetter destination of the event subscription. |
destination EventSubscriptionDestination |
Destination: Information about the destination where events have to be delivered for the event subscription. |
eventDeliverySchema EventSubscriptionProperties_EventDeliverySchema |
EventDeliverySchema: The event delivery schema for the event subscription. |
expirationTimeUtc string |
ExpirationTimeUtc: Expiration time of the event subscription. |
filter EventSubscriptionFilter |
Filter: Information about the filter for the event subscription. |
labels []string |
Labels: List of user defined labels. |
operatorSpec EventSubscriptionOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.ArbitraryOwnerReference |
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. |
retryPolicy RetryPolicy |
RetryPolicy: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. |
HybridConnectionEventSubscriptionDestination
(Appears on:EventSubscriptionDestination)
Field | Description |
---|---|
endpointType HybridConnectionEventSubscriptionDestination_EndpointType |
EndpointType: Type of the endpoint for the event subscription destination. |
resourceReference genruntime.ResourceReference |
ResourceReference: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. |
HybridConnectionEventSubscriptionDestination_EndpointType
(string
alias)
(Appears on:HybridConnectionEventSubscriptionDestination)
Value | Description |
---|---|
"HybridConnection" |
HybridConnectionEventSubscriptionDestination_EndpointType_STATUS
(string
alias)
(Appears on:HybridConnectionEventSubscriptionDestination_STATUS)
Value | Description |
---|---|
"HybridConnection" |
HybridConnectionEventSubscriptionDestination_STATUS
(Appears on:EventSubscriptionDestination_STATUS)
Field | Description |
---|---|
endpointType HybridConnectionEventSubscriptionDestination_EndpointType_STATUS |
EndpointType: Type of the endpoint for the event subscription destination. |
resourceId string |
ResourceId: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. |
InboundIpRule
(Appears on:Domain_Spec, Topic_Spec)
Field | Description |
---|---|
action InboundIpRule_Action |
Action: Action to perform based on the match or no match of the IpMask. |
ipMask string |
IpMask: IP Address in CIDR notation e.g., 10.0.0.0/8. |
InboundIpRule_Action
(string
alias)
(Appears on:InboundIpRule)
Value | Description |
---|---|
"Allow" |
InboundIpRule_Action_STATUS
(string
alias)
(Appears on:InboundIpRule_STATUS)
Value | Description |
---|---|
"Allow" |
InboundIpRule_STATUS
(Appears on:Domain_STATUS, Topic_STATUS)
Field | Description |
---|---|
action InboundIpRule_Action_STATUS |
Action: Action to perform based on the match or no match of the IpMask. |
ipMask string |
IpMask: IP Address in CIDR notation e.g., 10.0.0.0/8. |
InputSchemaMapping
(Appears on:Domain_Spec, Topic_Spec)
Field | Description |
---|---|
json JsonInputSchemaMapping |
Json: Mutually exclusive with all other properties |
InputSchemaMapping_STATUS
(Appears on:Domain_STATUS, Topic_STATUS)
Field | Description |
---|---|
json JsonInputSchemaMapping_STATUS |
Json: Mutually exclusive with all other properties |
JsonField
(Appears on:JsonInputSchemaMapping)
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.
Field | Description |
---|---|
sourceField string |
SourceField: Name of a field in the input event schema that’s to be used as the source of a mapping. |
JsonFieldWithDefault
(Appears on:JsonInputSchemaMapping)
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.
Field | Description |
---|---|
defaultValue string |
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. |
sourceField string |
SourceField: Name of a field in the input event schema that’s to be used as the source of a mapping. |
JsonFieldWithDefault_STATUS
(Appears on:JsonInputSchemaMapping_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.
Field | Description |
---|---|
defaultValue string |
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. |
sourceField string |
SourceField: Name of a field in the input event schema that’s to be used as the source of a mapping. |
JsonField_STATUS
(Appears on:JsonInputSchemaMapping_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.
Field | Description |
---|---|
sourceField string |
SourceField: Name of a field in the input event schema that’s to be used as the source of a mapping. |
JsonInputSchemaMapping
(Appears on:InputSchemaMapping)
Field | Description |
---|---|
dataVersion JsonFieldWithDefault |
DataVersion: The mapping information for the DataVersion property of the Event Grid Event. |
eventTime JsonField |
EventTime: The mapping information for the EventTime property of the Event Grid Event. |
eventType JsonFieldWithDefault |
EventType: The mapping information for the EventType property of the Event Grid Event. |
id JsonField |
Id: The mapping information for the Id property of the Event Grid Event. |
inputSchemaMappingType JsonInputSchemaMapping_InputSchemaMappingType |
InputSchemaMappingType: Type of the custom mapping |
subject JsonFieldWithDefault |
Subject: The mapping information for the Subject property of the Event Grid Event. |
topic JsonField |
Topic: The mapping information for the Topic property of the Event Grid Event. |
JsonInputSchemaMapping_InputSchemaMappingType
(string
alias)
(Appears on:JsonInputSchemaMapping)
Value | Description |
---|---|
"Json" |
JsonInputSchemaMapping_InputSchemaMappingType_STATUS
(string
alias)
(Appears on:JsonInputSchemaMapping_STATUS)
Value | Description |
---|---|
"Json" |
JsonInputSchemaMapping_STATUS
(Appears on:InputSchemaMapping_STATUS)
Field | Description |
---|---|
dataVersion JsonFieldWithDefault_STATUS |
DataVersion: The mapping information for the DataVersion property of the Event Grid Event. |
eventTime JsonField_STATUS |
EventTime: The mapping information for the EventTime property of the Event Grid Event. |
eventType JsonFieldWithDefault_STATUS |
EventType: The mapping information for the EventType property of the Event Grid Event. |
id JsonField_STATUS |
Id: The mapping information for the Id property of the Event Grid Event. |
inputSchemaMappingType JsonInputSchemaMapping_InputSchemaMappingType_STATUS |
InputSchemaMappingType: Type of the custom mapping |
subject JsonFieldWithDefault_STATUS |
Subject: The mapping information for the Subject property of the Event Grid Event. |
topic JsonField_STATUS |
Topic: The mapping information for the Topic property of the Event Grid Event. |
NumberGreaterThanAdvancedFilter
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType NumberGreaterThanAdvancedFilter_OperatorType |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
value float64 |
Value: The filter value. |
NumberGreaterThanAdvancedFilter_OperatorType
(string
alias)
(Appears on:NumberGreaterThanAdvancedFilter)
Value | Description |
---|---|
"NumberGreaterThan" |
NumberGreaterThanAdvancedFilter_OperatorType_STATUS
(string
alias)
(Appears on:NumberGreaterThanAdvancedFilter_STATUS)
Value | Description |
---|---|
"NumberGreaterThan" |
NumberGreaterThanAdvancedFilter_STATUS
(Appears on:AdvancedFilter_STATUS)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType NumberGreaterThanAdvancedFilter_OperatorType_STATUS |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
value float64 |
Value: The filter value. |
NumberGreaterThanOrEqualsAdvancedFilter
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType NumberGreaterThanOrEqualsAdvancedFilter_OperatorType |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
value float64 |
Value: The filter value. |
NumberGreaterThanOrEqualsAdvancedFilter_OperatorType
(string
alias)
(Appears on:NumberGreaterThanOrEqualsAdvancedFilter)
Value | Description |
---|---|
"NumberGreaterThanOrEquals" |
NumberGreaterThanOrEqualsAdvancedFilter_OperatorType_STATUS
(string
alias)
(Appears on:NumberGreaterThanOrEqualsAdvancedFilter_STATUS)
Value | Description |
---|---|
"NumberGreaterThanOrEquals" |
NumberGreaterThanOrEqualsAdvancedFilter_STATUS
(Appears on:AdvancedFilter_STATUS)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType NumberGreaterThanOrEqualsAdvancedFilter_OperatorType_STATUS |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
value float64 |
Value: The filter value. |
NumberInAdvancedFilter
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType NumberInAdvancedFilter_OperatorType |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
values []float64 |
Values: The set of filter values. |
NumberInAdvancedFilter_OperatorType
(string
alias)
(Appears on:NumberInAdvancedFilter)
Value | Description |
---|---|
"NumberIn" |
NumberInAdvancedFilter_OperatorType_STATUS
(string
alias)
(Appears on:NumberInAdvancedFilter_STATUS)
Value | Description |
---|---|
"NumberIn" |
NumberInAdvancedFilter_STATUS
(Appears on:AdvancedFilter_STATUS)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType NumberInAdvancedFilter_OperatorType_STATUS |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
values []float64 |
Values: The set of filter values. |
NumberLessThanAdvancedFilter
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType NumberLessThanAdvancedFilter_OperatorType |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
value float64 |
Value: The filter value. |
NumberLessThanAdvancedFilter_OperatorType
(string
alias)
(Appears on:NumberLessThanAdvancedFilter)
Value | Description |
---|---|
"NumberLessThan" |
NumberLessThanAdvancedFilter_OperatorType_STATUS
(string
alias)
(Appears on:NumberLessThanAdvancedFilter_STATUS)
Value | Description |
---|---|
"NumberLessThan" |
NumberLessThanAdvancedFilter_STATUS
(Appears on:AdvancedFilter_STATUS)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType NumberLessThanAdvancedFilter_OperatorType_STATUS |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
value float64 |
Value: The filter value. |
NumberLessThanOrEqualsAdvancedFilter
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType NumberLessThanOrEqualsAdvancedFilter_OperatorType |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
value float64 |
Value: The filter value. |
NumberLessThanOrEqualsAdvancedFilter_OperatorType
(string
alias)
(Appears on:NumberLessThanOrEqualsAdvancedFilter)
Value | Description |
---|---|
"NumberLessThanOrEquals" |
NumberLessThanOrEqualsAdvancedFilter_OperatorType_STATUS
(string
alias)
(Appears on:NumberLessThanOrEqualsAdvancedFilter_STATUS)
Value | Description |
---|---|
"NumberLessThanOrEquals" |
NumberLessThanOrEqualsAdvancedFilter_STATUS
(Appears on:AdvancedFilter_STATUS)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType NumberLessThanOrEqualsAdvancedFilter_OperatorType_STATUS |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
value float64 |
Value: The filter value. |
NumberNotInAdvancedFilter
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType NumberNotInAdvancedFilter_OperatorType |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
values []float64 |
Values: The set of filter values. |
NumberNotInAdvancedFilter_OperatorType
(string
alias)
(Appears on:NumberNotInAdvancedFilter)
Value | Description |
---|---|
"NumberNotIn" |
NumberNotInAdvancedFilter_OperatorType_STATUS
(string
alias)
(Appears on:NumberNotInAdvancedFilter_STATUS)
Value | Description |
---|---|
"NumberNotIn" |
NumberNotInAdvancedFilter_STATUS
(Appears on:AdvancedFilter_STATUS)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType NumberNotInAdvancedFilter_OperatorType_STATUS |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
values []float64 |
Values: The set of filter values. |
PrivateEndpointConnection_STATUS_Domain_SubResourceEmbedded
(Appears on:Domain_STATUS)
Field | Description |
---|---|
id string |
Id: Fully qualified identifier of the resource. |
PrivateEndpointConnection_STATUS_Topic_SubResourceEmbedded
(Appears on:Topic_STATUS)
Field | Description |
---|---|
id string |
Id: Fully qualified identifier of the resource. |
RetryPolicy
(Appears on:EventSubscription_Spec)
Information about the retry policy for an event subscription.
Field | Description |
---|---|
eventTimeToLiveInMinutes int |
EventTimeToLiveInMinutes: Time To Live (in minutes) for events. |
maxDeliveryAttempts int |
MaxDeliveryAttempts: Maximum number of delivery retry attempts for events. |
RetryPolicy_STATUS
(Appears on:EventSubscription_STATUS)
Information about the retry policy for an event subscription.
Field | Description |
---|---|
eventTimeToLiveInMinutes int |
EventTimeToLiveInMinutes: Time To Live (in minutes) for events. |
maxDeliveryAttempts int |
MaxDeliveryAttempts: Maximum number of delivery retry attempts for events. |
ServiceBusQueueEventSubscriptionDestination
(Appears on:EventSubscriptionDestination)
Field | Description |
---|---|
endpointType ServiceBusQueueEventSubscriptionDestination_EndpointType |
EndpointType: Type of the endpoint for the event subscription destination. |
resourceReference genruntime.ResourceReference |
ResourceReference: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. |
ServiceBusQueueEventSubscriptionDestination_EndpointType
(string
alias)
(Appears on:ServiceBusQueueEventSubscriptionDestination)
Value | Description |
---|---|
"ServiceBusQueue" |
ServiceBusQueueEventSubscriptionDestination_EndpointType_STATUS
(string
alias)
(Appears on:ServiceBusQueueEventSubscriptionDestination_STATUS)
Value | Description |
---|---|
"ServiceBusQueue" |
ServiceBusQueueEventSubscriptionDestination_STATUS
(Appears on:EventSubscriptionDestination_STATUS)
Field | Description |
---|---|
endpointType ServiceBusQueueEventSubscriptionDestination_EndpointType_STATUS |
EndpointType: Type of the endpoint for the event subscription destination. |
resourceId string |
ResourceId: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. |
ServiceBusTopicEventSubscriptionDestination
(Appears on:EventSubscriptionDestination)
Field | Description |
---|---|
endpointType ServiceBusTopicEventSubscriptionDestination_EndpointType |
EndpointType: Type of the endpoint for the event subscription destination. |
resourceReference genruntime.ResourceReference |
ResourceReference: The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. |
ServiceBusTopicEventSubscriptionDestination_EndpointType
(string
alias)
(Appears on:ServiceBusTopicEventSubscriptionDestination)
Value | Description |
---|---|
"ServiceBusTopic" |
ServiceBusTopicEventSubscriptionDestination_EndpointType_STATUS
(string
alias)
(Appears on:ServiceBusTopicEventSubscriptionDestination_STATUS)
Value | Description |
---|---|
"ServiceBusTopic" |
ServiceBusTopicEventSubscriptionDestination_STATUS
(Appears on:EventSubscriptionDestination_STATUS)
Field | Description |
---|---|
endpointType ServiceBusTopicEventSubscriptionDestination_EndpointType_STATUS |
EndpointType: Type of the endpoint for the event subscription destination. |
resourceId string |
ResourceId: The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. |
StorageBlobDeadLetterDestination
(Appears on:DeadLetterDestination)
Field | Description |
---|---|
blobContainerName string |
BlobContainerName: The name of the Storage blob container that is the destination of the deadletter events |
endpointType StorageBlobDeadLetterDestination_EndpointType |
EndpointType: Type of the endpoint for the dead letter destination |
resourceReference genruntime.ResourceReference |
ResourceReference: The Azure Resource ID of the storage account that is the destination of the deadletter events |
StorageBlobDeadLetterDestination_EndpointType
(string
alias)
(Appears on:StorageBlobDeadLetterDestination)
Value | Description |
---|---|
"StorageBlob" |
StorageBlobDeadLetterDestination_EndpointType_STATUS
(string
alias)
(Appears on:StorageBlobDeadLetterDestination_STATUS)
Value | Description |
---|---|
"StorageBlob" |
StorageBlobDeadLetterDestination_STATUS
(Appears on:DeadLetterDestination_STATUS)
Field | Description |
---|---|
blobContainerName string |
BlobContainerName: The name of the Storage blob container that is the destination of the deadletter events |
endpointType StorageBlobDeadLetterDestination_EndpointType_STATUS |
EndpointType: Type of the endpoint for the dead letter destination |
resourceId string |
ResourceId: The Azure Resource ID of the storage account that is the destination of the deadletter events |
StorageQueueEventSubscriptionDestination
(Appears on:EventSubscriptionDestination)
Field | Description |
---|---|
endpointType StorageQueueEventSubscriptionDestination_EndpointType |
EndpointType: Type of the endpoint for the event subscription destination. |
queueName string |
QueueName: The name of the Storage queue under a storage account that is the destination of an event subscription. |
resourceReference genruntime.ResourceReference |
ResourceReference: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. |
StorageQueueEventSubscriptionDestination_EndpointType
(string
alias)
(Appears on:StorageQueueEventSubscriptionDestination)
Value | Description |
---|---|
"StorageQueue" |
StorageQueueEventSubscriptionDestination_EndpointType_STATUS
(string
alias)
(Appears on:StorageQueueEventSubscriptionDestination_STATUS)
Value | Description |
---|---|
"StorageQueue" |
StorageQueueEventSubscriptionDestination_STATUS
(Appears on:EventSubscriptionDestination_STATUS)
Field | Description |
---|---|
endpointType StorageQueueEventSubscriptionDestination_EndpointType_STATUS |
EndpointType: Type of the endpoint for the event subscription destination. |
queueName string |
QueueName: The name of the Storage queue under a storage account that is the destination of an event subscription. |
resourceId string |
ResourceId: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. |
StringBeginsWithAdvancedFilter
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType StringBeginsWithAdvancedFilter_OperatorType |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
values []string |
Values: The set of filter values. |
StringBeginsWithAdvancedFilter_OperatorType
(string
alias)
(Appears on:StringBeginsWithAdvancedFilter)
Value | Description |
---|---|
"StringBeginsWith" |
StringBeginsWithAdvancedFilter_OperatorType_STATUS
(string
alias)
(Appears on:StringBeginsWithAdvancedFilter_STATUS)
Value | Description |
---|---|
"StringBeginsWith" |
StringBeginsWithAdvancedFilter_STATUS
(Appears on:AdvancedFilter_STATUS)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType StringBeginsWithAdvancedFilter_OperatorType_STATUS |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
values []string |
Values: The set of filter values. |
StringContainsAdvancedFilter
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType StringContainsAdvancedFilter_OperatorType |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
values []string |
Values: The set of filter values. |
StringContainsAdvancedFilter_OperatorType
(string
alias)
(Appears on:StringContainsAdvancedFilter)
Value | Description |
---|---|
"StringContains" |
StringContainsAdvancedFilter_OperatorType_STATUS
(string
alias)
(Appears on:StringContainsAdvancedFilter_STATUS)
Value | Description |
---|---|
"StringContains" |
StringContainsAdvancedFilter_STATUS
(Appears on:AdvancedFilter_STATUS)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType StringContainsAdvancedFilter_OperatorType_STATUS |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
values []string |
Values: The set of filter values. |
StringEndsWithAdvancedFilter
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType StringEndsWithAdvancedFilter_OperatorType |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
values []string |
Values: The set of filter values. |
StringEndsWithAdvancedFilter_OperatorType
(string
alias)
(Appears on:StringEndsWithAdvancedFilter)
Value | Description |
---|---|
"StringEndsWith" |
StringEndsWithAdvancedFilter_OperatorType_STATUS
(string
alias)
(Appears on:StringEndsWithAdvancedFilter_STATUS)
Value | Description |
---|---|
"StringEndsWith" |
StringEndsWithAdvancedFilter_STATUS
(Appears on:AdvancedFilter_STATUS)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType StringEndsWithAdvancedFilter_OperatorType_STATUS |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
values []string |
Values: The set of filter values. |
StringInAdvancedFilter
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType StringInAdvancedFilter_OperatorType |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
values []string |
Values: The set of filter values. |
StringInAdvancedFilter_OperatorType
(string
alias)
(Appears on:StringInAdvancedFilter)
Value | Description |
---|---|
"StringIn" |
StringInAdvancedFilter_OperatorType_STATUS
(string
alias)
(Appears on:StringInAdvancedFilter_STATUS)
Value | Description |
---|---|
"StringIn" |
StringInAdvancedFilter_STATUS
(Appears on:AdvancedFilter_STATUS)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType StringInAdvancedFilter_OperatorType_STATUS |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
values []string |
Values: The set of filter values. |
StringNotInAdvancedFilter
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType StringNotInAdvancedFilter_OperatorType |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
values []string |
Values: The set of filter values. |
StringNotInAdvancedFilter_OperatorType
(string
alias)
(Appears on:StringNotInAdvancedFilter)
Value | Description |
---|---|
"StringNotIn" |
StringNotInAdvancedFilter_OperatorType_STATUS
(string
alias)
(Appears on:StringNotInAdvancedFilter_STATUS)
Value | Description |
---|---|
"StringNotIn" |
StringNotInAdvancedFilter_STATUS
(Appears on:AdvancedFilter_STATUS)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType StringNotInAdvancedFilter_OperatorType_STATUS |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
values []string |
Values: The set of filter values. |
SystemData_CreatedByType_STATUS
(string
alias)
(Appears on:SystemData_STATUS)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_LastModifiedByType_STATUS
(string
alias)
(Appears on:SystemData_STATUS)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_STATUS
(Appears on:Domain_STATUS, DomainsTopic_STATUS, EventSubscription_STATUS, Topic_STATUS)
Metadata pertaining to creation and last modification of the resource.
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC). |
createdBy string |
CreatedBy: The identity that created the resource. |
createdByType SystemData_CreatedByType_STATUS |
CreatedByType: The type of identity that created the resource. |
lastModifiedAt string |
LastModifiedAt: The timestamp of resource last modification (UTC) |
lastModifiedBy string |
LastModifiedBy: The identity that last modified the resource. |
lastModifiedByType SystemData_LastModifiedByType_STATUS |
LastModifiedByType: The type of identity that last modified the resource. |
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}p>
Field | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||
spec Topic_Spec |
|
||||||||||||||||||
status Topic_STATUS |
TopicOperatorConfigMaps
(Appears on:TopicOperatorSpec)
Field | Description |
---|---|
endpoint genruntime.ConfigMapDestination |
Endpoint: indicates where the Endpoint config map should be placed. If omitted, no config map will be created. |
TopicOperatorSecrets
(Appears on:TopicOperatorSpec)
Field | Description |
---|---|
key1 genruntime.SecretDestination |
Key1: indicates where the Key1 secret should be placed. If omitted, the secret will not be retrieved from Azure. |
key2 genruntime.SecretDestination |
Key2: indicates where the Key2 secret should be placed. If omitted, the secret will not be retrieved from Azure. |
TopicOperatorSpec
(Appears on:Topic_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
configMaps TopicOperatorConfigMaps |
ConfigMaps: configures where to place operator written ConfigMaps. |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
secrets TopicOperatorSecrets |
Secrets: configures where to place Azure generated secrets. |
TopicProperties_InputSchema
(string
alias)
(Appears on:Topic_Spec)
Value | Description |
---|---|
"CloudEventSchemaV1_0" |
|
"CustomEventSchema" |
|
"EventGridSchema" |
TopicProperties_InputSchema_STATUS
(string
alias)
(Appears on:Topic_STATUS)
Value | Description |
---|---|
"CloudEventSchemaV1_0" |
|
"CustomEventSchema" |
|
"EventGridSchema" |
TopicProperties_ProvisioningState_STATUS
(string
alias)
(Appears on:Topic_STATUS)
Value | Description |
---|---|
"Canceled" |
|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
TopicProperties_PublicNetworkAccess
(string
alias)
(Appears on:Topic_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
TopicProperties_PublicNetworkAccess_STATUS
(string
alias)
(Appears on:Topic_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
Topic_STATUS
(Appears on:Topic)
EventGrid Topic
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
endpoint string |
Endpoint: Endpoint for the topic. |
id string |
Id: Fully qualified identifier of the resource. |
inboundIpRules []InboundIpRule_STATUS |
InboundIpRules: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. |
inputSchema TopicProperties_InputSchema_STATUS |
InputSchema: This determines the format that Event Grid should expect for incoming events published to the topic. |
inputSchemaMapping InputSchemaMapping_STATUS |
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. |
location string |
Location: Location of the resource. |
metricResourceId string |
MetricResourceId: Metric resource id for the topic. |
name string |
Name: Name of the resource. |
privateEndpointConnections []PrivateEndpointConnection_STATUS_Topic_SubResourceEmbedded |
|
provisioningState TopicProperties_ProvisioningState_STATUS |
ProvisioningState: Provisioning state of the topic. |
publicNetworkAccess TopicProperties_PublicNetworkAccess_STATUS |
PublicNetworkAccess: This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring |
systemData SystemData_STATUS |
SystemData: The system metadata relating to Topic resource. |
tags map[string]string |
Tags: Tags of the resource. |
type string |
Type: Type of the resource. |
Topic_Spec
(Appears on:Topic)
Field | Description |
---|---|
azureName string |
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. |
inboundIpRules []InboundIpRule |
InboundIpRules: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. |
inputSchema TopicProperties_InputSchema |
InputSchema: This determines the format that Event Grid should expect for incoming events published to the topic. |
inputSchemaMapping InputSchemaMapping |
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. |
location string |
Location: Location of the resource. |
operatorSpec TopicOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
publicNetworkAccess TopicProperties_PublicNetworkAccess |
PublicNetworkAccess: This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring |
tags map[string]string |
Tags: Tags of the resource. |
WebHookEventSubscriptionDestination
(Appears on:EventSubscriptionDestination)
Field | Description |
---|---|
azureActiveDirectoryApplicationIdOrUri string |
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. |
azureActiveDirectoryTenantId string |
AzureActiveDirectoryTenantId: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. |
endpointType WebHookEventSubscriptionDestination_EndpointType |
EndpointType: Type of the endpoint for the event subscription destination. |
endpointUrl genruntime.SecretReference |
EndpointUrl: The URL that represents the endpoint of the destination of an event subscription. |
maxEventsPerBatch int |
MaxEventsPerBatch: Maximum number of events per batch. |
preferredBatchSizeInKilobytes int |
PreferredBatchSizeInKilobytes: Preferred batch size in Kilobytes. |
WebHookEventSubscriptionDestination_EndpointType
(string
alias)
(Appears on:WebHookEventSubscriptionDestination)
Value | Description |
---|---|
"WebHook" |
WebHookEventSubscriptionDestination_EndpointType_STATUS
(string
alias)
(Appears on:WebHookEventSubscriptionDestination_STATUS)
Value | Description |
---|---|
"WebHook" |
WebHookEventSubscriptionDestination_STATUS
(Appears on:EventSubscriptionDestination_STATUS)
Field | Description |
---|---|
azureActiveDirectoryApplicationIdOrUri string |
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. |
azureActiveDirectoryTenantId string |
AzureActiveDirectoryTenantId: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. |
endpointBaseUrl string |
EndpointBaseUrl: The base URL that represents the endpoint of the destination of an event subscription. |
endpointType WebHookEventSubscriptionDestination_EndpointType_STATUS |
EndpointType: Type of the endpoint for the event subscription destination. |
maxEventsPerBatch int |
MaxEventsPerBatch: Maximum number of events per batch. |
preferredBatchSizeInKilobytes int |
PreferredBatchSizeInKilobytes: Preferred batch size in Kilobytes. |