eventgrid.azure.com/v1beta20200601
eventgrid.azure.com/v1beta20200601
Package v1beta20200601 contains API Schema definitions for the eventgrid v1beta20200601 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2020-06-01" |
AdvancedFilter
(Appears on:EventSubscriptionFilter)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/AdvancedFilter
Field | Description |
---|---|
boolEqualsAdvancedFilter AdvancedFilter_BoolEquals |
BoolEquals: Mutually exclusive with all other properties |
numberGreaterThanAdvancedFilter AdvancedFilter_NumberGreaterThan |
NumberGreaterThan: Mutually exclusive with all other properties |
numberGreaterThanOrEqualsAdvancedFilter AdvancedFilter_NumberGreaterThanOrEquals |
NumberGreaterThanOrEquals: Mutually exclusive with all other properties |
numberInAdvancedFilter AdvancedFilter_NumberIn |
NumberIn: Mutually exclusive with all other properties |
numberLessThanAdvancedFilter AdvancedFilter_NumberLessThan |
NumberLessThan: Mutually exclusive with all other properties |
numberLessThanOrEqualsAdvancedFilter AdvancedFilter_NumberLessThanOrEquals |
NumberLessThanOrEquals: Mutually exclusive with all other properties |
numberNotInAdvancedFilter AdvancedFilter_NumberNotIn |
NumberNotIn: Mutually exclusive with all other properties |
stringBeginsWithAdvancedFilter AdvancedFilter_StringBeginsWith |
StringBeginsWith: Mutually exclusive with all other properties |
stringContainsAdvancedFilter AdvancedFilter_StringContains |
StringContains: Mutually exclusive with all other properties |
stringEndsWithAdvancedFilter AdvancedFilter_StringEndsWith |
StringEndsWith: Mutually exclusive with all other properties |
stringInAdvancedFilter AdvancedFilter_StringIn |
StringIn: Mutually exclusive with all other properties |
stringNotInAdvancedFilter AdvancedFilter_StringNotIn |
StringNotIn: Mutually exclusive with all other properties |
AdvancedFilterARM
(Appears on:EventSubscriptionFilterARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/AdvancedFilter
Field | Description |
---|---|
boolEqualsAdvancedFilter AdvancedFilter_BoolEqualsARM |
BoolEquals: Mutually exclusive with all other properties |
numberGreaterThanAdvancedFilter AdvancedFilter_NumberGreaterThanARM |
NumberGreaterThan: Mutually exclusive with all other properties |
numberGreaterThanOrEqualsAdvancedFilter AdvancedFilter_NumberGreaterThanOrEqualsARM |
NumberGreaterThanOrEquals: Mutually exclusive with all other properties |
numberInAdvancedFilter AdvancedFilter_NumberInARM |
NumberIn: Mutually exclusive with all other properties |
numberLessThanAdvancedFilter AdvancedFilter_NumberLessThanARM |
NumberLessThan: Mutually exclusive with all other properties |
numberLessThanOrEqualsAdvancedFilter AdvancedFilter_NumberLessThanOrEqualsARM |
NumberLessThanOrEquals: Mutually exclusive with all other properties |
numberNotInAdvancedFilter AdvancedFilter_NumberNotInARM |
NumberNotIn: Mutually exclusive with all other properties |
stringBeginsWithAdvancedFilter AdvancedFilter_StringBeginsWithARM |
StringBeginsWith: Mutually exclusive with all other properties |
stringContainsAdvancedFilter AdvancedFilter_StringContainsARM |
StringContains: Mutually exclusive with all other properties |
stringEndsWithAdvancedFilter AdvancedFilter_StringEndsWithARM |
StringEndsWith: Mutually exclusive with all other properties |
stringInAdvancedFilter AdvancedFilter_StringInARM |
StringIn: Mutually exclusive with all other properties |
stringNotInAdvancedFilter AdvancedFilter_StringNotInARM |
StringNotIn: Mutually exclusive with all other properties |
AdvancedFilterBoolEqualsOperatorType
(string
alias)
(Appears on:AdvancedFilter_BoolEquals, AdvancedFilter_BoolEqualsARM)
Value | Description |
---|---|
"BoolEquals" |
AdvancedFilterNumberGreaterThanOperatorType
(string
alias)
(Appears on:AdvancedFilter_NumberGreaterThan, AdvancedFilter_NumberGreaterThanARM)
Value | Description |
---|---|
"NumberGreaterThan" |
AdvancedFilterNumberGreaterThanOrEqualsOperatorType
(string
alias)
(Appears on:AdvancedFilter_NumberGreaterThanOrEquals, AdvancedFilter_NumberGreaterThanOrEqualsARM)
Value | Description |
---|---|
"NumberGreaterThanOrEquals" |
AdvancedFilterNumberInOperatorType
(string
alias)
(Appears on:AdvancedFilter_NumberIn, AdvancedFilter_NumberInARM)
Value | Description |
---|---|
"NumberIn" |
AdvancedFilterNumberLessThanOperatorType
(string
alias)
(Appears on:AdvancedFilter_NumberLessThan, AdvancedFilter_NumberLessThanARM)
Value | Description |
---|---|
"NumberLessThan" |
AdvancedFilterNumberLessThanOrEqualsOperatorType
(string
alias)
(Appears on:AdvancedFilter_NumberLessThanOrEquals, AdvancedFilter_NumberLessThanOrEqualsARM)
Value | Description |
---|---|
"NumberLessThanOrEquals" |
AdvancedFilterNumberNotInOperatorType
(string
alias)
(Appears on:AdvancedFilter_NumberNotIn, AdvancedFilter_NumberNotInARM)
Value | Description |
---|---|
"NumberNotIn" |
AdvancedFilterStatusOperatorType
(string
alias)
(Appears on:AdvancedFilter_Status, AdvancedFilter_StatusARM)
Value | Description |
---|---|
"BoolEquals" |
|
"NumberGreaterThan" |
|
"NumberGreaterThanOrEquals" |
|
"NumberIn" |
|
"NumberLessThan" |
|
"NumberLessThanOrEquals" |
|
"NumberNotIn" |
|
"StringBeginsWith" |
|
"StringContains" |
|
"StringEndsWith" |
|
"StringIn" |
|
"StringNotIn" |
AdvancedFilterStringBeginsWithOperatorType
(string
alias)
(Appears on:AdvancedFilter_StringBeginsWith, AdvancedFilter_StringBeginsWithARM)
Value | Description |
---|---|
"StringBeginsWith" |
AdvancedFilterStringContainsOperatorType
(string
alias)
(Appears on:AdvancedFilter_StringContains, AdvancedFilter_StringContainsARM)
Value | Description |
---|---|
"StringContains" |
AdvancedFilterStringEndsWithOperatorType
(string
alias)
(Appears on:AdvancedFilter_StringEndsWith, AdvancedFilter_StringEndsWithARM)
Value | Description |
---|---|
"StringEndsWith" |
AdvancedFilterStringInOperatorType
(string
alias)
(Appears on:AdvancedFilter_StringIn, AdvancedFilter_StringInARM)
Value | Description |
---|---|
"StringIn" |
AdvancedFilterStringNotInOperatorType
(string
alias)
(Appears on:AdvancedFilter_StringNotIn, AdvancedFilter_StringNotInARM)
Value | Description |
---|---|
"StringNotIn" |
AdvancedFilter_BoolEquals
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterBoolEqualsOperatorType |
|
value bool |
Value: The boolean filter value. |
AdvancedFilter_BoolEqualsARM
(Appears on:AdvancedFilterARM)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterBoolEqualsOperatorType |
|
value bool |
Value: The boolean filter value. |
AdvancedFilter_NumberGreaterThan
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterNumberGreaterThanOperatorType |
|
value float64 |
Value: The filter value. |
AdvancedFilter_NumberGreaterThanARM
(Appears on:AdvancedFilterARM)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterNumberGreaterThanOperatorType |
|
value float64 |
Value: The filter value. |
AdvancedFilter_NumberGreaterThanOrEquals
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterNumberGreaterThanOrEqualsOperatorType |
|
value float64 |
Value: The filter value. |
AdvancedFilter_NumberGreaterThanOrEqualsARM
(Appears on:AdvancedFilterARM)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterNumberGreaterThanOrEqualsOperatorType |
|
value float64 |
Value: The filter value. |
AdvancedFilter_NumberIn
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterNumberInOperatorType |
|
values []float64 |
Values: The set of filter values. |
AdvancedFilter_NumberInARM
(Appears on:AdvancedFilterARM)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterNumberInOperatorType |
|
values []float64 |
Values: The set of filter values. |
AdvancedFilter_NumberLessThan
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterNumberLessThanOperatorType |
|
value float64 |
Value: The filter value. |
AdvancedFilter_NumberLessThanARM
(Appears on:AdvancedFilterARM)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterNumberLessThanOperatorType |
|
value float64 |
Value: The filter value. |
AdvancedFilter_NumberLessThanOrEquals
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterNumberLessThanOrEqualsOperatorType |
|
value float64 |
Value: The filter value. |
AdvancedFilter_NumberLessThanOrEqualsARM
(Appears on:AdvancedFilterARM)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterNumberLessThanOrEqualsOperatorType |
|
value float64 |
Value: The filter value. |
AdvancedFilter_NumberNotIn
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterNumberNotInOperatorType |
|
values []float64 |
Values: The set of filter values. |
AdvancedFilter_NumberNotInARM
(Appears on:AdvancedFilterARM)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterNumberNotInOperatorType |
|
values []float64 |
Values: The set of filter values. |
AdvancedFilter_Status
(Appears on:EventSubscriptionFilter_Status)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterStatusOperatorType |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
AdvancedFilter_StatusARM
(Appears on:EventSubscriptionFilter_StatusARM)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterStatusOperatorType |
OperatorType: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
AdvancedFilter_StringBeginsWith
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterStringBeginsWithOperatorType |
|
values []string |
Values: The set of filter values. |
AdvancedFilter_StringBeginsWithARM
(Appears on:AdvancedFilterARM)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterStringBeginsWithOperatorType |
|
values []string |
Values: The set of filter values. |
AdvancedFilter_StringContains
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterStringContainsOperatorType |
|
values []string |
Values: The set of filter values. |
AdvancedFilter_StringContainsARM
(Appears on:AdvancedFilterARM)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterStringContainsOperatorType |
|
values []string |
Values: The set of filter values. |
AdvancedFilter_StringEndsWith
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterStringEndsWithOperatorType |
|
values []string |
Values: The set of filter values. |
AdvancedFilter_StringEndsWithARM
(Appears on:AdvancedFilterARM)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterStringEndsWithOperatorType |
|
values []string |
Values: The set of filter values. |
AdvancedFilter_StringIn
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterStringInOperatorType |
|
values []string |
Values: The set of filter values. |
AdvancedFilter_StringInARM
(Appears on:AdvancedFilterARM)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterStringInOperatorType |
|
values []string |
Values: The set of filter values. |
AdvancedFilter_StringNotIn
(Appears on:AdvancedFilter)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterStringNotInOperatorType |
|
values []string |
Values: The set of filter values. |
AdvancedFilter_StringNotInARM
(Appears on:AdvancedFilterARM)
Field | Description |
---|---|
key string |
Key: The field/property in the event based on which you want to filter. |
operatorType AdvancedFilterStringNotInOperatorType |
|
values []string |
Values: The set of filter values. |
AzureFunctionEventSubscriptionDestination
(Appears on:EventSubscriptionDestination)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/AzureFunctionEventSubscriptionDestination
Field | Description |
---|---|
endpointType AzureFunctionEventSubscriptionDestinationEndpointType |
|
properties AzureFunctionEventSubscriptionDestinationProperties |
Properties: The properties that represent the Azure Function destination of an event subscription. |
AzureFunctionEventSubscriptionDestinationARM
(Appears on:EventSubscriptionDestinationARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/AzureFunctionEventSubscriptionDestination
Field | Description |
---|---|
endpointType AzureFunctionEventSubscriptionDestinationEndpointType |
|
properties AzureFunctionEventSubscriptionDestinationPropertiesARM |
Properties: The properties that represent the Azure Function destination of an event subscription. |
AzureFunctionEventSubscriptionDestinationEndpointType
(string
alias)
(Appears on:AzureFunctionEventSubscriptionDestination, AzureFunctionEventSubscriptionDestinationARM)
Value | Description |
---|---|
"AzureFunction" |
AzureFunctionEventSubscriptionDestinationProperties
(Appears on:AzureFunctionEventSubscriptionDestination)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/AzureFunctionEventSubscriptionDestinationProperties
Field | Description |
---|---|
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. |
AzureFunctionEventSubscriptionDestinationPropertiesARM
(Appears on:AzureFunctionEventSubscriptionDestinationARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/AzureFunctionEventSubscriptionDestinationProperties
Field | Description |
---|---|
maxEventsPerBatch int |
MaxEventsPerBatch: Maximum number of events per batch. |
preferredBatchSizeInKilobytes int |
PreferredBatchSizeInKilobytes: Preferred batch size in Kilobytes. |
resourceId string |
DeadLetterDestinationStatusEndpointType
(string
alias)
(Appears on:DeadLetterDestination_Status, DeadLetterDestination_StatusARM)
Value | Description |
---|---|
"StorageBlob" |
DeadLetterDestination_Status
(Appears on:EventSubscription_Status)
Field | Description |
---|---|
endpointType DeadLetterDestinationStatusEndpointType |
EndpointType: Type of the endpoint for the dead letter destination |
DeadLetterDestination_StatusARM
(Appears on:EventSubscriptionProperties_StatusARM)
Field | Description |
---|---|
endpointType DeadLetterDestinationStatusEndpointType |
EndpointType: Type of the endpoint for the dead letter destination |
Domain
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/resourceDefinitions/domains
Field | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||
spec Domains_Spec |
|
||||||||||||||||
status Domain_Status |
DomainPropertiesARM
(Appears on:Domains_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/DomainProperties
Field | Description |
---|---|
inboundIpRules []InboundIpRuleARM |
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 DomainPropertiesInputSchema |
InputSchema: This determines the format that Event Grid should expect for incoming events published to the domain. |
inputSchemaMapping JsonInputSchemaMappingARM |
InputSchemaMapping: By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only supported type of InputSchemaMapping is ‘JsonInputSchemaMapping’. |
publicNetworkAccess DomainPropertiesPublicNetworkAccess |
PublicNetworkAccess: This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring |
DomainPropertiesInputSchema
(string
alias)
(Appears on:DomainPropertiesARM, Domains_Spec)
Value | Description |
---|---|
"CloudEventSchemaV1_0" |
|
"CustomEventSchema" |
|
"EventGridSchema" |
DomainPropertiesPublicNetworkAccess
(string
alias)
(Appears on:DomainPropertiesARM, Domains_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
DomainPropertiesStatusInputSchema
(string
alias)
(Appears on:DomainProperties_StatusARM, Domain_Status)
Value | Description |
---|---|
"CloudEventSchemaV1_0" |
|
"CustomEventSchema" |
|
"EventGridSchema" |
DomainPropertiesStatusProvisioningState
(string
alias)
(Appears on:DomainProperties_StatusARM, Domain_Status)
Value | Description |
---|---|
"Canceled" |
|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
DomainPropertiesStatusPublicNetworkAccess
(string
alias)
(Appears on:DomainProperties_StatusARM, Domain_Status)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
DomainProperties_StatusARM
(Appears on:Domain_StatusARM)
Field | Description |
---|---|
endpoint string |
Endpoint: Endpoint for the domain. |
inboundIpRules []InboundIpRule_StatusARM |
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 DomainPropertiesStatusInputSchema |
InputSchema: This determines the format that Event Grid should expect for incoming events published to the domain. |
inputSchemaMapping InputSchemaMapping_StatusARM |
InputSchemaMapping: Information about the InputSchemaMapping which specified the info about mapping event payload. |
metricResourceId string |
MetricResourceId: Metric resource id for the domain. |
privateEndpointConnections []PrivateEndpointConnection_Status_Domain_SubResourceEmbeddedARM |
PrivateEndpointConnections: List of private endpoint connections. |
provisioningState DomainPropertiesStatusProvisioningState |
ProvisioningState: Provisioning state of the domain. |
publicNetworkAccess DomainPropertiesStatusPublicNetworkAccess |
PublicNetworkAccess: This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring |
DomainTopicPropertiesStatusProvisioningState
(string
alias)
(Appears on:DomainTopicProperties_StatusARM, DomainTopic_Status)
Value | Description |
---|---|
"Canceled" |
|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
DomainTopicProperties_StatusARM
(Appears on:DomainTopic_StatusARM)
Field | Description |
---|---|
provisioningState DomainTopicPropertiesStatusProvisioningState |
ProvisioningState: Provisioning state of the domain topic. |
DomainTopic_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 DomainTopicPropertiesStatusProvisioningState |
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. |
DomainTopic_StatusARM
Field | Description |
---|---|
id string |
Id: Fully qualified identifier of the resource. |
name string |
Name: Name of the resource. |
properties DomainTopicProperties_StatusARM |
Properties: Properties of the Domain Topic. |
systemData SystemData_StatusARM |
SystemData: The system metadata relating to Domain Topic resource. |
type string |
Type: Type of the resource. |
Domain_Status
(Appears on: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 DomainPropertiesStatusInputSchema |
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 DomainPropertiesStatusProvisioningState |
ProvisioningState: Provisioning state of the domain. |
publicNetworkAccess DomainPropertiesStatusPublicNetworkAccess |
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_StatusARM
Field | Description |
---|---|
id string |
Id: Fully qualified identifier of the resource. |
location string |
Location: Location of the resource. |
name string |
Name: Name of the resource. |
properties DomainProperties_StatusARM |
Properties: Properties of the domain. |
systemData SystemData_StatusARM |
SystemData: The system metadata relating to Domain resource. |
tags map[string]string |
Tags: Tags of the resource. |
type string |
Type: Type of the resource. |
DomainsTopic
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/resourceDefinitions/domains_topics
Field | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
spec DomainsTopics_Spec |
|
||||||||
status DomainTopic_Status |
DomainsTopics_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. |
location string |
Location: Location to deploy resource to |
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 |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
DomainsTopics_SpecARM
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
name string |
Name: Name of the domain topic. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
Domains_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 DomainPropertiesInputSchema |
InputSchema: This determines the format that Event Grid should expect for incoming events published to the domain. |
inputSchemaMapping JsonInputSchemaMapping |
InputSchemaMapping: By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only supported type of InputSchemaMapping is ‘JsonInputSchemaMapping’. |
location string |
Location: Location to deploy resource to |
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 DomainPropertiesPublicNetworkAccess |
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: Name-value pairs to add to the resource |
Domains_SpecARM
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
name string |
Name: Name of the resource |
properties DomainPropertiesARM |
Properties: Properties of the Domain. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
EventHubEventSubscriptionDestination
(Appears on:EventSubscriptionDestination)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/EventHubEventSubscriptionDestination
Field | Description |
---|---|
endpointType EventHubEventSubscriptionDestinationEndpointType |
|
properties EventHubEventSubscriptionDestinationProperties |
Properties: The properties for a event hub destination. |
EventHubEventSubscriptionDestinationARM
(Appears on:EventSubscriptionDestinationARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/EventHubEventSubscriptionDestination
Field | Description |
---|---|
endpointType EventHubEventSubscriptionDestinationEndpointType |
|
properties EventHubEventSubscriptionDestinationPropertiesARM |
Properties: The properties for a event hub destination. |
EventHubEventSubscriptionDestinationEndpointType
(string
alias)
(Appears on:EventHubEventSubscriptionDestination, EventHubEventSubscriptionDestinationARM)
Value | Description |
---|---|
"EventHub" |
EventHubEventSubscriptionDestinationProperties
(Appears on:EventHubEventSubscriptionDestination)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/EventHubEventSubscriptionDestinationProperties
Field | Description |
---|---|
resourceReference genruntime.ResourceReference |
ResourceReference: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. |
EventHubEventSubscriptionDestinationPropertiesARM
(Appears on:EventHubEventSubscriptionDestinationARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/EventHubEventSubscriptionDestinationProperties
Field | Description |
---|---|
resourceId string |
EventSubscription
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/unknown_resourceDefinitions/eventSubscriptions
Field | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||
spec EventSubscriptions_Spec |
|
||||||||||||||||||||||
status EventSubscription_Status |
EventSubscriptionDestination
(Appears on:EventSubscriptions_Spec)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/EventSubscriptionDestination
Field | Description |
---|---|
azureFunctionEventSubscriptionDestination AzureFunctionEventSubscriptionDestination |
AzureFunction: Mutually exclusive with all other properties |
eventHubEventSubscriptionDestination EventHubEventSubscriptionDestination |
EventHub: Mutually exclusive with all other properties |
hybridConnectionEventSubscriptionDestination HybridConnectionEventSubscriptionDestination |
HybridConnection: Mutually exclusive with all other properties |
serviceBusQueueEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestination |
ServiceBusQueue: Mutually exclusive with all other properties |
serviceBusTopicEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestination |
ServiceBusTopic: Mutually exclusive with all other properties |
storageQueueEventSubscriptionDestination StorageQueueEventSubscriptionDestination |
StorageQueue: Mutually exclusive with all other properties |
webHookEventSubscriptionDestination WebHookEventSubscriptionDestination |
WebHook: Mutually exclusive with all other properties |
EventSubscriptionDestinationARM
(Appears on:EventSubscriptionPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/EventSubscriptionDestination
Field | Description |
---|---|
azureFunctionEventSubscriptionDestination AzureFunctionEventSubscriptionDestinationARM |
AzureFunction: Mutually exclusive with all other properties |
eventHubEventSubscriptionDestination EventHubEventSubscriptionDestinationARM |
EventHub: Mutually exclusive with all other properties |
hybridConnectionEventSubscriptionDestination HybridConnectionEventSubscriptionDestinationARM |
HybridConnection: Mutually exclusive with all other properties |
serviceBusQueueEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestinationARM |
ServiceBusQueue: Mutually exclusive with all other properties |
serviceBusTopicEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestinationARM |
ServiceBusTopic: Mutually exclusive with all other properties |
storageQueueEventSubscriptionDestination StorageQueueEventSubscriptionDestinationARM |
StorageQueue: Mutually exclusive with all other properties |
webHookEventSubscriptionDestination WebHookEventSubscriptionDestinationARM |
WebHook: Mutually exclusive with all other properties |
EventSubscriptionDestinationStatusEndpointType
(string
alias)
(Appears on:EventSubscriptionDestination_Status, EventSubscriptionDestination_StatusARM)
Value | Description |
---|---|
"AzureFunction" |
|
"EventHub" |
|
"HybridConnection" |
|
"ServiceBusQueue" |
|
"ServiceBusTopic" |
|
"StorageQueue" |
|
"WebHook" |
EventSubscriptionDestination_Status
(Appears on:EventSubscription_Status)
Field | Description |
---|---|
endpointType EventSubscriptionDestinationStatusEndpointType |
EndpointType: Type of the endpoint for the event subscription destination. |
EventSubscriptionDestination_StatusARM
(Appears on:EventSubscriptionProperties_StatusARM)
Field | Description |
---|---|
endpointType EventSubscriptionDestinationStatusEndpointType |
EndpointType: Type of the endpoint for the event subscription destination. |
EventSubscriptionFilter
(Appears on:EventSubscriptions_Spec)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/EventSubscriptionFilter
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. |
EventSubscriptionFilterARM
(Appears on:EventSubscriptionPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/EventSubscriptionFilter
Field | Description |
---|---|
advancedFilters []AdvancedFilterARM |
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)
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. |
EventSubscriptionFilter_StatusARM
(Appears on:EventSubscriptionProperties_StatusARM)
Field | Description |
---|---|
advancedFilters []AdvancedFilter_StatusARM |
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. |
EventSubscriptionPropertiesARM
(Appears on:EventSubscriptions_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/EventSubscriptionProperties
Field | Description |
---|---|
deadLetterDestination StorageBlobDeadLetterDestinationARM |
DeadLetterDestination: Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class. |
destination EventSubscriptionDestinationARM |
Destination: Information about the destination for an event subscription. |
eventDeliverySchema EventSubscriptionPropertiesEventDeliverySchema |
EventDeliverySchema: The event delivery schema for the event subscription. |
expirationTimeUtc string |
ExpirationTimeUtc: Expiration time of the event subscription. |
filter EventSubscriptionFilterARM |
Filter: Filter for the Event Subscription. |
labels []string |
Labels: List of user defined labels. |
retryPolicy RetryPolicyARM |
RetryPolicy: Information about the retry policy for an event subscription. |
EventSubscriptionPropertiesEventDeliverySchema
(string
alias)
(Appears on:EventSubscriptionPropertiesARM, EventSubscriptions_Spec)
Value | Description |
---|---|
"CloudEventSchemaV1_0" |
|
"CustomInputSchema" |
|
"EventGridSchema" |
EventSubscriptionPropertiesStatusEventDeliverySchema
(string
alias)
(Appears on:EventSubscriptionProperties_StatusARM, EventSubscription_Status)
Value | Description |
---|---|
"CloudEventSchemaV1_0" |
|
"CustomInputSchema" |
|
"EventGridSchema" |
EventSubscriptionPropertiesStatusProvisioningState
(string
alias)
(Appears on:EventSubscriptionProperties_StatusARM, EventSubscription_Status)
Value | Description |
---|---|
"AwaitingManualAction" |
|
"Canceled" |
|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
EventSubscriptionProperties_StatusARM
(Appears on:EventSubscription_StatusARM)
Field | Description |
---|---|
deadLetterDestination DeadLetterDestination_StatusARM |
DeadLetterDestination: The DeadLetter destination of the event subscription. |
destination EventSubscriptionDestination_StatusARM |
Destination: Information about the destination where events have to be delivered for the event subscription. |
eventDeliverySchema EventSubscriptionPropertiesStatusEventDeliverySchema |
EventDeliverySchema: The event delivery schema for the event subscription. |
expirationTimeUtc string |
ExpirationTimeUtc: Expiration time of the event subscription. |
filter EventSubscriptionFilter_StatusARM |
Filter: Information about the filter for the event subscription. |
labels []string |
Labels: List of user defined labels. |
provisioningState EventSubscriptionPropertiesStatusProvisioningState |
ProvisioningState: Provisioning state of the event subscription. |
retryPolicy RetryPolicy_StatusARM |
RetryPolicy: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. |
topic string |
Topic: Name of the topic of the event subscription. |
EventSubscription_Status
(Appears on:EventSubscription)
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 EventSubscriptionPropertiesStatusEventDeliverySchema |
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 EventSubscriptionPropertiesStatusProvisioningState |
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_StatusARM
Field | Description |
---|---|
id string |
Id: Fully qualified identifier of the resource. |
name string |
Name: Name of the resource. |
properties EventSubscriptionProperties_StatusARM |
Properties: Properties of the event subscription. |
systemData SystemData_StatusARM |
SystemData: The system metadata relating to Event Subscription resource. |
type string |
Type: Type of the resource. |
EventSubscriptions_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 StorageBlobDeadLetterDestination |
DeadLetterDestination: Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class. |
destination EventSubscriptionDestination |
Destination: Information about the destination for an event subscription. |
eventDeliverySchema EventSubscriptionPropertiesEventDeliverySchema |
EventDeliverySchema: The event delivery schema for the event subscription. |
expirationTimeUtc string |
ExpirationTimeUtc: Expiration time of the event subscription. |
filter EventSubscriptionFilter |
Filter: Filter for the Event Subscription. |
labels []string |
Labels: List of user defined labels. |
location string |
Location: Location to deploy resource to |
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: Information about the retry policy for an event subscription. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
EventSubscriptions_SpecARM
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
name string |
Name: Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only. |
properties EventSubscriptionPropertiesARM |
Properties: Properties of the Event Subscription. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
HybridConnectionEventSubscriptionDestination
(Appears on:EventSubscriptionDestination)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/HybridConnectionEventSubscriptionDestination
Field | Description |
---|---|
endpointType HybridConnectionEventSubscriptionDestinationEndpointType |
|
properties HybridConnectionEventSubscriptionDestinationProperties |
Properties: The properties for a hybrid connection destination. |
HybridConnectionEventSubscriptionDestinationARM
(Appears on:EventSubscriptionDestinationARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/HybridConnectionEventSubscriptionDestination
Field | Description |
---|---|
endpointType HybridConnectionEventSubscriptionDestinationEndpointType |
|
properties HybridConnectionEventSubscriptionDestinationPropertiesARM |
Properties: The properties for a hybrid connection destination. |
HybridConnectionEventSubscriptionDestinationEndpointType
(string
alias)
(Appears on:HybridConnectionEventSubscriptionDestination, HybridConnectionEventSubscriptionDestinationARM)
Value | Description |
---|---|
"HybridConnection" |
HybridConnectionEventSubscriptionDestinationProperties
(Appears on:HybridConnectionEventSubscriptionDestination)
Field | Description |
---|---|
resourceReference genruntime.ResourceReference |
ResourceReference: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. |
HybridConnectionEventSubscriptionDestinationPropertiesARM
(Appears on:HybridConnectionEventSubscriptionDestinationARM)
Field | Description |
---|---|
resourceId string |
InboundIpRule
(Appears on:Domains_Spec)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/InboundIpRule
Field | Description |
---|---|
action InboundIpRuleAction |
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. |
InboundIpRuleARM
(Appears on:DomainPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/InboundIpRule
Field | Description |
---|---|
action InboundIpRuleAction |
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. |
InboundIpRuleAction
(string
alias)
(Appears on:InboundIpRule, InboundIpRuleARM)
Value | Description |
---|---|
"Allow" |
InboundIpRuleStatusAction
(string
alias)
(Appears on:InboundIpRule_Status, InboundIpRule_StatusARM)
Value | Description |
---|---|
"Allow" |
InboundIpRule_Status
(Appears on:Domain_Status, Topic_Status)
Field | Description |
---|---|
action InboundIpRuleStatusAction |
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_StatusARM
(Appears on:DomainProperties_StatusARM, TopicProperties_StatusARM)
Field | Description |
---|---|
action InboundIpRuleStatusAction |
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. |
InputSchemaMappingStatusInputSchemaMappingType
(string
alias)
(Appears on:InputSchemaMapping_Status, InputSchemaMapping_StatusARM)
Value | Description |
---|---|
"Json" |
InputSchemaMapping_Status
(Appears on:Domain_Status, Topic_Status)
Field | Description |
---|---|
inputSchemaMappingType InputSchemaMappingStatusInputSchemaMappingType |
InputSchemaMappingType: Type of the custom mapping |
InputSchemaMapping_StatusARM
(Appears on:DomainProperties_StatusARM, TopicProperties_StatusARM)
Field | Description |
---|---|
inputSchemaMappingType InputSchemaMappingStatusInputSchemaMappingType |
InputSchemaMappingType: Type of the custom mapping |
JsonField
(Appears on:JsonInputSchemaMappingProperties)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/JsonField
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. |
JsonFieldARM
(Appears on:JsonInputSchemaMappingPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/JsonField
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:JsonInputSchemaMappingProperties)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/JsonFieldWithDefault
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. |
JsonFieldWithDefaultARM
(Appears on:JsonInputSchemaMappingPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/JsonFieldWithDefault
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. |
JsonInputSchemaMapping
(Appears on:Domains_Spec)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/JsonInputSchemaMapping
Field | Description |
---|---|
inputSchemaMappingType JsonInputSchemaMappingInputSchemaMappingType |
|
properties JsonInputSchemaMappingProperties |
Properties: This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. |
JsonInputSchemaMappingARM
(Appears on:DomainPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/JsonInputSchemaMapping
Field | Description |
---|---|
inputSchemaMappingType JsonInputSchemaMappingInputSchemaMappingType |
|
properties JsonInputSchemaMappingPropertiesARM |
Properties: This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. |
JsonInputSchemaMappingInputSchemaMappingType
(string
alias)
(Appears on:JsonInputSchemaMapping, JsonInputSchemaMappingARM)
Value | Description |
---|---|
"Json" |
JsonInputSchemaMappingProperties
(Appears on:JsonInputSchemaMapping)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/JsonInputSchemaMappingProperties
Field | Description |
---|---|
dataVersion JsonFieldWithDefault |
DataVersion: 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. |
eventTime JsonField |
EventTime: 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. |
eventType JsonFieldWithDefault |
EventType: 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. |
id JsonField |
Id: 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. |
subject JsonFieldWithDefault |
Subject: 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. |
topic JsonField |
Topic: 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. |
JsonInputSchemaMappingPropertiesARM
(Appears on:JsonInputSchemaMappingARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/JsonInputSchemaMappingProperties
Field | Description |
---|---|
dataVersion JsonFieldWithDefaultARM |
DataVersion: 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. |
eventTime JsonFieldARM |
EventTime: 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. |
eventType JsonFieldWithDefaultARM |
EventType: 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. |
id JsonFieldARM |
Id: 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. |
subject JsonFieldWithDefaultARM |
Subject: 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. |
topic JsonFieldARM |
Topic: 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. |
PrivateEndpointConnection_Status_Domain_SubResourceEmbedded
(Appears on:Domain_Status)
Field | Description |
---|---|
id string |
Id: Fully qualified identifier of the resource. |
PrivateEndpointConnection_Status_Domain_SubResourceEmbeddedARM
(Appears on:DomainProperties_StatusARM)
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. |
PrivateEndpointConnection_Status_Topic_SubResourceEmbeddedARM
(Appears on:TopicProperties_StatusARM)
Field | Description |
---|---|
id string |
Id: Fully qualified identifier of the resource. |
RetryPolicy
(Appears on:EventSubscriptions_Spec)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/RetryPolicy
Field | Description |
---|---|
eventTimeToLiveInMinutes int |
EventTimeToLiveInMinutes: Time To Live (in minutes) for events. |
maxDeliveryAttempts int |
MaxDeliveryAttempts: Maximum number of delivery retry attempts for events. |
RetryPolicyARM
(Appears on:EventSubscriptionPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/RetryPolicy
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)
Field | Description |
---|---|
eventTimeToLiveInMinutes int |
EventTimeToLiveInMinutes: Time To Live (in minutes) for events. |
maxDeliveryAttempts int |
MaxDeliveryAttempts: Maximum number of delivery retry attempts for events. |
RetryPolicy_StatusARM
(Appears on:EventSubscriptionProperties_StatusARM)
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)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/ServiceBusQueueEventSubscriptionDestination
Field | Description |
---|---|
endpointType ServiceBusQueueEventSubscriptionDestinationEndpointType |
|
properties ServiceBusQueueEventSubscriptionDestinationProperties |
Properties: The properties that represent the Service Bus destination of an event subscription. |
ServiceBusQueueEventSubscriptionDestinationARM
(Appears on:EventSubscriptionDestinationARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/ServiceBusQueueEventSubscriptionDestination
Field | Description |
---|---|
endpointType ServiceBusQueueEventSubscriptionDestinationEndpointType |
|
properties ServiceBusQueueEventSubscriptionDestinationPropertiesARM |
Properties: The properties that represent the Service Bus destination of an event subscription. |
ServiceBusQueueEventSubscriptionDestinationEndpointType
(string
alias)
(Appears on:ServiceBusQueueEventSubscriptionDestination, ServiceBusQueueEventSubscriptionDestinationARM)
Value | Description |
---|---|
"ServiceBusQueue" |
ServiceBusQueueEventSubscriptionDestinationProperties
(Appears on:ServiceBusQueueEventSubscriptionDestination)
Field | Description |
---|---|
resourceReference genruntime.ResourceReference |
ResourceReference: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. |
ServiceBusQueueEventSubscriptionDestinationPropertiesARM
(Appears on:ServiceBusQueueEventSubscriptionDestinationARM)
Field | Description |
---|---|
resourceId string |
ServiceBusTopicEventSubscriptionDestination
(Appears on:EventSubscriptionDestination)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/ServiceBusTopicEventSubscriptionDestination
Field | Description |
---|---|
endpointType ServiceBusTopicEventSubscriptionDestinationEndpointType |
|
properties ServiceBusTopicEventSubscriptionDestinationProperties |
Properties: The properties that represent the Service Bus Topic destination of an event subscription. |
ServiceBusTopicEventSubscriptionDestinationARM
(Appears on:EventSubscriptionDestinationARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/ServiceBusTopicEventSubscriptionDestination
Field | Description |
---|---|
endpointType ServiceBusTopicEventSubscriptionDestinationEndpointType |
|
properties ServiceBusTopicEventSubscriptionDestinationPropertiesARM |
Properties: The properties that represent the Service Bus Topic destination of an event subscription. |
ServiceBusTopicEventSubscriptionDestinationEndpointType
(string
alias)
(Appears on:ServiceBusTopicEventSubscriptionDestination, ServiceBusTopicEventSubscriptionDestinationARM)
Value | Description |
---|---|
"ServiceBusTopic" |
ServiceBusTopicEventSubscriptionDestinationProperties
(Appears on:ServiceBusTopicEventSubscriptionDestination)
Field | Description |
---|---|
resourceReference genruntime.ResourceReference |
ResourceReference: The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. |
ServiceBusTopicEventSubscriptionDestinationPropertiesARM
(Appears on:ServiceBusTopicEventSubscriptionDestinationARM)
Field | Description |
---|---|
resourceId string |
StorageBlobDeadLetterDestination
(Appears on:EventSubscriptions_Spec)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/StorageBlobDeadLetterDestination
Field | Description |
---|---|
endpointType StorageBlobDeadLetterDestinationEndpointType |
|
properties StorageBlobDeadLetterDestinationProperties |
Properties: Properties of the storage blob based dead letter destination. |
StorageBlobDeadLetterDestinationARM
(Appears on:EventSubscriptionPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/StorageBlobDeadLetterDestination
Field | Description |
---|---|
endpointType StorageBlobDeadLetterDestinationEndpointType |
|
properties StorageBlobDeadLetterDestinationPropertiesARM |
Properties: Properties of the storage blob based dead letter destination. |
StorageBlobDeadLetterDestinationEndpointType
(string
alias)
(Appears on:StorageBlobDeadLetterDestination, StorageBlobDeadLetterDestinationARM)
Value | Description |
---|---|
"StorageBlob" |
StorageBlobDeadLetterDestinationProperties
(Appears on:StorageBlobDeadLetterDestination)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/StorageBlobDeadLetterDestinationProperties
Field | Description |
---|---|
blobContainerName string |
BlobContainerName: The name of the Storage blob container that is the destination of the deadletter events |
resourceReference genruntime.ResourceReference |
ResourceReference: The Azure Resource ID of the storage account that is the destination of the deadletter events |
StorageBlobDeadLetterDestinationPropertiesARM
(Appears on:StorageBlobDeadLetterDestinationARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/StorageBlobDeadLetterDestinationProperties
Field | Description |
---|---|
blobContainerName string |
BlobContainerName: The name of the Storage blob container that is the destination of the deadletter events |
resourceId string |
StorageQueueEventSubscriptionDestination
(Appears on:EventSubscriptionDestination)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/StorageQueueEventSubscriptionDestination
Field | Description |
---|---|
endpointType StorageQueueEventSubscriptionDestinationEndpointType |
|
properties StorageQueueEventSubscriptionDestinationProperties |
Properties: The properties for a storage queue destination. |
StorageQueueEventSubscriptionDestinationARM
(Appears on:EventSubscriptionDestinationARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/StorageQueueEventSubscriptionDestination
Field | Description |
---|---|
endpointType StorageQueueEventSubscriptionDestinationEndpointType |
|
properties StorageQueueEventSubscriptionDestinationPropertiesARM |
Properties: The properties for a storage queue destination. |
StorageQueueEventSubscriptionDestinationEndpointType
(string
alias)
(Appears on:StorageQueueEventSubscriptionDestination, StorageQueueEventSubscriptionDestinationARM)
Value | Description |
---|---|
"StorageQueue" |
StorageQueueEventSubscriptionDestinationProperties
(Appears on:StorageQueueEventSubscriptionDestination)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/StorageQueueEventSubscriptionDestinationProperties
Field | Description |
---|---|
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. |
StorageQueueEventSubscriptionDestinationPropertiesARM
(Appears on:StorageQueueEventSubscriptionDestinationARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/StorageQueueEventSubscriptionDestinationProperties
Field | Description |
---|---|
queueName string |
QueueName: The name of the Storage queue under a storage account that is the destination of an event subscription. |
resourceId string |
SystemDataStatusCreatedByType
(string
alias)
(Appears on:SystemData_Status, SystemData_StatusARM)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemDataStatusLastModifiedByType
(string
alias)
(Appears on:SystemData_Status, SystemData_StatusARM)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_Status
(Appears on:DomainTopic_Status, Domain_Status, EventSubscription_Status, Topic_Status)
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC). |
createdBy string |
CreatedBy: The identity that created the resource. |
createdByType SystemDataStatusCreatedByType |
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 SystemDataStatusLastModifiedByType |
LastModifiedByType: The type of identity that last modified the resource. |
SystemData_StatusARM
(Appears on:DomainTopic_StatusARM, Domain_StatusARM, EventSubscription_StatusARM, Topic_StatusARM)
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC). |
createdBy string |
CreatedBy: The identity that created the resource. |
createdByType SystemDataStatusCreatedByType |
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 SystemDataStatusLastModifiedByType |
LastModifiedByType: The type of identity that last modified the resource. |
Topic
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/resourceDefinitions/topics
Field | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
spec Topics_Spec |
|
||||||||
status Topic_Status |
TopicPropertiesStatusInputSchema
(string
alias)
(Appears on:TopicProperties_StatusARM, Topic_Status)
Value | Description |
---|---|
"CloudEventSchemaV1_0" |
|
"CustomEventSchema" |
|
"EventGridSchema" |
TopicPropertiesStatusProvisioningState
(string
alias)
(Appears on:TopicProperties_StatusARM, Topic_Status)
Value | Description |
---|---|
"Canceled" |
|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
TopicPropertiesStatusPublicNetworkAccess
(string
alias)
(Appears on:TopicProperties_StatusARM, Topic_Status)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
TopicProperties_StatusARM
(Appears on:Topic_StatusARM)
Field | Description |
---|---|
endpoint string |
Endpoint: Endpoint for the topic. |
inboundIpRules []InboundIpRule_StatusARM |
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 TopicPropertiesStatusInputSchema |
InputSchema: This determines the format that Event Grid should expect for incoming events published to the topic. |
inputSchemaMapping InputSchemaMapping_StatusARM |
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. |
metricResourceId string |
MetricResourceId: Metric resource id for the topic. |
privateEndpointConnections []PrivateEndpointConnection_Status_Topic_SubResourceEmbeddedARM |
|
provisioningState TopicPropertiesStatusProvisioningState |
ProvisioningState: Provisioning state of the topic. |
publicNetworkAccess TopicPropertiesStatusPublicNetworkAccess |
PublicNetworkAccess: This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring |
Topic_Status
(Appears on: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 TopicPropertiesStatusInputSchema |
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 TopicPropertiesStatusProvisioningState |
ProvisioningState: Provisioning state of the topic. |
publicNetworkAccess TopicPropertiesStatusPublicNetworkAccess |
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_StatusARM
Field | Description |
---|---|
id string |
Id: Fully qualified identifier of the resource. |
location string |
Location: Location of the resource. |
name string |
Name: Name of the resource. |
properties TopicProperties_StatusARM |
Properties: Properties of the topic. |
systemData SystemData_StatusARM |
SystemData: The system metadata relating to Topic resource. |
tags map[string]string |
Tags: Tags of the resource. |
type string |
Type: Type of the resource. |
Topics_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. |
location string |
Location: Location to deploy resource to |
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 |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
Topics_SpecARM
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
name string |
Name: Name of the resource |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
WebHookEventSubscriptionDestination
(Appears on:EventSubscriptionDestination)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/WebHookEventSubscriptionDestination
Field | Description |
---|---|
endpointType WebHookEventSubscriptionDestinationEndpointType |
|
properties WebHookEventSubscriptionDestinationProperties |
Properties: Information about the webhook destination properties for an event subscription. |
WebHookEventSubscriptionDestinationARM
(Appears on:EventSubscriptionDestinationARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/WebHookEventSubscriptionDestination
Field | Description |
---|---|
endpointType WebHookEventSubscriptionDestinationEndpointType |
|
properties WebHookEventSubscriptionDestinationPropertiesARM |
Properties: Information about the webhook destination properties for an event subscription. |
WebHookEventSubscriptionDestinationEndpointType
(string
alias)
(Appears on:WebHookEventSubscriptionDestination, WebHookEventSubscriptionDestinationARM)
Value | Description |
---|---|
"WebHook" |
WebHookEventSubscriptionDestinationProperties
(Appears on:WebHookEventSubscriptionDestination)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/WebHookEventSubscriptionDestinationProperties
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. |
endpointUrl string |
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. |
WebHookEventSubscriptionDestinationPropertiesARM
(Appears on:WebHookEventSubscriptionDestinationARM)
Generated from: https://schema.management.azure.com/schemas/2020-06-01/Microsoft.EventGrid.json#/definitions/WebHookEventSubscriptionDestinationProperties
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. |
endpointUrl string |
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. |