Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
| AdvancedFilter |
This is the base type that represents an advanced filter. To configure an advanced filter, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class such as BoolEqualsAdvancedFilter, NumberInAdvancedFilter, StringEqualsAdvancedFilter etc. depending on the type of the key based on which you want to filter. |
| Any |
Anything |
| AzureAdPartnerClientAuthentication |
Azure Active Directory Partner Client Authentication |
| AzureAdPartnerClientAuthenticationProperties |
Properties of an Azure Active Directory Partner Client Authentication. |
| AzureFunctionEventSubscriptionDestination |
Information about the azure function destination for an event subscription. |
| AzureFunctionEventSubscriptionDestinationProperties |
The properties that represent the Azure Function destination of an event subscription. |
| BoolEqualsAdvancedFilter |
BoolEquals Advanced Filter. |
| BoolEqualsFilter |
BoolEquals Filter. |
| CaCertificate |
The CA Certificate resource. |
| CaCertificateProperties |
The properties of CA certificate. |
| CaCertificatesListResult |
Result of the List CA Certificate operation. |
| Channel |
Channel info. |
| ChannelProperties |
Properties of the Channel. |
| ChannelsListResult |
Result of the List Channels operation |
| ChannelUpdateParameters |
Properties of the Channel update. |
| ChannelUpdateParametersProperties |
Properties of the channel update parameters. |
| Client |
The Client resource. |
| ClientAuthentication |
The Authentication properties for the client. |
| ClientAuthenticationSettings |
Client authentication settings for namespace resource. |
| ClientCertificateAuthentication |
The certificate authentication properties for the client. |
| ClientCertificateSubjectDistinguishedName |
CA certificate subject distinguished name information used by service to authenticate clients. For more information, see https://docs.microsoft.com/en-us/dotnet/api/system.security.cryptography.x509certificates.x500distinguishedname?view=net-6.0#remarks |
| ClientCertificateThumbprint |
Thumbprints are used by the service to validate the device permission when authentication is done using self signed certificate. |
| ClientGroup |
The Client group resource. |
| ClientGroupProperties |
The properties of client group. |
| ClientGroupsListResult |
Result of the List Client Group operation. |
| ClientProperties |
The properties of client. |
| ClientPropertiesAttributes |
Attributes for the client. Supported values are int, bool, string, string[]. Example: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] } |
| ClientsListResult |
Result of the List Client operation. |
| ConnectionState |
ConnectionState information. |
| DeadLetterDestination |
Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class. |
| DeadLetterWithResourceIdentity |
Information about the deadletter destination with resource identity. |
| DeliveryAttributeListResult |
Result of the Get delivery attributes operation. |
| DeliveryAttributeMapping |
Delivery attribute mapping details. |
| DeliveryConfiguration |
Properties of the delivery configuration information of the event subscription. |
| DeliveryWithResourceIdentity |
Information about the delivery for an event subscription with resource identity. |
| Domain |
EventGrid Domain. |
| DomainProperties |
Properties of the Event Grid Domain Resource. |
| DomainRegenerateKeyRequest |
Domain regenerate share access key request. |
| DomainSharedAccessKeys |
Shared access keys of the Domain. |
| DomainsListResult |
Result of the List Domains operation. |
| DomainTopic |
Domain Topic. |
| DomainTopicProperties |
Properties of the Domain Topic. |
| DomainTopicsListResult |
Result of the List Domain Topics operation. |
| DomainUpdateParameterProperties |
Information of domain update parameter properties. |
| DomainUpdateParameters |
Properties of the Domain update. |
| DomainUpdateParametersTags |
Tags of the domains resource. |
| DynamicDeliveryAttributeMapping |
Dynamic delivery attribute mapping details. |
| DynamicDeliveryAttributeMappingProperties |
Properties of dynamic delivery attribute mapping. |
| DynamicRoutingEnrichment | |
| ErrorAdditionalInfo |
The resource management error additional info. |
| ErrorDetail |
The error detail. |
| ErrorResponse |
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). |
| EventGridIdentity | |
| EventHubEventSubscriptionDestination |
Information about the event hub destination for an event subscription. |
| EventHubEventSubscriptionDestinationProperties |
The properties for a event hub destination. |
| EventSubscription |
Event Subscription. |
| EventSubscriptionDestination |
Information about the destination for an event subscription. |
| EventSubscriptionFilter |
Filter for the Event Subscription. |
| EventSubscriptionFullUrl |
Full endpoint url of an event subscription |
| EventSubscriptionIdentity |
The identity information with the event subscription. |
| EventSubscriptionProperties |
Properties of the Event Subscription. |
| EventSubscriptionsListResult |
Result of the List EventSubscriptions operation |
| EventSubscriptionUpdateParameters |
Properties of the Event Subscription update. |
| EventType |
Event Type for a subject under a topic |
| EventTypeInfo |
The event type information for Channels. |
| EventTypeInfoInlineEventTypes |
A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. An example of a valid inline event name is "Contoso.OrderCreated". The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type. |
| EventTypeProperties |
Properties of the event type |
| EventTypesListResult |
Result of the List Event Types operation |
| ExtendedLocation |
Definition of an Extended Location |
| ExtensionTopic |
Event grid Extension Topic. This is used for getting Event Grid related metrics for Azure resources. |
| ExtensionTopicProperties |
Properties of the Extension Topic |
| Filter |
This is the base type that represents a filter. To configure a filter, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class such as BoolEqualsFilter, NumberInFilter, StringEqualsFilter etc depending on the type of the key based on which you want to filter. |
| FiltersConfiguration |
Filters configuration for the Event Subscription. |
| HybridConnectionEventSubscriptionDestination |
Information about the HybridConnection destination for an event subscription. |
| HybridConnectionEventSubscriptionDestinationProperties |
The properties for a hybrid connection destination. |
| IdentityInfo |
The identity information for the resource. |
| IdentityInfoUserAssignedIdentities |
The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. This property is currently not used and reserved for future usage. |
| InboundIPRule | |
| InlineEventProperties |
Additional information about every inline event. |
| InputSchemaMapping |
By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only supported type of InputSchemaMapping is 'JsonInputSchemaMapping'. |
| IsNotNullAdvancedFilter |
IsNotNull Advanced Filter. |
| IsNotNullFilter |
IsNotNull Filter. |
| IsNullOrUndefinedAdvancedFilter |
IsNullOrUndefined Advanced Filter. |
| IsNullOrUndefinedFilter |
IsNullOrUndefined Filter. |
| JsonField |
This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id', 'topic' and 'eventtime' properties. This represents a field in the input event schema. |
| JsonFieldWithDefault |
This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject', 'eventtype' and 'dataversion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided. |
| JsonInputSchemaMapping |
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. |
| JsonInputSchemaMappingProperties |
This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. |
| Namespace |
Namespace resource. |
| NamespaceProperties |
Properties of the namespace resource. |
| NamespaceRegenerateKeyRequest |
Namespace regenerate share access key request. |
| NamespaceSharedAccessKeys |
Shared access keys of the Namespace. |
| NamespaceSku |
Represents available Sku pricing tiers. |
| NamespacesListResult |
Result of the List Namespaces operation. |
| NamespaceTopic |
Namespace topic details. |
| NamespaceTopicProperties |
Properties of the namespace topic. |
| NamespaceTopicsListResult |
Result of the List namespace topics operation. |
| NamespaceTopicUpdateParameterProperties |
Information of namespace topic update parameter properties. |
| NamespaceTopicUpdateParameters |
Properties of the namespace topic update. |
| NamespaceUpdateParameterProperties |
Information of namespace update parameter properties. |
| NamespaceUpdateParameters |
Properties to update namespace. |
| NamespaceUpdateParametersTags |
Tags of the namespace resource. |
| NumberGreaterThanAdvancedFilter |
NumberGreaterThan Advanced Filter. |
| NumberGreaterThanFilter |
NumberGreaterThan Filter. |
| NumberGreaterThanOrEqualsAdvancedFilter |
NumberGreaterThanOrEquals Advanced Filter. |
| NumberGreaterThanOrEqualsFilter |
NumberGreaterThanOrEquals Filter. |
| NumberInAdvancedFilter |
NumberIn Advanced Filter. |
| NumberInFilter |
NumberIn Filter. |
| NumberInRangeAdvancedFilter |
NumberInRange Advanced Filter. |
| NumberInRangeFilter |
NumberInRange Filter. |
| NumberLessThanAdvancedFilter |
NumberLessThan Advanced Filter. |
| NumberLessThanFilter |
NumberLessThan Filter. |
| NumberLessThanOrEqualsAdvancedFilter |
NumberLessThanOrEquals Advanced Filter. |
| NumberLessThanOrEqualsFilter |
NumberLessThanOrEquals Filter. |
| NumberNotInAdvancedFilter |
NumberNotIn Advanced Filter. |
| NumberNotInFilter |
NumberNotIn Filter. |
| NumberNotInRangeAdvancedFilter |
NumberNotInRange Advanced Filter. |
| NumberNotInRangeFilter |
NumberNotInRange Filter. |
| Operation |
Represents an operation returned by the GetOperations request. |
| OperationInfo |
Information about an operation |
| OperationsListResult |
Result of the List Operations operation |
| Partner |
Information about the partner. |
| PartnerAuthorization |
The partner authorization details. |
| PartnerClientAuthentication |
Partner client authentication |
| PartnerConfiguration |
Partner configuration information |
| PartnerConfigurationProperties |
Properties of the partner configuration. |
| PartnerConfigurationsListResult |
Result of the List partner configurations operation |
| PartnerConfigurationTags |
Tags of the resource. |
| PartnerConfigurationUpdateParameterProperties |
Information of partner configuration update parameter properties. |
| PartnerConfigurationUpdateParameters |
Properties of the partner configuration update. |
| PartnerConfigurationUpdateParametersTags |
Tags of the partner configuration resource. |
| PartnerDestination |
Event Grid Partner Destination. |
| PartnerDestinationInfo |
Properties of the corresponding partner destination of a Channel. |
| PartnerDestinationProperties |
Properties of the Partner Destination. |
| PartnerDestinationsListResult |
Result of the List Partner Destinations operation. |
| PartnerDestinationUpdateParameters |
Properties of the Partner Destination that can be updated. |
| PartnerDestinationUpdateParametersTags |
Tags of the Partner Destination resource. |
| PartnerDetails |
Information about the partner. |
| PartnerEventSubscriptionDestination | |
| PartnerEventSubscriptionDestinationProperties | |
| PartnerNamespace |
EventGrid Partner Namespace. |
| PartnerNamespaceProperties |
Properties of the partner namespace. |
| PartnerNamespaceRegenerateKeyRequest |
PartnerNamespace regenerate shared access key request. |
| PartnerNamespaceSharedAccessKeys |
Shared access keys of the partner namespace. |
| PartnerNamespacesListResult |
Result of the List Partner Namespaces operation |
| PartnerNamespaceUpdateParameterProperties |
Information of Partner Namespace update parameter properties. |
| PartnerNamespaceUpdateParameters |
Properties of the Partner Namespace update. |
| PartnerNamespaceUpdateParametersTags |
Tags of the Partner Namespace. |
| PartnerRegistration |
Information about a partner registration. |
| PartnerRegistrationProperties |
Properties of the partner registration. |
| PartnerRegistrationsListResult |
Result of the List Partner Registrations operation. |
| PartnerRegistrationUpdateParameters |
Properties of the Partner Registration update. |
| PartnerRegistrationUpdateParametersTags |
Tags of the partner registration resource. |
| PartnerTopic |
Event Grid Partner Topic. |
| PartnerTopicInfo |
Properties of the corresponding partner topic of a Channel. |
| PartnerTopicProperties |
Properties of the Partner Topic. |
| PartnerTopicsListResult |
Result of the List Partner Topics operation. |
| PartnerTopicUpdateParameters |
Properties of the Partner Topic update. |
| PartnerTopicUpdateParametersTags |
Tags of the Partner Topic resource. |
| PartnerUpdateDestinationInfo |
Properties of the corresponding partner destination of a Channel. |
| PartnerUpdateTopicInfo |
Update properties for the corresponding partner topic of a channel. |
| PermissionBinding |
The Permission binding resource. |
| PermissionBindingProperties |
The properties of permission binding. |
| PermissionBindingsListResult |
Result of the List Permission Binding operation. |
| PrivateEndpoint |
PrivateEndpoint information. |
| PrivateEndpointConnection | |
| PrivateEndpointConnectionListResult |
Result of the list of all private endpoint connections operation. |
| PrivateEndpointConnectionProperties |
Properties of the private endpoint connection resource. |
| PrivateLinkResource |
Information of the private link resource. |
| PrivateLinkResourceProperties | |
| PrivateLinkResourcesListResult |
Result of the List private link resources operation. |
| QueueInfo |
Properties of the Queue info for event subscription. |
| Resource |
Definition of a Resource. |
| ResourceMoveChangeHistory |
The change history of the resource move. |
| ResourceSku |
Describes an EventGrid Resource Sku. |
| RetryPolicy |
Information about the retry policy for an event subscription. |
| RoutingEnrichments | |
| RoutingIdentityInfo |
Routing identity info for topic spaces configuration. |
| ServiceBusQueueEventSubscriptionDestination |
Information about the service bus destination for an event subscription. |
| ServiceBusQueueEventSubscriptionDestinationProperties |
The properties that represent the Service Bus destination of an event subscription. |
| ServiceBusTopicEventSubscriptionDestination |
Information about the service bus topic destination for an event subscription. |
| ServiceBusTopicEventSubscriptionDestinationProperties |
The properties that represent the Service Bus Topic destination of an event subscription. |
| StaticDeliveryAttributeMapping |
Static delivery attribute mapping details. |
| StaticDeliveryAttributeMappingProperties |
Properties of static delivery attribute mapping. |
| StaticRoutingEnrichment | |
| StorageBlobDeadLetterDestination |
Information about the storage blob based dead letter destination. |
| StorageBlobDeadLetterDestinationProperties |
Properties of the storage blob based dead letter destination. |
| StorageQueueEventSubscriptionDestination |
Information about the storage queue destination for an event subscription. |
| StorageQueueEventSubscriptionDestinationProperties |
The properties for a storage queue destination. |
| StringBeginsWithAdvancedFilter |
StringBeginsWith Advanced Filter. |
| StringBeginsWithFilter |
StringBeginsWith Filter. |
| StringContainsAdvancedFilter |
StringContains Advanced Filter. |
| StringContainsFilter |
StringContains Filter. |
| StringEndsWithAdvancedFilter |
StringEndsWith Advanced Filter. |
| StringEndsWithFilter |
StringEndsWith Filter. |
| StringInAdvancedFilter |
StringIn Advanced Filter. |
| StringInFilter |
StringIn Filter. |
| StringNotBeginsWithAdvancedFilter |
StringNotBeginsWith Advanced Filter. |
| StringNotBeginsWithFilter |
StringNotBeginsWith Filter. |
| StringNotContainsAdvancedFilter |
StringNotContains Advanced Filter. |
| StringNotContainsFilter |
StringNotContains Filter. |
| StringNotEndsWithAdvancedFilter |
StringNotEndsWith Advanced Filter. |
| StringNotEndsWithFilter |
StringNotEndsWith Filter. |
| StringNotInAdvancedFilter |
StringNotIn Advanced Filter. |
| StringNotInFilter |
StringNotIn Filter. |
| Subscription |
Event Subscription. |
| SubscriptionProperties |
Properties of the event subscription. |
| SubscriptionsListResult |
Result of the List event subscriptions operation. |
| SubscriptionUpdateParameters |
Properties of the Event Subscription update. |
| SubscriptionUpdateParametersProperties |
Properties of the Event Subscription update parameters. |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| SystemTopic |
EventGrid System Topic. |
| SystemTopicProperties |
Properties of the System Topic. |
| SystemTopicsListResult |
Result of the List System topics operation. |
| SystemTopicUpdateParameters |
Properties of the System Topic update. |
| SystemTopicUpdateParametersTags |
Tags of the system topic. |
| Topic |
EventGrid Topic |
| TopicProperties |
Properties of the Topic. |
| TopicRegenerateKeyRequest |
Topic regenerate share access key request |
| TopicsConfiguration |
Properties of the Topics Configuration. |
| TopicSharedAccessKeys |
Shared access keys of the Topic |
| TopicsListResult |
Result of the List Topics operation |
| TopicSpace |
The Topic space resource. |
| TopicSpaceProperties |
The properties of topic space. |
| TopicSpacesConfiguration |
Properties of the Topic Spaces Configuration. |
| TopicSpacesListResult |
Result of the List Topic Space operation. |
| TopicTypeInfo |
Properties of a topic type info. |
| TopicTypeProperties |
Properties of a topic type. |
| TopicTypesListResult |
Result of the List Topic Types operation |
| TopicUpdateParameterProperties |
Information of topic update parameter properties. |
| TopicUpdateParameters |
Properties of the Topic update |
| TopicUpdateParametersTags |
Tags of the Topic resource. |
| TrackedResource |
Definition of a Tracked Resource. |
| TrackedResourceTags |
Tags of the resource. |
| UpdateTopicSpacesConfigurationInfo |
Properties of the topic spaces configuration info of a namespace. |
| UserIdentityProperties |
The information about the user identity. |
| VerifiedPartner |
Verified partner information |
| VerifiedPartnerProperties |
Properties of the verified partner. |
| VerifiedPartnersListResult |
Result of the List verified partners operation |
| WebHookEventSubscriptionDestination |
Information about the webhook destination for an event subscription. |
| WebHookEventSubscriptionDestinationProperties |
Information about the webhook destination properties for an event subscription. |
| WebhookPartnerDestinationInfo |
Information about the WebHook of the partner destination. |
| WebhookPartnerDestinationProperties |
Properties of a partner destination webhook. |
| WebhookUpdatePartnerDestinationInfo |
Information about the update of the WebHook of the partner destination. |