Package-level declarations

Types

data class AzureADPartnerClientAuthenticationResponse(val azureActiveDirectoryApplicationIdOrUri: String? = null, val azureActiveDirectoryTenantId: String? = null, val clientAuthenticationType: String)

Azure Active Directory Partner Client Authentication

data class AzureFunctionEventSubscriptionDestinationResponse(val deliveryAttributeMappings: List<Either<DynamicDeliveryAttributeMappingResponse, StaticDeliveryAttributeMappingResponse>>? = null, val endpointType: String, val maxEventsPerBatch: Int? = null, val preferredBatchSizeInKilobytes: Int? = null, val resourceId: String? = null)

Information about the azure function destination for an event subscription.

Link copied to clipboard
data class BoolEqualsAdvancedFilterResponse(val key: String? = null, val operatorType: String, val value: Boolean? = null)

BoolEquals Advanced Filter.

Link copied to clipboard
data class ConnectionStateResponse(val actionsRequired: String? = null, val description: String? = null, val status: String? = null)

ConnectionState information.

Link copied to clipboard

Information about the deadletter destination with resource identity.

Link copied to clipboard
data class DeliveryWithResourceIdentityResponse(val destination: Any? = null, val identity: EventSubscriptionIdentityResponse? = null)

Information about the delivery for an event subscription with resource identity.

Link copied to clipboard
data class DynamicDeliveryAttributeMappingResponse(val name: String? = null, val sourceField: String? = null, val type: String)

Dynamic delivery attribute mapping details.

Link copied to clipboard
data class EventChannelDestinationResponse(val azureSubscriptionId: String? = null, val partnerTopicName: String? = null, val resourceGroup: String? = null)

Properties of the destination of an event channel.

Link copied to clipboard
data class EventChannelFilterResponse(val advancedFilters: List<Any>? = null, val enableAdvancedFilteringOnArrays: Boolean? = null)

Filter for the Event Channel.

Link copied to clipboard
data class EventChannelSourceResponse(val source: String? = null)

Properties of the source of an event channel.

data class EventHubEventSubscriptionDestinationResponse(val deliveryAttributeMappings: List<Either<DynamicDeliveryAttributeMappingResponse, StaticDeliveryAttributeMappingResponse>>? = null, val endpointType: String, val resourceId: String? = null)

Information about the event hub destination for an event subscription.

Link copied to clipboard
data class EventSubscriptionFilterResponse(val advancedFilters: List<Any>? = null, val enableAdvancedFilteringOnArrays: Boolean? = null, val includedEventTypes: List<String>? = null, val isSubjectCaseSensitive: Boolean? = null, val subjectBeginsWith: String? = null, val subjectEndsWith: String? = null)

Filter for the Event Subscription.

Link copied to clipboard
data class EventSubscriptionIdentityResponse(val type: String? = null, val userAssignedIdentity: String? = null)

The identity information with the event subscription.

Link copied to clipboard
data class EventTypeInfoResponse(val inlineEventTypes: Map<String, InlineEventPropertiesResponse>? = null, val kind: String? = null)

The event type information for Channels.

Link copied to clipboard
data class GetChannelFullUrlResult(val endpointUrl: String? = null)

Full endpoint url of an event subscription

Link copied to clipboard
data class GetChannelResult(val channelType: String? = null, val expirationTimeIfNotActivatedUtc: String? = null, val id: String, val messageForActivation: String? = null, val name: String, val partnerDestinationInfo: WebhookPartnerDestinationInfoResponse? = null, val partnerTopicInfo: PartnerTopicInfoResponse? = null, val provisioningState: String? = null, val readinessState: String? = null, val systemData: SystemDataResponse, val type: String)

Channel info.

Link copied to clipboard
data class GetDomainEventSubscriptionFullUrlResult(val endpointUrl: String? = null)

Full endpoint url of an event subscription

Link copied to clipboard
data class GetDomainEventSubscriptionResult(val deadLetterDestination: StorageBlobDeadLetterDestinationResponse? = null, val deadLetterWithResourceIdentity: DeadLetterWithResourceIdentityResponse? = null, val deliveryWithResourceIdentity: DeliveryWithResourceIdentityResponse? = null, val destination: Any? = null, val eventDeliverySchema: String? = null, val expirationTimeUtc: String? = null, val filter: EventSubscriptionFilterResponse? = null, val id: String, val labels: List<String>? = null, val name: String, val provisioningState: String, val retryPolicy: RetryPolicyResponse? = null, val systemData: SystemDataResponse, val topic: String, val type: String)

