eventgrid.azure.com/v1api20200601

eventgrid.azure.com/v1api20200601

Package v1api20200601 contains API Schema definitions for the eventgrid v1api20200601 API group

Resource Types:

    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_ARM

    (Appears on:EventSubscriptionFilter_ARM)

    Field Description
    boolEquals
    BoolEqualsAdvancedFilter_ARM

    BoolEquals: Mutually exclusive with all other properties

    numberGreaterThan
    NumberGreaterThanAdvancedFilter_ARM

    NumberGreaterThan: Mutually exclusive with all other properties

    numberGreaterThanOrEquals
    NumberGreaterThanOrEqualsAdvancedFilter_ARM

    NumberGreaterThanOrEquals: Mutually exclusive with all other properties

    numberIn
    NumberInAdvancedFilter_ARM

    NumberIn: Mutually exclusive with all other properties

    numberLessThan
    NumberLessThanAdvancedFilter_ARM

    NumberLessThan: Mutually exclusive with all other properties

    numberLessThanOrEquals
    NumberLessThanOrEqualsAdvancedFilter_ARM

    NumberLessThanOrEquals: Mutually exclusive with all other properties

    numberNotIn
    NumberNotInAdvancedFilter_ARM

    NumberNotIn: Mutually exclusive with all other properties

    stringBeginsWith
    StringBeginsWithAdvancedFilter_ARM

    StringBeginsWith: Mutually exclusive with all other properties

    stringContains
    StringContainsAdvancedFilter_ARM

    StringContains: Mutually exclusive with all other properties

    stringEndsWith
    StringEndsWithAdvancedFilter_ARM

    StringEndsWith: Mutually exclusive with all other properties

    stringIn
    StringInAdvancedFilter_ARM

    StringIn: Mutually exclusive with all other properties

    stringNotIn
    StringNotInAdvancedFilter_ARM

    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

    AdvancedFilter_STATUS_ARM

    (Appears on:EventSubscriptionFilter_STATUS_ARM)

    Field Description
    boolEquals
    BoolEqualsAdvancedFilter_STATUS_ARM

    BoolEquals: Mutually exclusive with all other properties

    numberGreaterThan
    NumberGreaterThanAdvancedFilter_STATUS_ARM

    NumberGreaterThan: Mutually exclusive with all other properties

    numberGreaterThanOrEquals
    NumberGreaterThanOrEqualsAdvancedFilter_STATUS_ARM

    NumberGreaterThanOrEquals: Mutually exclusive with all other properties

    numberIn
    NumberInAdvancedFilter_STATUS_ARM

    NumberIn: Mutually exclusive with all other properties

    numberLessThan
    NumberLessThanAdvancedFilter_STATUS_ARM

    NumberLessThan: Mutually exclusive with all other properties

    numberLessThanOrEquals
    NumberLessThanOrEqualsAdvancedFilter_STATUS_ARM

    NumberLessThanOrEquals: Mutually exclusive with all other properties

    numberNotIn
    NumberNotInAdvancedFilter_STATUS_ARM

    NumberNotIn: Mutually exclusive with all other properties

    stringBeginsWith
    StringBeginsWithAdvancedFilter_STATUS_ARM

    StringBeginsWith: Mutually exclusive with all other properties

    stringContains
    StringContainsAdvancedFilter_STATUS_ARM

    StringContains: Mutually exclusive with all other properties

    stringEndsWith
    StringEndsWithAdvancedFilter_STATUS_ARM

    StringEndsWith: Mutually exclusive with all other properties

    stringIn
    StringInAdvancedFilter_STATUS_ARM

    StringIn: Mutually exclusive with all other properties

    stringNotIn
    StringNotInAdvancedFilter_STATUS_ARM

    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.

    AzureFunctionEventSubscriptionDestinationProperties_ARM

    (Appears on:AzureFunctionEventSubscriptionDestination_ARM)

    The properties that represent the Azure Function destination of an event subscription.

    Field Description
    maxEventsPerBatch
    int

    MaxEventsPerBatch: Maximum number of events per batch.

    preferredBatchSizeInKilobytes
    int

    PreferredBatchSizeInKilobytes: Preferred batch size in Kilobytes.

    resourceId
    string

    AzureFunctionEventSubscriptionDestinationProperties_STATUS_ARM

    (Appears on:AzureFunctionEventSubscriptionDestination_STATUS_ARM)

    The properties that represent the Azure Function destination of an event subscription.

    Field Description
    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.

    AzureFunctionEventSubscriptionDestination_ARM

    (Appears on:EventSubscriptionDestination_ARM)

    Field Description
    endpointType
    AzureFunctionEventSubscriptionDestination_EndpointType_ARM

    EndpointType: Type of the endpoint for the event subscription destination.

    properties
    AzureFunctionEventSubscriptionDestinationProperties_ARM

    Properties: Azure Function Properties of the event subscription destination.

    AzureFunctionEventSubscriptionDestination_EndpointType (string alias)

    (Appears on:AzureFunctionEventSubscriptionDestination)

    Value Description

    "AzureFunction"

    AzureFunctionEventSubscriptionDestination_EndpointType_ARM (string alias)

    (Appears on:AzureFunctionEventSubscriptionDestination_ARM)

    Value Description

    "AzureFunction"

    AzureFunctionEventSubscriptionDestination_EndpointType_STATUS (string alias)

    (Appears on:AzureFunctionEventSubscriptionDestination_STATUS)

    Value Description

    "AzureFunction"

    AzureFunctionEventSubscriptionDestination_EndpointType_STATUS_ARM (string alias)

    (Appears on:AzureFunctionEventSubscriptionDestination_STATUS_ARM)

    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.

    AzureFunctionEventSubscriptionDestination_STATUS_ARM

    (Appears on:EventSubscriptionDestination_STATUS_ARM)

    Field Description
    endpointType
    AzureFunctionEventSubscriptionDestination_EndpointType_STATUS_ARM

    EndpointType: Type of the endpoint for the event subscription destination.

    properties
    AzureFunctionEventSubscriptionDestinationProperties_STATUS_ARM

    Properties: Azure Function Properties of the event subscription destination.

    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_ARM

    (Appears on:AdvancedFilter_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    BoolEqualsAdvancedFilter_OperatorType_ARM

    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_ARM (string alias)

    (Appears on:BoolEqualsAdvancedFilter_ARM)

    Value Description

    "BoolEquals"

    BoolEqualsAdvancedFilter_OperatorType_STATUS (string alias)

    (Appears on:BoolEqualsAdvancedFilter_STATUS)

    Value Description

    "BoolEquals"

    BoolEqualsAdvancedFilter_OperatorType_STATUS_ARM (string alias)

    (Appears on:BoolEqualsAdvancedFilter_STATUS_ARM)

    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.

    BoolEqualsAdvancedFilter_STATUS_ARM

    (Appears on:AdvancedFilter_STATUS_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    BoolEqualsAdvancedFilter_OperatorType_STATUS_ARM

    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_ARM

    (Appears on:EventSubscriptionProperties_ARM)

    Field Description
    storageBlob
    StorageBlobDeadLetterDestination_ARM

    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

    DeadLetterDestination_STATUS_ARM

    (Appears on:EventSubscriptionProperties_STATUS_ARM)

    Field Description
    storageBlob
    StorageBlobDeadLetterDestination_STATUS_ARM

    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}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Domain_Spec


    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.

    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.

    status
    Domain_STATUS

    DomainProperties_ARM

    (Appears on:Domain_Spec_ARM)

    Properties of the Domain.

    Field Description
    inboundIpRules
    []InboundIpRule_ARM

    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_ARM

    InputSchema: This determines the format that Event Grid should expect for incoming events published to the domain.

    inputSchemaMapping
    InputSchemaMapping_ARM

    InputSchemaMapping: Information about the InputSchemaMapping which specified the info about mapping event payload.

    publicNetworkAccess
    DomainProperties_PublicNetworkAccess_ARM

    PublicNetworkAccess: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring

    DomainProperties_InputSchema (string alias)

    (Appears on:Domain_Spec)

    Value Description

    "CloudEventSchemaV1_0"

    "CustomEventSchema"

    "EventGridSchema"

    DomainProperties_InputSchema_ARM (string alias)

    (Appears on:DomainProperties_ARM)

    Value Description

    "CloudEventSchemaV1_0"

    "CustomEventSchema"

    "EventGridSchema"

    DomainProperties_InputSchema_STATUS (string alias)

    (Appears on:Domain_STATUS)

    Value Description

    "CloudEventSchemaV1_0"

    "CustomEventSchema"

    "EventGridSchema"

    DomainProperties_InputSchema_STATUS_ARM (string alias)

    (Appears on:DomainProperties_STATUS_ARM)

    Value Description

    "CloudEventSchemaV1_0"

    "CustomEventSchema"

    "EventGridSchema"

    DomainProperties_ProvisioningState_STATUS (string alias)

    (Appears on:Domain_STATUS)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    DomainProperties_ProvisioningState_STATUS_ARM (string alias)

    (Appears on:DomainProperties_STATUS_ARM)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    DomainProperties_PublicNetworkAccess (string alias)

    (Appears on:Domain_Spec)

    Value Description

    "Disabled"

    "Enabled"

    DomainProperties_PublicNetworkAccess_ARM (string alias)

    (Appears on:DomainProperties_ARM)

    Value Description

    "Disabled"

    "Enabled"

    DomainProperties_PublicNetworkAccess_STATUS (string alias)

    (Appears on:Domain_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    DomainProperties_PublicNetworkAccess_STATUS_ARM (string alias)

    (Appears on:DomainProperties_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    DomainProperties_STATUS_ARM

    (Appears on:Domain_STATUS_ARM)

    Properties of the Domain.

    Field Description
    endpoint
    string

    Endpoint: Endpoint for the domain.

    inboundIpRules
    []InboundIpRule_STATUS_ARM

    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_ARM

    InputSchema: This determines the format that Event Grid should expect for incoming events published to the domain.

    inputSchemaMapping
    InputSchemaMapping_STATUS_ARM

    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_SubResourceEmbedded_ARM

    PrivateEndpointConnections: List of private endpoint connections.

    provisioningState
    DomainProperties_ProvisioningState_STATUS_ARM

    ProvisioningState: Provisioning state of the domain.

    publicNetworkAccess
    DomainProperties_PublicNetworkAccess_STATUS_ARM

    PublicNetworkAccess: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring

    DomainTopicProperties_ProvisioningState_STATUS (string alias)

    (Appears on:Domains_Topic_STATUS)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    DomainTopicProperties_ProvisioningState_STATUS_ARM (string alias)

    (Appears on:DomainTopicProperties_STATUS_ARM)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    DomainTopicProperties_STATUS_ARM

    (Appears on:Domains_Topic_STATUS_ARM)

    Properties of the Domain Topic.

    Field Description
    provisioningState
    DomainTopicProperties_ProvisioningState_STATUS_ARM

    ProvisioningState: Provisioning state of the domain topic.

    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_STATUS_ARM

    EventGrid Domain.

    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_STATUS_ARM

    Properties: Properties of the domain.

    systemData
    SystemData_STATUS_ARM

    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.

    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.

    Domain_Spec_ARM

    Field Description
    location
    string

    Location: Location of the resource.

    name
    string
    properties
    DomainProperties_ARM

    Properties: Properties of the domain.

    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}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Domains_Topic_Spec


    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.

    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

    status
    Domains_Topic_STATUS

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

    Domains_Topic_STATUS_ARM

    Field Description
    id
    string

    Id: Fully qualified identifier of the resource.

    name
    string

    Name: Name of the resource.

    properties
    DomainTopicProperties_STATUS_ARM

    Properties: Properties of the Domain Topic.

    systemData
    SystemData_STATUS_ARM

    SystemData: The system metadata relating to Domain Topic resource.

    type
    string

    Type: Type of the resource.

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

    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

    Domains_Topic_Spec_ARM

    Field Description
    name
    string

    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.

    EventHubEventSubscriptionDestinationProperties_ARM

    (Appears on:EventHubEventSubscriptionDestination_ARM)

    The properties for a event hub destination.

    Field Description
    resourceId
    string

    EventHubEventSubscriptionDestinationProperties_STATUS_ARM

    (Appears on:EventHubEventSubscriptionDestination_STATUS_ARM)

    The properties for a event hub destination.

    Field Description
    resourceId
    string

    ResourceId: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription.

    EventHubEventSubscriptionDestination_ARM

    (Appears on:EventSubscriptionDestination_ARM)

    Field Description
    endpointType
    EventHubEventSubscriptionDestination_EndpointType_ARM

    EndpointType: Type of the endpoint for the event subscription destination.

    properties
    EventHubEventSubscriptionDestinationProperties_ARM

    Properties: Event Hub Properties of the event subscription destination.

    EventHubEventSubscriptionDestination_EndpointType (string alias)

    (Appears on:EventHubEventSubscriptionDestination)

    Value Description

    "EventHub"

    EventHubEventSubscriptionDestination_EndpointType_ARM (string alias)

    (Appears on:EventHubEventSubscriptionDestination_ARM)

    Value Description

    "EventHub"

    EventHubEventSubscriptionDestination_EndpointType_STATUS (string alias)

    (Appears on:EventHubEventSubscriptionDestination_STATUS)

    Value Description

    "EventHub"

    EventHubEventSubscriptionDestination_EndpointType_STATUS_ARM (string alias)

    (Appears on:EventHubEventSubscriptionDestination_STATUS_ARM)

    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.

    EventHubEventSubscriptionDestination_STATUS_ARM

    (Appears on:EventSubscriptionDestination_STATUS_ARM)

    Field Description
    endpointType
    EventHubEventSubscriptionDestination_EndpointType_STATUS_ARM

    EndpointType: Type of the endpoint for the event subscription destination.

    properties
    EventHubEventSubscriptionDestinationProperties_STATUS_ARM

    Properties: Event Hub Properties of the event subscription destination.

    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


    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.

    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.

    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_ARM

    (Appears on:EventSubscriptionProperties_ARM)

    Field Description
    azureFunction
    AzureFunctionEventSubscriptionDestination_ARM

    AzureFunction: Mutually exclusive with all other properties

    eventHub
    EventHubEventSubscriptionDestination_ARM

    EventHub: Mutually exclusive with all other properties

    hybridConnection
    HybridConnectionEventSubscriptionDestination_ARM

    HybridConnection: Mutually exclusive with all other properties

    serviceBusQueue
    ServiceBusQueueEventSubscriptionDestination_ARM

    ServiceBusQueue: Mutually exclusive with all other properties

    serviceBusTopic
    ServiceBusTopicEventSubscriptionDestination_ARM

    ServiceBusTopic: Mutually exclusive with all other properties

    storageQueue
    StorageQueueEventSubscriptionDestination_ARM

    StorageQueue: Mutually exclusive with all other properties

    webHook
    WebHookEventSubscriptionDestination_ARM

    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

    EventSubscriptionDestination_STATUS_ARM

    (Appears on:EventSubscriptionProperties_STATUS_ARM)

    Field Description
    azureFunction
    AzureFunctionEventSubscriptionDestination_STATUS_ARM

    AzureFunction: Mutually exclusive with all other properties

    eventHub
    EventHubEventSubscriptionDestination_STATUS_ARM

    EventHub: Mutually exclusive with all other properties

    hybridConnection
    HybridConnectionEventSubscriptionDestination_STATUS_ARM

    HybridConnection: Mutually exclusive with all other properties

    serviceBusQueue
    ServiceBusQueueEventSubscriptionDestination_STATUS_ARM

    ServiceBusQueue: Mutually exclusive with all other properties

    serviceBusTopic
    ServiceBusTopicEventSubscriptionDestination_STATUS_ARM

    ServiceBusTopic: Mutually exclusive with all other properties

    storageQueue
    StorageQueueEventSubscriptionDestination_STATUS_ARM

    StorageQueue: Mutually exclusive with all other properties

    webHook
    WebHookEventSubscriptionDestination_STATUS_ARM

    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_ARM

    (Appears on:EventSubscriptionProperties_ARM)

    Filter for the Event Subscription.

    Field Description
    advancedFilters
    []AdvancedFilter_ARM

    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.

    EventSubscriptionFilter_STATUS_ARM

    (Appears on:EventSubscriptionProperties_STATUS_ARM)

    Filter for the Event Subscription.

    Field Description
    advancedFilters
    []AdvancedFilter_STATUS_ARM

    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.

    EventSubscriptionProperties_ARM

    (Appears on:EventSubscription_Spec_ARM)

    Properties of the Event Subscription.

    Field Description
    deadLetterDestination
    DeadLetterDestination_ARM

    DeadLetterDestination: The DeadLetter destination of the event subscription.

    destination
    EventSubscriptionDestination_ARM

    Destination: Information about the destination where events have to be delivered for the event subscription.

    eventDeliverySchema
    EventSubscriptionProperties_EventDeliverySchema_ARM

    EventDeliverySchema: The event delivery schema for the event subscription.

    expirationTimeUtc
    string

    ExpirationTimeUtc: Expiration time of the event subscription.

    filter
    EventSubscriptionFilter_ARM

    Filter: Information about the filter for the event subscription.

    labels
    []string

    Labels: List of user defined labels.

    retryPolicy
    RetryPolicy_ARM

    RetryPolicy: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events.

    EventSubscriptionProperties_EventDeliverySchema (string alias)

    (Appears on:EventSubscription_Spec)

    Value Description

    "CloudEventSchemaV1_0"

    "CustomInputSchema"

    "EventGridSchema"

    EventSubscriptionProperties_EventDeliverySchema_ARM (string alias)

    (Appears on:EventSubscriptionProperties_ARM)

    Value Description

    "CloudEventSchemaV1_0"

    "CustomInputSchema"

    "EventGridSchema"

    EventSubscriptionProperties_EventDeliverySchema_STATUS (string alias)

    (Appears on:EventSubscription_STATUS)

    Value Description

    "CloudEventSchemaV1_0"

    "CustomInputSchema"

    "EventGridSchema"

    EventSubscriptionProperties_EventDeliverySchema_STATUS_ARM (string alias)

    (Appears on:EventSubscriptionProperties_STATUS_ARM)

    Value Description

    "CloudEventSchemaV1_0"

    "CustomInputSchema"

    "EventGridSchema"

    EventSubscriptionProperties_ProvisioningState_STATUS (string alias)

    (Appears on:EventSubscription_STATUS)

    Value Description

    "AwaitingManualAction"

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    EventSubscriptionProperties_ProvisioningState_STATUS_ARM (string alias)

    (Appears on:EventSubscriptionProperties_STATUS_ARM)

    Value Description

    "AwaitingManualAction"

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    EventSubscriptionProperties_STATUS_ARM

    (Appears on:EventSubscription_STATUS_ARM)

    Properties of the Event Subscription.

    Field Description
    deadLetterDestination
    DeadLetterDestination_STATUS_ARM

    DeadLetterDestination: The DeadLetter destination of the event subscription.

    destination
    EventSubscriptionDestination_STATUS_ARM

    Destination: Information about the destination where events have to be delivered for the event subscription.

    eventDeliverySchema
    EventSubscriptionProperties_EventDeliverySchema_STATUS_ARM

    EventDeliverySchema: The event delivery schema for the event subscription.

    expirationTimeUtc
    string

    ExpirationTimeUtc: Expiration time of the event subscription.

    filter
    EventSubscriptionFilter_STATUS_ARM

    Filter: Information about the filter for the event subscription.

    labels
    []string

    Labels: List of user defined labels.

    provisioningState
    EventSubscriptionProperties_ProvisioningState_STATUS_ARM

    ProvisioningState: Provisioning state of the event subscription.

    retryPolicy
    RetryPolicy_STATUS_ARM

    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)

    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_STATUS_ARM

    Event Subscription

    Field Description
    id
    string

    Id: Fully qualified identifier of the resource.

    name
    string

    Name: Name of the resource.

    properties
    EventSubscriptionProperties_STATUS_ARM

    Properties: Properties of the event subscription.

    systemData
    SystemData_STATUS_ARM

    SystemData: The system metadata relating to Event Subscription resource.

    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.

    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.

    EventSubscription_Spec_ARM

    Field Description
    name
    string
    properties
    EventSubscriptionProperties_ARM

    Properties: Properties of the event subscription.

    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.

    HybridConnectionEventSubscriptionDestinationProperties_ARM

    (Appears on:HybridConnectionEventSubscriptionDestination_ARM)

    The properties for a hybrid connection destination.

    Field Description
    resourceId
    string

    HybridConnectionEventSubscriptionDestinationProperties_STATUS_ARM

    (Appears on:HybridConnectionEventSubscriptionDestination_STATUS_ARM)

    The properties for a hybrid connection destination.

    Field Description
    resourceId
    string

    ResourceId: The Azure Resource ID of an hybrid connection that is the destination of an event subscription.

    HybridConnectionEventSubscriptionDestination_ARM

    (Appears on:EventSubscriptionDestination_ARM)

    Field Description
    endpointType
    HybridConnectionEventSubscriptionDestination_EndpointType_ARM

    EndpointType: Type of the endpoint for the event subscription destination.

    properties
    HybridConnectionEventSubscriptionDestinationProperties_ARM

    Properties: Hybrid connection Properties of the event subscription destination.

    HybridConnectionEventSubscriptionDestination_EndpointType (string alias)

    (Appears on:HybridConnectionEventSubscriptionDestination)

    Value Description

    "HybridConnection"

    HybridConnectionEventSubscriptionDestination_EndpointType_ARM (string alias)

    (Appears on:HybridConnectionEventSubscriptionDestination_ARM)

    Value Description

    "HybridConnection"

    HybridConnectionEventSubscriptionDestination_EndpointType_STATUS (string alias)

    (Appears on:HybridConnectionEventSubscriptionDestination_STATUS)

    Value Description

    "HybridConnection"

    HybridConnectionEventSubscriptionDestination_EndpointType_STATUS_ARM (string alias)

    (Appears on:HybridConnectionEventSubscriptionDestination_STATUS_ARM)

    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.

    HybridConnectionEventSubscriptionDestination_STATUS_ARM

    (Appears on:EventSubscriptionDestination_STATUS_ARM)

    Field Description
    endpointType
    HybridConnectionEventSubscriptionDestination_EndpointType_STATUS_ARM

    EndpointType: Type of the endpoint for the event subscription destination.

    properties
    HybridConnectionEventSubscriptionDestinationProperties_STATUS_ARM

    Properties: Hybrid connection Properties of the event subscription destination.

    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_ARM

    (Appears on:DomainProperties_ARM, TopicProperties_ARM)

    Field Description
    action
    InboundIpRule_Action_ARM

    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_ARM (string alias)

    (Appears on:InboundIpRule_ARM)

    Value Description

    "Allow"

    InboundIpRule_Action_STATUS (string alias)

    (Appears on:InboundIpRule_STATUS)

    Value Description

    "Allow"

    InboundIpRule_Action_STATUS_ARM (string alias)

    (Appears on:InboundIpRule_STATUS_ARM)

    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.

    InboundIpRule_STATUS_ARM

    (Appears on:DomainProperties_STATUS_ARM, TopicProperties_STATUS_ARM)

    Field Description
    action
    InboundIpRule_Action_STATUS_ARM

    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_ARM

    (Appears on:DomainProperties_ARM, TopicProperties_ARM)

    Field Description
    json
    JsonInputSchemaMapping_ARM

    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

    InputSchemaMapping_STATUS_ARM

    (Appears on:DomainProperties_STATUS_ARM, TopicProperties_STATUS_ARM)

    Field Description
    json
    JsonInputSchemaMapping_STATUS_ARM

    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_ARM

    (Appears on:JsonInputSchemaMappingProperties_ARM)

    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.

    JsonFieldWithDefault_STATUS_ARM

    (Appears on:JsonInputSchemaMappingProperties_STATUS_ARM)

    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_ARM

    (Appears on:JsonInputSchemaMappingProperties_ARM)

    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.

    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.

    JsonField_STATUS_ARM

    (Appears on:JsonInputSchemaMappingProperties_STATUS_ARM)

    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.

    JsonInputSchemaMappingProperties_ARM

    (Appears on:JsonInputSchemaMapping_ARM)

    This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema.

    Field Description
    dataVersion
    JsonFieldWithDefault_ARM

    DataVersion: The mapping information for the DataVersion property of the Event Grid Event.

    eventTime
    JsonField_ARM

    EventTime: The mapping information for the EventTime property of the Event Grid Event.

    eventType
    JsonFieldWithDefault_ARM

    EventType: The mapping information for the EventType property of the Event Grid Event.

    id
    JsonField_ARM

    Id: The mapping information for the Id property of the Event Grid Event.

    subject
    JsonFieldWithDefault_ARM

    Subject: The mapping information for the Subject property of the Event Grid Event.

    topic
    JsonField_ARM

    Topic: The mapping information for the Topic property of the Event Grid Event.

    JsonInputSchemaMappingProperties_STATUS_ARM

    (Appears on:JsonInputSchemaMapping_STATUS_ARM)

    This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema.

    Field Description
    dataVersion
    JsonFieldWithDefault_STATUS_ARM

    DataVersion: The mapping information for the DataVersion property of the Event Grid Event.

    eventTime
    JsonField_STATUS_ARM

    EventTime: The mapping information for the EventTime property of the Event Grid Event.

    eventType
    JsonFieldWithDefault_STATUS_ARM

    EventType: The mapping information for the EventType property of the Event Grid Event.

    id
    JsonField_STATUS_ARM

    Id: The mapping information for the Id property of the Event Grid Event.

    subject
    JsonFieldWithDefault_STATUS_ARM

    Subject: The mapping information for the Subject property of the Event Grid Event.

    topic
    JsonField_STATUS_ARM

    Topic: The mapping information for the Topic property of the Event Grid Event.

    JsonInputSchemaMapping_ARM

    (Appears on:InputSchemaMapping_ARM)

    Field Description
    inputSchemaMappingType
    JsonInputSchemaMapping_InputSchemaMappingType_ARM

    InputSchemaMappingType: Type of the custom mapping

    properties
    JsonInputSchemaMappingProperties_ARM

    Properties: JSON Properties of the input schema mapping

    JsonInputSchemaMapping_InputSchemaMappingType (string alias)

    (Appears on:JsonInputSchemaMapping)

    Value Description

    "Json"

    JsonInputSchemaMapping_InputSchemaMappingType_ARM (string alias)

    (Appears on:JsonInputSchemaMapping_ARM)

    Value Description

    "Json"

    JsonInputSchemaMapping_InputSchemaMappingType_STATUS (string alias)

    (Appears on:JsonInputSchemaMapping_STATUS)

    Value Description

    "Json"

    JsonInputSchemaMapping_InputSchemaMappingType_STATUS_ARM (string alias)

    (Appears on:JsonInputSchemaMapping_STATUS_ARM)

    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.

    JsonInputSchemaMapping_STATUS_ARM

    (Appears on:InputSchemaMapping_STATUS_ARM)

    Field Description
    inputSchemaMappingType
    JsonInputSchemaMapping_InputSchemaMappingType_STATUS_ARM

    InputSchemaMappingType: Type of the custom mapping

    properties
    JsonInputSchemaMappingProperties_STATUS_ARM

    Properties: JSON Properties of the input schema mapping

    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_ARM

    (Appears on:AdvancedFilter_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    NumberGreaterThanAdvancedFilter_OperatorType_ARM

    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_ARM (string alias)

    (Appears on:NumberGreaterThanAdvancedFilter_ARM)

    Value Description

    "NumberGreaterThan"

    NumberGreaterThanAdvancedFilter_OperatorType_STATUS (string alias)

    (Appears on:NumberGreaterThanAdvancedFilter_STATUS)

    Value Description

    "NumberGreaterThan"

    NumberGreaterThanAdvancedFilter_OperatorType_STATUS_ARM (string alias)

    (Appears on:NumberGreaterThanAdvancedFilter_STATUS_ARM)

    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.

    NumberGreaterThanAdvancedFilter_STATUS_ARM

    (Appears on:AdvancedFilter_STATUS_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    NumberGreaterThanAdvancedFilter_OperatorType_STATUS_ARM

    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_ARM

    (Appears on:AdvancedFilter_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    NumberGreaterThanOrEqualsAdvancedFilter_OperatorType_ARM

    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_ARM (string alias)

    (Appears on:NumberGreaterThanOrEqualsAdvancedFilter_ARM)

    Value Description

    "NumberGreaterThanOrEquals"

    NumberGreaterThanOrEqualsAdvancedFilter_OperatorType_STATUS (string alias)

    (Appears on:NumberGreaterThanOrEqualsAdvancedFilter_STATUS)

    Value Description

    "NumberGreaterThanOrEquals"

    NumberGreaterThanOrEqualsAdvancedFilter_OperatorType_STATUS_ARM (string alias)

    (Appears on:NumberGreaterThanOrEqualsAdvancedFilter_STATUS_ARM)

    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.

    NumberGreaterThanOrEqualsAdvancedFilter_STATUS_ARM

    (Appears on:AdvancedFilter_STATUS_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    NumberGreaterThanOrEqualsAdvancedFilter_OperatorType_STATUS_ARM

    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_ARM

    (Appears on:AdvancedFilter_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    NumberInAdvancedFilter_OperatorType_ARM

    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_ARM (string alias)

    (Appears on:NumberInAdvancedFilter_ARM)

    Value Description

    "NumberIn"

    NumberInAdvancedFilter_OperatorType_STATUS (string alias)

    (Appears on:NumberInAdvancedFilter_STATUS)

    Value Description

    "NumberIn"

    NumberInAdvancedFilter_OperatorType_STATUS_ARM (string alias)

    (Appears on:NumberInAdvancedFilter_STATUS_ARM)

    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.

    NumberInAdvancedFilter_STATUS_ARM

    (Appears on:AdvancedFilter_STATUS_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    NumberInAdvancedFilter_OperatorType_STATUS_ARM

    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_ARM

    (Appears on:AdvancedFilter_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    NumberLessThanAdvancedFilter_OperatorType_ARM

    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_ARM (string alias)

    (Appears on:NumberLessThanAdvancedFilter_ARM)

    Value Description

    "NumberLessThan"

    NumberLessThanAdvancedFilter_OperatorType_STATUS (string alias)

    (Appears on:NumberLessThanAdvancedFilter_STATUS)

    Value Description

    "NumberLessThan"

    NumberLessThanAdvancedFilter_OperatorType_STATUS_ARM (string alias)

    (Appears on:NumberLessThanAdvancedFilter_STATUS_ARM)

    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.

    NumberLessThanAdvancedFilter_STATUS_ARM

    (Appears on:AdvancedFilter_STATUS_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    NumberLessThanAdvancedFilter_OperatorType_STATUS_ARM

    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_ARM

    (Appears on:AdvancedFilter_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    NumberLessThanOrEqualsAdvancedFilter_OperatorType_ARM

    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_ARM (string alias)

    (Appears on:NumberLessThanOrEqualsAdvancedFilter_ARM)

    Value Description

    "NumberLessThanOrEquals"

    NumberLessThanOrEqualsAdvancedFilter_OperatorType_STATUS (string alias)

    (Appears on:NumberLessThanOrEqualsAdvancedFilter_STATUS)

    Value Description

    "NumberLessThanOrEquals"

    NumberLessThanOrEqualsAdvancedFilter_OperatorType_STATUS_ARM (string alias)

    (Appears on:NumberLessThanOrEqualsAdvancedFilter_STATUS_ARM)

    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.

    NumberLessThanOrEqualsAdvancedFilter_STATUS_ARM

    (Appears on:AdvancedFilter_STATUS_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    NumberLessThanOrEqualsAdvancedFilter_OperatorType_STATUS_ARM

    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_ARM

    (Appears on:AdvancedFilter_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    NumberNotInAdvancedFilter_OperatorType_ARM

    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_ARM (string alias)

    (Appears on:NumberNotInAdvancedFilter_ARM)

    Value Description

    "NumberNotIn"

    NumberNotInAdvancedFilter_OperatorType_STATUS (string alias)

    (Appears on:NumberNotInAdvancedFilter_STATUS)

    Value Description

    "NumberNotIn"

    NumberNotInAdvancedFilter_OperatorType_STATUS_ARM (string alias)

    (Appears on:NumberNotInAdvancedFilter_STATUS_ARM)

    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.

    NumberNotInAdvancedFilter_STATUS_ARM

    (Appears on:AdvancedFilter_STATUS_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    NumberNotInAdvancedFilter_OperatorType_STATUS_ARM

    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_Domain_SubResourceEmbedded_ARM

    (Appears on:DomainProperties_STATUS_ARM)

    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_SubResourceEmbedded_ARM

    (Appears on:TopicProperties_STATUS_ARM)

    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_ARM

    (Appears on:EventSubscriptionProperties_ARM)

    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.

    RetryPolicy_STATUS_ARM

    (Appears on:EventSubscriptionProperties_STATUS_ARM)

    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.

    ServiceBusQueueEventSubscriptionDestinationProperties_ARM

    (Appears on:ServiceBusQueueEventSubscriptionDestination_ARM)

    The properties that represent the Service Bus destination of an event subscription.

    Field Description
    resourceId
    string

    ServiceBusQueueEventSubscriptionDestinationProperties_STATUS_ARM

    (Appears on:ServiceBusQueueEventSubscriptionDestination_STATUS_ARM)

    The properties that represent the Service Bus destination of an event subscription.

    Field Description
    resourceId
    string

    ResourceId: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription.

    ServiceBusQueueEventSubscriptionDestination_ARM

    (Appears on:EventSubscriptionDestination_ARM)

    Field Description
    endpointType
    ServiceBusQueueEventSubscriptionDestination_EndpointType_ARM

    EndpointType: Type of the endpoint for the event subscription destination.

    properties
    ServiceBusQueueEventSubscriptionDestinationProperties_ARM

    Properties: Service Bus Properties of the event subscription destination.

    ServiceBusQueueEventSubscriptionDestination_EndpointType (string alias)

    (Appears on:ServiceBusQueueEventSubscriptionDestination)

    Value Description

    "ServiceBusQueue"

    ServiceBusQueueEventSubscriptionDestination_EndpointType_ARM (string alias)

    (Appears on:ServiceBusQueueEventSubscriptionDestination_ARM)

    Value Description

    "ServiceBusQueue"

    ServiceBusQueueEventSubscriptionDestination_EndpointType_STATUS (string alias)

    (Appears on:ServiceBusQueueEventSubscriptionDestination_STATUS)

    Value Description

    "ServiceBusQueue"

    ServiceBusQueueEventSubscriptionDestination_EndpointType_STATUS_ARM (string alias)

    (Appears on:ServiceBusQueueEventSubscriptionDestination_STATUS_ARM)

    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.

    ServiceBusQueueEventSubscriptionDestination_STATUS_ARM

    (Appears on:EventSubscriptionDestination_STATUS_ARM)

    Field Description
    endpointType
    ServiceBusQueueEventSubscriptionDestination_EndpointType_STATUS_ARM

    EndpointType: Type of the endpoint for the event subscription destination.

    properties
    ServiceBusQueueEventSubscriptionDestinationProperties_STATUS_ARM

    Properties: Service Bus Properties of the event subscription destination.

    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.

    ServiceBusTopicEventSubscriptionDestinationProperties_ARM

    (Appears on:ServiceBusTopicEventSubscriptionDestination_ARM)

    The properties that represent the Service Bus Topic destination of an event subscription.

    Field Description
    resourceId
    string

    ServiceBusTopicEventSubscriptionDestinationProperties_STATUS_ARM

    (Appears on:ServiceBusTopicEventSubscriptionDestination_STATUS_ARM)

    The properties that represent the Service Bus Topic destination of an event subscription.

    Field Description
    resourceId
    string

    ResourceId: The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription.

    ServiceBusTopicEventSubscriptionDestination_ARM

    (Appears on:EventSubscriptionDestination_ARM)

    Field Description
    endpointType
    ServiceBusTopicEventSubscriptionDestination_EndpointType_ARM

    EndpointType: Type of the endpoint for the event subscription destination.

    properties
    ServiceBusTopicEventSubscriptionDestinationProperties_ARM

    Properties: Service Bus Topic Properties of the event subscription destination.

    ServiceBusTopicEventSubscriptionDestination_EndpointType (string alias)

    (Appears on:ServiceBusTopicEventSubscriptionDestination)

    Value Description

    "ServiceBusTopic"

    ServiceBusTopicEventSubscriptionDestination_EndpointType_ARM (string alias)

    (Appears on:ServiceBusTopicEventSubscriptionDestination_ARM)

    Value Description

    "ServiceBusTopic"

    ServiceBusTopicEventSubscriptionDestination_EndpointType_STATUS (string alias)

    (Appears on:ServiceBusTopicEventSubscriptionDestination_STATUS)

    Value Description

    "ServiceBusTopic"

    ServiceBusTopicEventSubscriptionDestination_EndpointType_STATUS_ARM (string alias)

    (Appears on:ServiceBusTopicEventSubscriptionDestination_STATUS_ARM)

    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.

    ServiceBusTopicEventSubscriptionDestination_STATUS_ARM

    (Appears on:EventSubscriptionDestination_STATUS_ARM)

    Field Description
    endpointType
    ServiceBusTopicEventSubscriptionDestination_EndpointType_STATUS_ARM

    EndpointType: Type of the endpoint for the event subscription destination.

    properties
    ServiceBusTopicEventSubscriptionDestinationProperties_STATUS_ARM

    Properties: Service Bus Topic Properties of the event subscription destination.

    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

    StorageBlobDeadLetterDestinationProperties_ARM

    (Appears on:StorageBlobDeadLetterDestination_ARM)

    Properties of the storage blob based dead letter destination.

    Field Description
    blobContainerName
    string

    BlobContainerName: The name of the Storage blob container that is the destination of the deadletter events

    resourceId
    string

    StorageBlobDeadLetterDestinationProperties_STATUS_ARM

    (Appears on:StorageBlobDeadLetterDestination_STATUS_ARM)

    Properties of the storage blob based dead letter destination.

    Field Description
    blobContainerName
    string

    BlobContainerName: The name of the Storage blob container that is the destination of the deadletter events

    resourceId
    string

    ResourceId: The Azure Resource ID of the storage account that is the destination of the deadletter events

    StorageBlobDeadLetterDestination_ARM

    (Appears on:DeadLetterDestination_ARM)

    Field Description
    endpointType
    StorageBlobDeadLetterDestination_EndpointType_ARM

    EndpointType: Type of the endpoint for the dead letter destination

    properties
    StorageBlobDeadLetterDestinationProperties_ARM

    Properties: The properties of the Storage Blob based deadletter destination

    StorageBlobDeadLetterDestination_EndpointType (string alias)

    (Appears on:StorageBlobDeadLetterDestination)

    Value Description

    "StorageBlob"

    StorageBlobDeadLetterDestination_EndpointType_ARM (string alias)

    (Appears on:StorageBlobDeadLetterDestination_ARM)

    Value Description

    "StorageBlob"

    StorageBlobDeadLetterDestination_EndpointType_STATUS (string alias)

    (Appears on:StorageBlobDeadLetterDestination_STATUS)

    Value Description

    "StorageBlob"

    StorageBlobDeadLetterDestination_EndpointType_STATUS_ARM (string alias)

    (Appears on:StorageBlobDeadLetterDestination_STATUS_ARM)

    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

    StorageBlobDeadLetterDestination_STATUS_ARM

    (Appears on:DeadLetterDestination_STATUS_ARM)

    Field Description
    endpointType
    StorageBlobDeadLetterDestination_EndpointType_STATUS_ARM

    EndpointType: Type of the endpoint for the dead letter destination

    properties
    StorageBlobDeadLetterDestinationProperties_STATUS_ARM

    Properties: The properties of the Storage Blob based deadletter destination

    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.

    StorageQueueEventSubscriptionDestinationProperties_ARM

    (Appears on:StorageQueueEventSubscriptionDestination_ARM)

    The properties for a storage queue destination.

    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

    StorageQueueEventSubscriptionDestinationProperties_STATUS_ARM

    (Appears on:StorageQueueEventSubscriptionDestination_STATUS_ARM)

    The properties for a storage queue destination.

    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

    ResourceId: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription.

    StorageQueueEventSubscriptionDestination_ARM

    (Appears on:EventSubscriptionDestination_ARM)

    Field Description
    endpointType
    StorageQueueEventSubscriptionDestination_EndpointType_ARM

    EndpointType: Type of the endpoint for the event subscription destination.

    properties
    StorageQueueEventSubscriptionDestinationProperties_ARM

    Properties: Storage Queue Properties of the event subscription destination.

    StorageQueueEventSubscriptionDestination_EndpointType (string alias)

    (Appears on:StorageQueueEventSubscriptionDestination)

    Value Description

    "StorageQueue"

    StorageQueueEventSubscriptionDestination_EndpointType_ARM (string alias)

    (Appears on:StorageQueueEventSubscriptionDestination_ARM)

    Value Description

    "StorageQueue"

    StorageQueueEventSubscriptionDestination_EndpointType_STATUS (string alias)

    (Appears on:StorageQueueEventSubscriptionDestination_STATUS)

    Value Description

    "StorageQueue"

    StorageQueueEventSubscriptionDestination_EndpointType_STATUS_ARM (string alias)

    (Appears on:StorageQueueEventSubscriptionDestination_STATUS_ARM)

    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.

    StorageQueueEventSubscriptionDestination_STATUS_ARM

    (Appears on:EventSubscriptionDestination_STATUS_ARM)

    Field Description
    endpointType
    StorageQueueEventSubscriptionDestination_EndpointType_STATUS_ARM

    EndpointType: Type of the endpoint for the event subscription destination.

    properties
    StorageQueueEventSubscriptionDestinationProperties_STATUS_ARM

    Properties: Storage Queue Properties of the event subscription destination.

    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_ARM

    (Appears on:AdvancedFilter_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    StringBeginsWithAdvancedFilter_OperatorType_ARM

    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_ARM (string alias)

    (Appears on:StringBeginsWithAdvancedFilter_ARM)

    Value Description

    "StringBeginsWith"

    StringBeginsWithAdvancedFilter_OperatorType_STATUS (string alias)

    (Appears on:StringBeginsWithAdvancedFilter_STATUS)

    Value Description

    "StringBeginsWith"

    StringBeginsWithAdvancedFilter_OperatorType_STATUS_ARM (string alias)

    (Appears on:StringBeginsWithAdvancedFilter_STATUS_ARM)

    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.

    StringBeginsWithAdvancedFilter_STATUS_ARM

    (Appears on:AdvancedFilter_STATUS_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    StringBeginsWithAdvancedFilter_OperatorType_STATUS_ARM

    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_ARM

    (Appears on:AdvancedFilter_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    StringContainsAdvancedFilter_OperatorType_ARM

    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_ARM (string alias)

    (Appears on:StringContainsAdvancedFilter_ARM)

    Value Description

    "StringContains"

    StringContainsAdvancedFilter_OperatorType_STATUS (string alias)

    (Appears on:StringContainsAdvancedFilter_STATUS)

    Value Description

    "StringContains"

    StringContainsAdvancedFilter_OperatorType_STATUS_ARM (string alias)

    (Appears on:StringContainsAdvancedFilter_STATUS_ARM)

    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.

    StringContainsAdvancedFilter_STATUS_ARM

    (Appears on:AdvancedFilter_STATUS_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    StringContainsAdvancedFilter_OperatorType_STATUS_ARM

    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_ARM

    (Appears on:AdvancedFilter_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    StringEndsWithAdvancedFilter_OperatorType_ARM

    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_ARM (string alias)

    (Appears on:StringEndsWithAdvancedFilter_ARM)

    Value Description

    "StringEndsWith"

    StringEndsWithAdvancedFilter_OperatorType_STATUS (string alias)

    (Appears on:StringEndsWithAdvancedFilter_STATUS)

    Value Description

    "StringEndsWith"

    StringEndsWithAdvancedFilter_OperatorType_STATUS_ARM (string alias)

    (Appears on:StringEndsWithAdvancedFilter_STATUS_ARM)

    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.

    StringEndsWithAdvancedFilter_STATUS_ARM

    (Appears on:AdvancedFilter_STATUS_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    StringEndsWithAdvancedFilter_OperatorType_STATUS_ARM

    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_ARM

    (Appears on:AdvancedFilter_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    StringInAdvancedFilter_OperatorType_ARM

    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_ARM (string alias)

    (Appears on:StringInAdvancedFilter_ARM)

    Value Description

    "StringIn"

    StringInAdvancedFilter_OperatorType_STATUS (string alias)

    (Appears on:StringInAdvancedFilter_STATUS)

    Value Description

    "StringIn"

    StringInAdvancedFilter_OperatorType_STATUS_ARM (string alias)

    (Appears on:StringInAdvancedFilter_STATUS_ARM)

    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.

    StringInAdvancedFilter_STATUS_ARM

    (Appears on:AdvancedFilter_STATUS_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    StringInAdvancedFilter_OperatorType_STATUS_ARM

    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_ARM

    (Appears on:AdvancedFilter_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    StringNotInAdvancedFilter_OperatorType_ARM

    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_ARM (string alias)

    (Appears on:StringNotInAdvancedFilter_ARM)

    Value Description

    "StringNotIn"

    StringNotInAdvancedFilter_OperatorType_STATUS (string alias)

    (Appears on:StringNotInAdvancedFilter_STATUS)

    Value Description

    "StringNotIn"

    StringNotInAdvancedFilter_OperatorType_STATUS_ARM (string alias)

    (Appears on:StringNotInAdvancedFilter_STATUS_ARM)

    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.

    StringNotInAdvancedFilter_STATUS_ARM

    (Appears on:AdvancedFilter_STATUS_ARM)

    Field Description
    key
    string

    Key: The field/property in the event based on which you want to filter.

    operatorType
    StringNotInAdvancedFilter_OperatorType_STATUS_ARM

    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_CreatedByType_STATUS_ARM (string alias)

    (Appears on:SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS_ARM (string alias)

    (Appears on:SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_STATUS

    (Appears on:Domain_STATUS, Domains_Topic_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.

    SystemData_STATUS_ARM

    (Appears on:Domain_STATUS_ARM, Domains_Topic_STATUS_ARM, EventSubscription_STATUS_ARM, Topic_STATUS_ARM)

    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_ARM

    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_ARM

    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}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Topic_Spec


    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.

    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
    configMaps
    TopicOperatorConfigMaps

    ConfigMaps: configures where to place operator written ConfigMaps.

    secrets
    TopicOperatorSecrets

    Secrets: configures where to place Azure generated secrets.

    TopicProperties_ARM

    (Appears on:Topic_Spec_ARM)

    Properties of the Topic

    Field Description
    inboundIpRules
    []InboundIpRule_ARM

    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_ARM

    InputSchema: This determines the format that Event Grid should expect for incoming events published to the topic.

    inputSchemaMapping
    InputSchemaMapping_ARM

    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.

    publicNetworkAccess
    TopicProperties_PublicNetworkAccess_ARM

    PublicNetworkAccess: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring

    TopicProperties_InputSchema (string alias)

    (Appears on:Topic_Spec)

    Value Description

    "CloudEventSchemaV1_0"

    "CustomEventSchema"

    "EventGridSchema"

    TopicProperties_InputSchema_ARM (string alias)

    (Appears on:TopicProperties_ARM)

    Value Description

    "CloudEventSchemaV1_0"

    "CustomEventSchema"

    "EventGridSchema"

    TopicProperties_InputSchema_STATUS (string alias)

    (Appears on:Topic_STATUS)

    Value Description

    "CloudEventSchemaV1_0"

    "CustomEventSchema"

    "EventGridSchema"

    TopicProperties_InputSchema_STATUS_ARM (string alias)

    (Appears on:TopicProperties_STATUS_ARM)

    Value Description

    "CloudEventSchemaV1_0"

    "CustomEventSchema"

    "EventGridSchema"

    TopicProperties_ProvisioningState_STATUS (string alias)

    (Appears on:Topic_STATUS)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    TopicProperties_ProvisioningState_STATUS_ARM (string alias)

    (Appears on:TopicProperties_STATUS_ARM)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    TopicProperties_PublicNetworkAccess (string alias)

    (Appears on:Topic_Spec)

    Value Description

    "Disabled"

    "Enabled"

    TopicProperties_PublicNetworkAccess_ARM (string alias)

    (Appears on:TopicProperties_ARM)

    Value Description

    "Disabled"

    "Enabled"

    TopicProperties_PublicNetworkAccess_STATUS (string alias)

    (Appears on:Topic_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    TopicProperties_PublicNetworkAccess_STATUS_ARM (string alias)

    (Appears on:TopicProperties_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    TopicProperties_STATUS_ARM

    (Appears on:Topic_STATUS_ARM)

    Properties of the Topic

    Field Description
    endpoint
    string

    Endpoint: Endpoint for the topic.

    inboundIpRules
    []InboundIpRule_STATUS_ARM

    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_ARM

    InputSchema: This determines the format that Event Grid should expect for incoming events published to the topic.

    inputSchemaMapping
    InputSchemaMapping_STATUS_ARM

    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_SubResourceEmbedded_ARM
    provisioningState
    TopicProperties_ProvisioningState_STATUS_ARM

    ProvisioningState: Provisioning state of the topic.

    publicNetworkAccess
    TopicProperties_PublicNetworkAccess_STATUS_ARM

    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)

    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_STATUS_ARM

    EventGrid Topic

    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_STATUS_ARM

    Properties: Properties of the topic.

    systemData
    SystemData_STATUS_ARM

    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.

    Topic_Spec_ARM

    Field Description
    location
    string

    Location: Location of the resource.

    name
    string
    properties
    TopicProperties_ARM

    Properties: Properties of the topic.

    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.

    WebHookEventSubscriptionDestinationProperties_ARM

    (Appears on:WebHookEventSubscriptionDestination_ARM)

    Information about the webhook destination properties for an event subscription.

    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.

    WebHookEventSubscriptionDestinationProperties_STATUS_ARM

    (Appears on:WebHookEventSubscriptionDestination_STATUS_ARM)

    Information about the webhook destination properties for an event subscription.

    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.

    maxEventsPerBatch
    int

    MaxEventsPerBatch: Maximum number of events per batch.

    preferredBatchSizeInKilobytes
    int

    PreferredBatchSizeInKilobytes: Preferred batch size in Kilobytes.

    WebHookEventSubscriptionDestination_ARM

    (Appears on:EventSubscriptionDestination_ARM)

    Field Description
    endpointType
    WebHookEventSubscriptionDestination_EndpointType_ARM

    EndpointType: Type of the endpoint for the event subscription destination.

    properties
    WebHookEventSubscriptionDestinationProperties_ARM

    Properties: WebHook Properties of the event subscription destination.

    WebHookEventSubscriptionDestination_EndpointType (string alias)

    (Appears on:WebHookEventSubscriptionDestination)

    Value Description

    "WebHook"

    WebHookEventSubscriptionDestination_EndpointType_ARM (string alias)

    (Appears on:WebHookEventSubscriptionDestination_ARM)

    Value Description

    "WebHook"

    WebHookEventSubscriptionDestination_EndpointType_STATUS (string alias)

    (Appears on:WebHookEventSubscriptionDestination_STATUS)

    Value Description

    "WebHook"

    WebHookEventSubscriptionDestination_EndpointType_STATUS_ARM (string alias)

    (Appears on:WebHookEventSubscriptionDestination_STATUS_ARM)

    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.

    WebHookEventSubscriptionDestination_STATUS_ARM

    (Appears on:EventSubscriptionDestination_STATUS_ARM)

    Field Description
    endpointType
    WebHookEventSubscriptionDestination_EndpointType_STATUS_ARM

    EndpointType: Type of the endpoint for the event subscription destination.

    properties
    WebHookEventSubscriptionDestinationProperties_STATUS_ARM

    Properties: WebHook Properties of the event subscription destination.