Event Subscription

Link copied to clipboard
data class GetDomainResult(val endpoint: String, val id: String, val inboundIpRules: List<InboundIpRuleResponse>? = null, val inputSchema: String? = null, val inputSchemaMapping: JsonInputSchemaMappingResponse? = null, val location: String, val metricResourceId: String, val name: String, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val publicNetworkAccess: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

EventGrid Domain.

data class GetDomainTopicEventSubscriptionFullUrlResult(val endpointUrl: String? = null)

Full endpoint url of an event subscription

Link copied to clipboard
data class GetDomainTopicEventSubscriptionResult(val deadLetterDestination: StorageBlobDeadLetterDestinationResponse? = null, val deadLetterWithResourceIdentity: DeadLetterWithResourceIdentityResponse? = null, val deliveryWithResourceIdentity: DeliveryWithResourceIdentityResponse? = null, val destination: Any? = null, val eventDeliverySchema: String? = null, val expirationTimeUtc: String? = null, val filter: EventSubscriptionFilterResponse? = null, val id: String, val labels: List<String>? = null, val name: String, val provisioningState: String, val retryPolicy: RetryPolicyResponse? = null, val systemData: SystemDataResponse, val topic: String, val type: String)

Event Subscription

Link copied to clipboard
data class GetDomainTopicResult(val id: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

Domain Topic.

Link copied to clipboard
data class GetEventChannelResult(val destination: EventChannelDestinationResponse? = null, val expirationTimeIfNotActivatedUtc: String? = null, val filter: EventChannelFilterResponse? = null, val id: String, val name: String, val partnerTopicFriendlyDescription: String? = null, val partnerTopicReadinessState: String, val provisioningState: String, val source: EventChannelSourceResponse? = null, val systemData: SystemDataResponse, val type: String)

Event Channel.

Result of the Get delivery attributes operation.

Link copied to clipboard
data class GetEventSubscriptionFullUrlResult(val endpointUrl: String? = null)

Full endpoint url of an event subscription

Link copied to clipboard
data class GetEventSubscriptionResult(val deadLetterDestination: StorageBlobDeadLetterDestinationResponse? = null, val destination: Any? = null, val eventDeliverySchema: String? = null, val expirationTimeUtc: String? = null, val filter: EventSubscriptionFilterResponse? = null, val id: String, val labels: List<String>? = null, val name: String, val provisioningState: String, val retryPolicy: RetryPolicyResponse? = null, val systemData: SystemDataResponse, val topic: String, val type: String)

Event Subscription

Link copied to clipboard
data class GetPartnerConfigurationResult(val id: String, val location: String? = null, val name: String, val partnerAuthorization: PartnerAuthorizationResponse? = null, val provisioningState: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Partner configuration information

Link copied to clipboard
data class GetPartnerDestinationResult(val activationState: String? = null, val endpointBaseUrl: String? = null, val endpointServiceContext: String? = null, val expirationTimeIfNotActivatedUtc: String? = null, val id: String, val location: String, val messageForActivation: String? = null, val name: String, val partnerRegistrationImmutableId: String? = null, val provisioningState: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Event Grid Partner Destination.

Link copied to clipboard
data class GetPartnerNamespaceResult(val disableLocalAuth: Boolean? = null, val endpoint: String, val id: String, val inboundIpRules: List<InboundIpRuleResponse>? = null, val location: String, val name: String, val partnerRegistrationFullyQualifiedId: String? = null, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val publicNetworkAccess: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

EventGrid Partner Namespace.

Link copied to clipboard
data class GetPartnerRegistrationResult(val authorizedAzureSubscriptionIds: List<String>? = null, val customerServiceUri: String? = null, val id: String, val location: String, val logoUri: String? = null, val longDescription: String? = null, val name: String, val partnerCustomerServiceExtension: String? = null, val partnerCustomerServiceNumber: String? = null, val partnerName: String? = null, val partnerResourceTypeDescription: String? = null, val partnerResourceTypeDisplayName: String? = null, val partnerResourceTypeName: String? = null, val provisioningState: String, val setupUri: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val visibilityState: String? = null)

Information about a partner registration.

data class GetPartnerTopicEventSubscriptionFullUrlResult(val endpointUrl: String? = null)

Full endpoint url of an event subscription

Link copied to clipboard
data class GetPartnerTopicEventSubscriptionResult(val deadLetterDestination: StorageBlobDeadLetterDestinationResponse? = null, val deadLetterWithResourceIdentity: DeadLetterWithResourceIdentityResponse? = null, val deliveryWithResourceIdentity: DeliveryWithResourceIdentityResponse? = null, val destination: Any? = null, val eventDeliverySchema: String? = null, val expirationTimeUtc: String? = null, val filter: EventSubscriptionFilterResponse? = null, val id: String, val labels: List<String>? = null, val name: String, val provisioningState: String, val retryPolicy: RetryPolicyResponse? = null, val systemData: SystemDataResponse, val topic: String, val type: String)

Event Subscription

Link copied to clipboard
data class GetPartnerTopicResult(val activationState: String? = null, val eventTypeInfo: EventTypeInfoResponse? = null, val expirationTimeIfNotActivatedUtc: String? = null, val id: String, val identity: IdentityInfoResponse? = null, val location: String, val messageForActivation: String? = null, val name: String, val partnerRegistrationImmutableId: String? = null, val partnerTopicFriendlyDescription: String? = null, val provisioningState: String, val source: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Event Grid Partner Topic.

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val groupIds: List<String>? = null, val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: ConnectionStateResponse? = null, val provisioningState: String? = null, val type: String)
data class GetSystemTopicEventSubscriptionFullUrlResult(val endpointUrl: String? = null)

Full endpoint url of an event subscription

Link copied to clipboard
data class GetSystemTopicEventSubscriptionResult(val deadLetterDestination: StorageBlobDeadLetterDestinationResponse? = null, val deadLetterWithResourceIdentity: DeadLetterWithResourceIdentityResponse? = null, val deliveryWithResourceIdentity: DeliveryWithResourceIdentityResponse? = null, val destination: Any? = null, val eventDeliverySchema: String? = null, val expirationTimeUtc: String? = null, val filter: EventSubscriptionFilterResponse? = null, val id: String, val labels: List<String>? = null, val name: String, val provisioningState: String, val retryPolicy: RetryPolicyResponse? = null, val systemData: SystemDataResponse, val topic: String, val type: String)

Event Subscription

Link copied to clipboard
data class GetSystemTopicResult(val id: String, val identity: IdentityInfoResponse? = null, val location: String, val metricResourceId: String, val name: String, val provisioningState: String, val source: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val topicType: String? = null, val type: String)

EventGrid System Topic.

Result of the Get delivery attributes operation.

Link copied to clipboard
data class GetTopicEventSubscriptionFullUrlResult(val endpointUrl: String? = null)

Full endpoint url of an event subscription

Link copied to clipboard
data class GetTopicEventSubscriptionResult(val deadLetterDestination: StorageBlobDeadLetterDestinationResponse? = null, val deadLetterWithResourceIdentity: DeadLetterWithResourceIdentityResponse? = null, val deliveryWithResourceIdentity: DeliveryWithResourceIdentityResponse? = null, val destination: Any? = null, val eventDeliverySchema: String? = null, val expirationTimeUtc: String? = null, val filter: EventSubscriptionFilterResponse? = null, val id: String, val labels: List<String>? = null, val name: String, val provisioningState: String, val retryPolicy: RetryPolicyResponse? = null, val systemData: SystemDataResponse, val topic: String, val type: String)

Event Subscription

Link copied to clipboard
data class GetTopicResult(val endpoint: String, val id: String, val inboundIpRules: List<InboundIpRuleResponse>? = null, val inputSchema: String? = null, val inputSchemaMapping: JsonInputSchemaMappingResponse? = null, val location: String, val metricResourceId: String, val name: String, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val publicNetworkAccess: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

EventGrid Topic

data class HybridConnectionEventSubscriptionDestinationResponse(val deliveryAttributeMappings: List<Either<DynamicDeliveryAttributeMappingResponse, StaticDeliveryAttributeMappingResponse>>? = null, val endpointType: String, val resourceId: String? = null)

Information about the HybridConnection destination for an event subscription.

Link copied to clipboard
data class IdentityInfoResponse(val principalId: String? = null, val tenantId: String? = null, val type: String? = null, val userAssignedIdentities: Map<String, UserIdentityPropertiesResponse>? = null)

The identity information for the resource.

Link copied to clipboard
data class InboundIpRuleResponse(val action: String? = null, val ipMask: String? = null)
Link copied to clipboard
data class InlineEventPropertiesResponse(val dataSchemaUrl: String? = null, val description: String? = null, val documentationUrl: String? = null)

Additional information about every inline event.

Link copied to clipboard
data class IsNotNullAdvancedFilterResponse(val key: String? = null, val operatorType: String)

IsNotNull Advanced Filter.

Link copied to clipboard
data class IsNullOrUndefinedAdvancedFilterResponse(val key: String? = null, val operatorType: String)

IsNullOrUndefined Advanced Filter.

Link copied to clipboard
data class JsonFieldResponse(val sourceField: String? = null)

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.

Link copied to clipboard
data class JsonFieldWithDefaultResponse(val defaultValue: String? = null, val sourceField: String? = null)

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.

Link copied to clipboard
data class JsonInputSchemaMappingResponse(val dataVersion: JsonFieldWithDefaultResponse? = null, val eventTime: JsonFieldResponse? = null, val eventType: JsonFieldWithDefaultResponse? = null, val id: JsonFieldResponse? = null, val inputSchemaMappingType: String, val subject: JsonFieldWithDefaultResponse? = null, val topic: JsonFieldResponse? = null)

This enables publishing to Event Grid using a custom input schema. This can be used to map properties from a custom input JSON schema to the Event Grid event schema.

Link copied to clipboard
data class ListDomainSharedAccessKeysResult(val key1: String? = null, val key2: String? = null)

Shared access keys of the Domain.

data class ListPartnerNamespaceSharedAccessKeysResult(val key1: String? = null, val key2: String? = null)

Shared access keys of the partner namespace.

Link copied to clipboard
data class ListTopicSharedAccessKeysResult(val key1: String? = null, val key2: String? = null)

Shared access keys of the Topic

Link copied to clipboard
data class NumberGreaterThanAdvancedFilterResponse(val key: String? = null, val operatorType: String, val value: Double? = null)

NumberGreaterThan Advanced Filter.

data class NumberGreaterThanOrEqualsAdvancedFilterResponse(val key: String? = null, val operatorType: String, val value: Double? = null)

NumberGreaterThanOrEquals Advanced Filter.

Link copied to clipboard
data class NumberInAdvancedFilterResponse(val key: String? = null, val operatorType: String, val values: List<Double>? = null)

NumberIn Advanced Filter.

Link copied to clipboard
data class NumberInRangeAdvancedFilterResponse(val key: String? = null, val operatorType: String, val values: List<List<Double>>? = null)

NumberInRange Advanced Filter.

Link copied to clipboard
data class NumberLessThanAdvancedFilterResponse(val key: String? = null, val operatorType: String, val value: Double? = null)

NumberLessThan Advanced Filter.

data class NumberLessThanOrEqualsAdvancedFilterResponse(val key: String? = null, val operatorType: String, val value: Double? = null)

NumberLessThanOrEquals Advanced Filter.

Link copied to clipboard
data class NumberNotInAdvancedFilterResponse(val key: String? = null, val operatorType: String, val values: List<Double>? = null)

NumberNotIn Advanced Filter.

Link copied to clipboard
data class NumberNotInRangeAdvancedFilterResponse(val key: String? = null, val operatorType: String, val values: List<List<Double>>? = null)

NumberNotInRange Advanced Filter.

Link copied to clipboard
data class PartnerAuthorizationResponse(val authorizedPartnersList: List<PartnerResponse>? = null, val defaultMaximumExpirationTimeInDays: Int? = null)

The partner authorization details.

data class PartnerEventSubscriptionDestinationResponse(val endpointType: String, val resourceId: String? = null)
Link copied to clipboard
data class PartnerResponse(val authorizationExpirationTimeInUtc: String? = null, val partnerName: String? = null, val partnerRegistrationImmutableId: String? = null)

Information about the partner.

Link copied to clipboard
data class PartnerTopicInfoResponse(val azureSubscriptionId: String? = null, val eventTypeInfo: EventTypeInfoResponse? = null, val name: String? = null, val resourceGroupName: String? = null, val source: String? = null)

Properties of the corresponding partner topic of a Channel.

Link copied to clipboard
data class PrivateEndpointConnectionResponse(val groupIds: List<String>? = null, val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: ConnectionStateResponse? = null, val provisioningState: String? = null, val type: String)
Link copied to clipboard
data class PrivateEndpointResponse(val id: String? = null)

PrivateEndpoint information.

Link copied to clipboard
data class ResourceMoveChangeHistoryResponse(val azureSubscriptionId: String? = null, val changedTimeUtc: String? = null, val resourceGroupName: String? = null)

The change history of the resource move.

Link copied to clipboard
data class RetryPolicyResponse(val eventTimeToLiveInMinutes: Int? = null, val maxDeliveryAttempts: Int? = null)

Information about the retry policy for an event subscription.

data class ServiceBusQueueEventSubscriptionDestinationResponse(val deliveryAttributeMappings: List<Either<DynamicDeliveryAttributeMappingResponse, StaticDeliveryAttributeMappingResponse>>? = null, val endpointType: String, val resourceId: String? = null)

Information about the service bus destination for an event subscription.

data class ServiceBusTopicEventSubscriptionDestinationResponse(val deliveryAttributeMappings: List<Either<DynamicDeliveryAttributeMappingResponse, StaticDeliveryAttributeMappingResponse>>? = null, val endpointType: String, val resourceId: String? = null)

Information about the service bus topic destination for an event subscription.

Link copied to clipboard
data class StaticDeliveryAttributeMappingResponse(val isSecret: Boolean? = null, val name: String? = null, val type: String, val value: String? = null)

Static delivery attribute mapping details.

Link copied to clipboard
data class StorageBlobDeadLetterDestinationResponse(val blobContainerName: String? = null, val endpointType: String, val resourceId: String? = null)

Information about the storage blob based dead letter destination.

data class StorageQueueEventSubscriptionDestinationResponse(val endpointType: String, val queueMessageTimeToLiveInSeconds: Double? = null, val queueName: String? = null, val resourceId: String? = null)

Information about the storage queue destination for an event subscription.

Link copied to clipboard
data class StringBeginsWithAdvancedFilterResponse(val key: String? = null, val operatorType: String, val values: List<String>? = null)

StringBeginsWith Advanced Filter.

Link copied to clipboard
data class StringContainsAdvancedFilterResponse(val key: String? = null, val operatorType: String, val values: List<String>? = null)

StringContains Advanced Filter.

Link copied to clipboard
data class StringEndsWithAdvancedFilterResponse(val key: String? = null, val operatorType: String, val values: List<String>? = null)

StringEndsWith Advanced Filter.

Link copied to clipboard
data class StringInAdvancedFilterResponse(val key: String? = null, val operatorType: String, val values: List<String>? = null)

StringIn Advanced Filter.

data class StringNotBeginsWithAdvancedFilterResponse(val key: String? = null, val operatorType: String, val values: List<String>? = null)

StringNotBeginsWith Advanced Filter.

Link copied to clipboard
data class StringNotContainsAdvancedFilterResponse(val key: String? = null, val operatorType: String, val values: List<String>? = null)

StringNotContains Advanced Filter.

Link copied to clipboard
data class StringNotEndsWithAdvancedFilterResponse(val key: String? = null, val operatorType: String, val values: List<String>? = null)

StringNotEndsWith Advanced Filter.

Link copied to clipboard
data class StringNotInAdvancedFilterResponse(val key: String? = null, val operatorType: String, val values: List<String>? = null)

StringNotIn Advanced Filter.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class UserIdentityPropertiesResponse(val clientId: String? = null, val principalId: String? = null)

The information about the user identity.

data class WebHookEventSubscriptionDestinationResponse(val azureActiveDirectoryApplicationIdOrUri: String? = null, val azureActiveDirectoryTenantId: String? = null, val deliveryAttributeMappings: List<Either<DynamicDeliveryAttributeMappingResponse, StaticDeliveryAttributeMappingResponse>>? = null, val endpointBaseUrl: String, val endpointType: String, val endpointUrl: String? = null, val maxEventsPerBatch: Int? = null, val preferredBatchSizeInKilobytes: Int? = null)

Information about the webhook destination for an event subscription.

Link copied to clipboard
data class WebhookPartnerDestinationInfoResponse(val azureSubscriptionId: String? = null, val clientAuthentication: AzureADPartnerClientAuthenticationResponse? = null, val endpointBaseUrl: String? = null, val endpointServiceContext: String? = null, val endpointType: String, val endpointUrl: String? = null, val name: String? = null, val resourceGroupName: String? = null, val resourceMoveChangeHistory: List<ResourceMoveChangeHistoryResponse>? = null)

Information about the WebHook of the partner destination.