Microsoft.EventGrid (preview:2024-12-15)

2024/12/03 • 180 new methods

CaCertificates_Get (new)
Description :  Get properties of a CA certificate.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/caCertificates/{caCertificateName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
caCertificateName:
{
Description: Name of the CA certificate. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of CA certificate. ,
Required: False ,
}
{
description:
{
Description: Description for the CA Certificate resource. ,
Required: False ,
}
string ,
encodedCertificate:
{
Description: Base64 encoded PEM (Privacy Enhanced Mail) format certificate data. ,
Required: False ,
}
string ,
issueTimeInUtc:
{
Description: Certificate issue time in UTC. This is a read-only field. ,
Format: date-time ,
Required: False ,
}
string ,
expiryTimeInUtc:
{
Description: Certificate expiry time in UTC. This is a read-only field. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the CA Certificate resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CaCertificates_CreateOrUpdate (new)
Description :  Create or update a CA certificate with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/caCertificates/{caCertificateName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
caCertificateName:
{
Description: The CA certificate name. ,
Required: True ,
}
string ,
caCertificateInfo:
{
Description: CA certificate information. ,
Required: True ,
}
{
properties:
{
Description: The properties of CA certificate. ,
Required: False ,
}
{
description:
{
Description: Description for the CA Certificate resource. ,
Required: False ,
}
string ,
encodedCertificate:
{
Description: Base64 encoded PEM (Privacy Enhanced Mail) format certificate data. ,
Required: False ,
}
string ,
issueTimeInUtc:
{
Description: Certificate issue time in UTC. This is a read-only field. ,
Format: date-time ,
Required: False ,
}
string ,
expiryTimeInUtc:
{
Description: Certificate expiry time in UTC. This is a read-only field. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the CA Certificate resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of CA certificate. ,
Required: False ,
}
{
description:
{
Description: Description for the CA Certificate resource. ,
Required: False ,
}
string ,
encodedCertificate:
{
Description: Base64 encoded PEM (Privacy Enhanced Mail) format certificate data. ,
Required: False ,
}
string ,
issueTimeInUtc:
{
Description: Certificate issue time in UTC. This is a read-only field. ,
Format: date-time ,
Required: False ,
}
string ,
expiryTimeInUtc:
{
Description: Certificate expiry time in UTC. This is a read-only field. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the CA Certificate resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of CA certificate. ,
Required: False ,
}
{
description:
{
Description: Description for the CA Certificate resource. ,
Required: False ,
}
string ,
encodedCertificate:
{
Description: Base64 encoded PEM (Privacy Enhanced Mail) format certificate data. ,
Required: False ,
}
string ,
issueTimeInUtc:
{
Description: Certificate issue time in UTC. This is a read-only field. ,
Format: date-time ,
Required: False ,
}
string ,
expiryTimeInUtc:
{
Description: Certificate expiry time in UTC. This is a read-only field. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the CA Certificate resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CaCertificates_Delete (new)
Description :  Delete an existing CA certificate.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/caCertificates/{caCertificateName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
caCertificateName:
{
Description: Name of the CA certificate. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CaCertificates_ListByNamespace (new)
Description :  Get all the CA certificates under a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/caCertificates
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of CA Certificate. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of CA certificate. ,
Required: False ,
}
{
description:
{
Description: Description for the CA Certificate resource. ,
Required: False ,
}
string ,
encodedCertificate:
{
Description: Base64 encoded PEM (Privacy Enhanced Mail) format certificate data. ,
Required: False ,
}
string ,
issueTimeInUtc:
{
Description: Certificate issue time in UTC. This is a read-only field. ,
Format: date-time ,
Required: False ,
}
string ,
expiryTimeInUtc:
{
Description: Certificate expiry time in UTC. This is a read-only field. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the CA Certificate resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of CA Certificate. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Channels_Get (new)
Description :  Get properties of a channel.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the partners subscription. ,
Required: True ,
}
string ,
partnerNamespaceName:
{
Description: Name of the partner namespace. ,
Required: True ,
}
string ,
channelName:
{
Description: Name of the channel. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Channel. ,
Required: False ,
}
{
channelType:
{
Description: The type of the event channel which represents the direction flow of events. ,
Enum:
{
PartnerTopic: No description available. ,
PartnerDestination: No description available. ,
}
,
Required: False ,
}
enum ,
partnerTopicInfo:
{
Description: This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel. ,
Required: False ,
}
{
azureSubscriptionId:
{
Description: Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group. ,
Required: False ,
}
string ,
name:
{
Description: Name of the partner topic associated with the channel. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
source:
{
Description: The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic. ,
Required: False ,
}
string ,
}
,
partnerDestinationInfo:
{
Description: This property should be populated when channelType is PartnerDestination and represents information about the partner destination resource corresponding to the channel. ,
Required: False ,
}
{
azureSubscriptionId:
{
Description: Azure subscription ID of the subscriber. The partner destination associated with the channel will be created under this Azure subscription. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group of the subscriber. The partner destination associated with the channel will be created under this resource group. ,
Required: False ,
}
string ,
name:
{
Description: Name of the partner destination associated with the channel. ,
Required: False ,
}
string ,
endpointType:
{
Description: Type of the endpoint for the partner destination ,
Enum:
{
WebHook: No description available. ,
}
,
Required: True ,
}
enum ,
endpointServiceContext:
{
Description: Additional context of the partner destination endpoint. ,
Required: False ,
}
string ,
resourceMoveChangeHistory:
{
Description: Change history of the resource move. ,
Required: False ,
}
[
{
azureSubscriptionId:
{
Description: Azure subscription ID of the resource. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group of the resource. ,
Required: False ,
}
string ,
changedTimeUtc:
{
Description: UTC timestamp of when the resource was changed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process by the subscriber. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the channel. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredPartnerTopicDeletion: No description available. ,
IdleDueToMirroredPartnerDestinationDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
readinessState:
{
Description: The readiness state of the corresponding partner topic. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
}
,
Required: False ,
}
enum ,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, the channel and corresponding partner topic are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
Channels_CreateOrUpdate (new)
Description :  Synchronously creates or updates a new channel with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the partners subscription. ,
Required: True ,
}
string ,
partnerNamespaceName:
{
Description: Name of the partner namespace. ,
Required: True ,
}
string ,
channelName:
{
Description: Name of the channel. ,
Required: True ,
}
string ,
channelInfo:
{
Description: Channel information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Channel. ,
Required: False ,
}
{
channelType:
{
Description: The type of the event channel which represents the direction flow of events. ,
Enum:
{
PartnerTopic: No description available. ,
PartnerDestination: No description available. ,
}
,
Required: False ,
}
enum ,
partnerTopicInfo:
{
Description: This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel. ,
Required: False ,
}
{
azureSubscriptionId:
{
Description: Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group. ,
Required: False ,
}
string ,
name:
{
Description: Name of the partner topic associated with the channel. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
source:
{
Description: The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic. ,
Required: False ,
}
string ,
}
,
partnerDestinationInfo:
{
Description: This property should be populated when channelType is PartnerDestination and represents information about the partner destination resource corresponding to the channel. ,
Required: False ,
}
{
azureSubscriptionId:
{
Description: Azure subscription ID of the subscriber. The partner destination associated with the channel will be created under this Azure subscription. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group of the subscriber. The partner destination associated with the channel will be created under this resource group. ,
Required: False ,
}
string ,
name:
{
Description: Name of the partner destination associated with the channel. ,
Required: False ,
}
string ,
endpointType:
{
Description: Type of the endpoint for the partner destination ,
Enum:
{
WebHook: No description available. ,
}
,
Required: True ,
}
enum ,
endpointServiceContext:
{
Description: Additional context of the partner destination endpoint. ,
Required: False ,
}
string ,
resourceMoveChangeHistory:
{
Description: Change history of the resource move. ,
Required: False ,
}
[
{
azureSubscriptionId:
{
Description: Azure subscription ID of the resource. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group of the resource. ,
Required: False ,
}
string ,
changedTimeUtc:
{
Description: UTC timestamp of when the resource was changed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process by the subscriber. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the channel. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredPartnerTopicDeletion: No description available. ,
IdleDueToMirroredPartnerDestinationDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
readinessState:
{
Description: The readiness state of the corresponding partner topic. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
}
,
Required: False ,
}
enum ,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, the channel and corresponding partner topic are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Channel. ,
Required: False ,
}
{
channelType:
{
Description: The type of the event channel which represents the direction flow of events. ,
Enum:
{
PartnerTopic: No description available. ,
PartnerDestination: No description available. ,
}
,
Required: False ,
}
enum ,
partnerTopicInfo:
{
Description: This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel. ,
Required: False ,
}
{
azureSubscriptionId:
{
Description: Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group. ,
Required: False ,
}
string ,
name:
{
Description: Name of the partner topic associated with the channel. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
source:
{
Description: The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic. ,
Required: False ,
}
string ,
}
,
partnerDestinationInfo:
{
Description: This property should be populated when channelType is PartnerDestination and represents information about the partner destination resource corresponding to the channel. ,
Required: False ,
}
{
azureSubscriptionId:
{
Description: Azure subscription ID of the subscriber. The partner destination associated with the channel will be created under this Azure subscription. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group of the subscriber. The partner destination associated with the channel will be created under this resource group. ,
Required: False ,
}
string ,
name:
{
Description: Name of the partner destination associated with the channel. ,
Required: False ,
}
string ,
endpointType:
{
Description: Type of the endpoint for the partner destination ,
Enum:
{
WebHook: No description available. ,
}
,
Required: True ,
}
enum ,
endpointServiceContext:
{
Description: Additional context of the partner destination endpoint. ,
Required: False ,
}
string ,
resourceMoveChangeHistory:
{
Description: Change history of the resource move. ,
Required: False ,
}
[
{
azureSubscriptionId:
{
Description: Azure subscription ID of the resource. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group of the resource. ,
Required: False ,
}
string ,
changedTimeUtc:
{
Description: UTC timestamp of when the resource was changed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process by the subscriber. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the channel. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredPartnerTopicDeletion: No description available. ,
IdleDueToMirroredPartnerDestinationDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
readinessState:
{
Description: The readiness state of the corresponding partner topic. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
}
,
Required: False ,
}
enum ,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, the channel and corresponding partner topic are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Channel. ,
Required: False ,
}
{
channelType:
{
Description: The type of the event channel which represents the direction flow of events. ,
Enum:
{
PartnerTopic: No description available. ,
PartnerDestination: No description available. ,
}
,
Required: False ,
}
enum ,
partnerTopicInfo:
{
Description: This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel. ,
Required: False ,
}
{
azureSubscriptionId:
{
Description: Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group. ,
Required: False ,
}
string ,
name:
{
Description: Name of the partner topic associated with the channel. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
source:
{
Description: The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic. ,
Required: False ,
}
string ,
}
,
partnerDestinationInfo:
{
Description: This property should be populated when channelType is PartnerDestination and represents information about the partner destination resource corresponding to the channel. ,
Required: False ,
}
{
azureSubscriptionId:
{
Description: Azure subscription ID of the subscriber. The partner destination associated with the channel will be created under this Azure subscription. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group of the subscriber. The partner destination associated with the channel will be created under this resource group. ,
Required: False ,
}
string ,
name:
{
Description: Name of the partner destination associated with the channel. ,
Required: False ,
}
string ,
endpointType:
{
Description: Type of the endpoint for the partner destination ,
Enum:
{
WebHook: No description available. ,
}
,
Required: True ,
}
enum ,
endpointServiceContext:
{
Description: Additional context of the partner destination endpoint. ,
Required: False ,
}
string ,
resourceMoveChangeHistory:
{
Description: Change history of the resource move. ,
Required: False ,
}
[
{
azureSubscriptionId:
{
Description: Azure subscription ID of the resource. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group of the resource. ,
Required: False ,
}
string ,
changedTimeUtc:
{
Description: UTC timestamp of when the resource was changed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process by the subscriber. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the channel. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredPartnerTopicDeletion: No description available. ,
IdleDueToMirroredPartnerDestinationDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
readinessState:
{
Description: The readiness state of the corresponding partner topic. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
}
,
Required: False ,
}
enum ,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, the channel and corresponding partner topic are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
Channels_Delete (new)
Description :  Delete an existing channel.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the partners subscription. ,
Required: True ,
}
string ,
partnerNamespaceName:
{
Description: Name of the partner namespace. ,
Required: True ,
}
string ,
channelName:
{
Description: Name of the channel. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{}
Channels_Update (new)
Description :  Synchronously updates a channel with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the partners subscription. ,
Required: True ,
}
string ,
partnerNamespaceName:
{
Description: Name of the partner namespace. ,
Required: True ,
}
string ,
channelName:
{
Description: Name of the channel. ,
Required: True ,
}
string ,
channelUpdateParameters:
{
Description: Channel update information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the channel update parameters. ,
Required: False ,
}
{
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the channel. If this timer expires while the corresponding partner topic or partner destination is never activated, the channel and corresponding partner topic or partner destination are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
partnerDestinationInfo:
{
Description: Partner destination properties which can be updated if the channel is of type PartnerDestination. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the partner destination ,
Enum:
{
WebHook: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
partnerTopicInfo:
{
Description: Partner topic properties which can be updated if the channel is of type PartnerTopic. ,
Required: False ,
}
{
eventTypeInfo:
{
Description: Event type info for the partner topic ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}
Channels_ListByPartnerNamespace (new)
Description :  List all the channels in a partner namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the partners subscription. ,
Required: True ,
}
string ,
partnerNamespaceName:
{
Description: Name of the partner namespace. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of Channels. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Channel. ,
Required: False ,
}
{
channelType:
{
Description: The type of the event channel which represents the direction flow of events. ,
Enum:
{
PartnerTopic: No description available. ,
PartnerDestination: No description available. ,
}
,
Required: False ,
}
enum ,
partnerTopicInfo:
{
Description: This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel. ,
Required: False ,
}
{
azureSubscriptionId:
{
Description: Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group. ,
Required: False ,
}
string ,
name:
{
Description: Name of the partner topic associated with the channel. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
source:
{
Description: The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic. ,
Required: False ,
}
string ,
}
,
partnerDestinationInfo:
{
Description: This property should be populated when channelType is PartnerDestination and represents information about the partner destination resource corresponding to the channel. ,
Required: False ,
}
{
azureSubscriptionId:
{
Description: Azure subscription ID of the subscriber. The partner destination associated with the channel will be created under this Azure subscription. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group of the subscriber. The partner destination associated with the channel will be created under this resource group. ,
Required: False ,
}
string ,
name:
{
Description: Name of the partner destination associated with the channel. ,
Required: False ,
}
string ,
endpointType:
{
Description: Type of the endpoint for the partner destination ,
Enum:
{
WebHook: No description available. ,
}
,
Required: True ,
}
enum ,
endpointServiceContext:
{
Description: Additional context of the partner destination endpoint. ,
Required: False ,
}
string ,
resourceMoveChangeHistory:
{
Description: Change history of the resource move. ,
Required: False ,
}
[
{
azureSubscriptionId:
{
Description: Azure subscription ID of the resource. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group of the resource. ,
Required: False ,
}
string ,
changedTimeUtc:
{
Description: UTC timestamp of when the resource was changed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process by the subscriber. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the channel. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredPartnerTopicDeletion: No description available. ,
IdleDueToMirroredPartnerDestinationDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
readinessState:
{
Description: The readiness state of the corresponding partner topic. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
}
,
Required: False ,
}
enum ,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, the channel and corresponding partner topic are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of channels. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
Channels_GetFullUrl (new)
Description :  Get the full endpoint URL of a partner destination channel.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}/getFullUrl
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the partners subscription. ,
Required: True ,
}
string ,
partnerNamespaceName:
{
Description: Name of the partner namespace. ,
Required: True ,
}
string ,
channelName:
{
Description: Name of the Channel. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endpointUrl:
{
Description: The URL that represents the endpoint of the destination of an event subscription. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
ClientGroups_Get (new)
Description :  Get properties of a client group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clientGroups/{clientGroupName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
clientGroupName:
{
Description: Name of the client group. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of client group. ,
Required: False ,
}
{
description:
{
Description: Description for the Client Group resource. ,
Required: False ,
}
string ,
query:
{
Description: The grouping query for the clients. Example : attributes.keyName IN ['a', 'b', 'c']. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the ClientGroup resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClientGroups_CreateOrUpdate (new)
Description :  Create or update a client group with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clientGroups/{clientGroupName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
clientGroupName:
{
Description: The client group name. ,
Required: True ,
}
string ,
clientGroupInfo:
{
Description: Client group information. ,
Required: True ,
}
{
properties:
{
Description: The properties of client group. ,
Required: False ,
}
{
description:
{
Description: Description for the Client Group resource. ,
Required: False ,
}
string ,
query:
{
Description: The grouping query for the clients. Example : attributes.keyName IN ['a', 'b', 'c']. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the ClientGroup resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of client group. ,
Required: False ,
}
{
description:
{
Description: Description for the Client Group resource. ,
Required: False ,
}
string ,
query:
{
Description: The grouping query for the clients. Example : attributes.keyName IN ['a', 'b', 'c']. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the ClientGroup resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of client group. ,
Required: False ,
}
{
description:
{
Description: Description for the Client Group resource. ,
Required: False ,
}
string ,
query:
{
Description: The grouping query for the clients. Example : attributes.keyName IN ['a', 'b', 'c']. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the ClientGroup resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClientGroups_Delete (new)
Description :  Delete an existing client group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clientGroups/{clientGroupName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
clientGroupName:
{
Description: Name of the client group. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClientGroups_ListByNamespace (new)
Description :  Get all the client groups under a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clientGroups
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of Client Group. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of client group. ,
Required: False ,
}
{
description:
{
Description: Description for the Client Group resource. ,
Required: False ,
}
string ,
query:
{
Description: The grouping query for the clients. Example : attributes.keyName IN ['a', 'b', 'c']. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the ClientGroup resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of Client Group. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clients_Get (new)
Description :  Get properties of a client.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clients/{clientName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
clientName:
{
Description: Name of the client. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of client. ,
Required: False ,
}
{
description:
{
Description: Description for the Client resource. ,
Required: False ,
}
string ,
authenticationName:
{
Description: The name presented by the client for authentication. The default value is the name of the resource. ,
Required: False ,
}
string ,
clientCertificateAuthentication:
{
Description: The client certificate authentication information. ,
Required: False ,
}
{
validationScheme:
{
Description: The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName. ,
Enum:
{
SubjectMatchesAuthenticationName: No description available. ,
DnsMatchesAuthenticationName: No description available. ,
UriMatchesAuthenticationName: No description available. ,
IpMatchesAuthenticationName: No description available. ,
EmailMatchesAuthenticationName: No description available. ,
ThumbprintMatch: No description available. ,
}
,
Required: False ,
}
enum ,
allowedThumbprints:
{
Description: The list of thumbprints that are allowed during client authentication. This property is required only if the validationScheme is 'ThumbprintMatch'. ,
Required: False ,
}
[
string ,
]
,
}
,
state:
{
Description: Indicates if the client is enabled or not. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Attributes for the client. Supported values are int, bool, string, string[]. Example: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] } ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state of the Client resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clients_CreateOrUpdate (new)
Description :  Create or update a client with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clients/{clientName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
clientName:
{
Description: The client name. ,
Required: True ,
}
string ,
clientInfo:
{
Description: Client information. ,
Required: True ,
}
{
properties:
{
Description: The properties of client. ,
Required: False ,
}
{
description:
{
Description: Description for the Client resource. ,
Required: False ,
}
string ,
authenticationName:
{
Description: The name presented by the client for authentication. The default value is the name of the resource. ,
Required: False ,
}
string ,
clientCertificateAuthentication:
{
Description: The client certificate authentication information. ,
Required: False ,
}
{
validationScheme:
{
Description: The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName. ,
Enum:
{
SubjectMatchesAuthenticationName: No description available. ,
DnsMatchesAuthenticationName: No description available. ,
UriMatchesAuthenticationName: No description available. ,
IpMatchesAuthenticationName: No description available. ,
EmailMatchesAuthenticationName: No description available. ,
ThumbprintMatch: No description available. ,
}
,
Required: False ,
}
enum ,
allowedThumbprints:
{
Description: The list of thumbprints that are allowed during client authentication. This property is required only if the validationScheme is 'ThumbprintMatch'. ,
Required: False ,
}
[
string ,
]
,
}
,
state:
{
Description: Indicates if the client is enabled or not. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Attributes for the client. Supported values are int, bool, string, string[]. Example: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] } ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state of the Client resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of client. ,
Required: False ,
}
{
description:
{
Description: Description for the Client resource. ,
Required: False ,
}
string ,
authenticationName:
{
Description: The name presented by the client for authentication. The default value is the name of the resource. ,
Required: False ,
}
string ,
clientCertificateAuthentication:
{
Description: The client certificate authentication information. ,
Required: False ,
}
{
validationScheme:
{
Description: The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName. ,
Enum:
{
SubjectMatchesAuthenticationName: No description available. ,
DnsMatchesAuthenticationName: No description available. ,
UriMatchesAuthenticationName: No description available. ,
IpMatchesAuthenticationName: No description available. ,
EmailMatchesAuthenticationName: No description available. ,
ThumbprintMatch: No description available. ,
}
,
Required: False ,
}
enum ,
allowedThumbprints:
{
Description: The list of thumbprints that are allowed during client authentication. This property is required only if the validationScheme is 'ThumbprintMatch'. ,
Required: False ,
}
[
string ,
]
,
}
,
state:
{
Description: Indicates if the client is enabled or not. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Attributes for the client. Supported values are int, bool, string, string[]. Example: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] } ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state of the Client resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of client. ,
Required: False ,
}
{
description:
{
Description: Description for the Client resource. ,
Required: False ,
}
string ,
authenticationName:
{
Description: The name presented by the client for authentication. The default value is the name of the resource. ,
Required: False ,
}
string ,
clientCertificateAuthentication:
{
Description: The client certificate authentication information. ,
Required: False ,
}
{
validationScheme:
{
Description: The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName. ,
Enum:
{
SubjectMatchesAuthenticationName: No description available. ,
DnsMatchesAuthenticationName: No description available. ,
UriMatchesAuthenticationName: No description available. ,
IpMatchesAuthenticationName: No description available. ,
EmailMatchesAuthenticationName: No description available. ,
ThumbprintMatch: No description available. ,
}
,
Required: False ,
}
enum ,
allowedThumbprints:
{
Description: The list of thumbprints that are allowed during client authentication. This property is required only if the validationScheme is 'ThumbprintMatch'. ,
Required: False ,
}
[
string ,
]
,
}
,
state:
{
Description: Indicates if the client is enabled or not. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Attributes for the client. Supported values are int, bool, string, string[]. Example: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] } ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state of the Client resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clients_Delete (new)
Description :  Delete an existing client.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clients/{clientName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
clientName:
{
Description: Name of the client. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clients_ListByNamespace (new)
Description :  Get all the permission bindings under a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clients
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of Client. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of client. ,
Required: False ,
}
{
description:
{
Description: Description for the Client resource. ,
Required: False ,
}
string ,
authenticationName:
{
Description: The name presented by the client for authentication. The default value is the name of the resource. ,
Required: False ,
}
string ,
clientCertificateAuthentication:
{
Description: The client certificate authentication information. ,
Required: False ,
}
{
validationScheme:
{
Description: The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName. ,
Enum:
{
SubjectMatchesAuthenticationName: No description available. ,
DnsMatchesAuthenticationName: No description available. ,
UriMatchesAuthenticationName: No description available. ,
IpMatchesAuthenticationName: No description available. ,
EmailMatchesAuthenticationName: No description available. ,
ThumbprintMatch: No description available. ,
}
,
Required: False ,
}
enum ,
allowedThumbprints:
{
Description: The list of thumbprints that are allowed during client authentication. This property is required only if the validationScheme is 'ThumbprintMatch'. ,
Required: False ,
}
[
string ,
]
,
}
,
state:
{
Description: Indicates if the client is enabled or not. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Attributes for the client. Supported values are int, bool, string, string[]. Example: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] } ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state of the Client resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of Client. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Domains_Get (new)
Description :  Get properties of a domain.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Event Grid Domain resource. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the Event Grid Domain Resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this domain ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint for the Event Grid Domain Resource which is used for publishing the events. ,
Required: False ,
}
string ,
inputSchema:
{
Description: This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. ,
Enum:
{
EventGridSchema: No description available. ,
CustomEventSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
eventTypeInfo:
{
Description: Event Type Information for the domain. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
inputSchemaMapping:
{
Description: Information about the InputSchemaMapping which specified the info about mapping event payload. ,
Required: False ,
}
{
inputSchemaMappingType:
{
Description: Type of the custom mapping ,
Enum:
{
Json: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
metricResourceId:
{
Description: Metric resource id for the Event Grid Domain Resource. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain. ,
Required: False ,
}
boolean ,
autoCreateTopicWithFirstSubscription:
{
Description: This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed. ,
Required: False ,
}
boolean ,
autoDeleteTopicWithLastSubscription:
{
Description: This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. ,
Required: False ,
}
boolean ,
dataResidencyBoundary:
{
Description: Data Residency Boundary of the resource. ,
Enum:
{
WithinGeopair: No description available. ,
WithinRegion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The Sku pricing tier for the Event Grid Domain resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name of the resource. The possible values are: Basic or Premium. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity information for the Event Grid Domain resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
Domains_CreateOrUpdate (new)
Description :  Asynchronously creates or updates a new domain with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
domainInfo:
{
Description: Domain information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Event Grid Domain resource. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the Event Grid Domain Resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this domain ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint for the Event Grid Domain Resource which is used for publishing the events. ,
Required: False ,
}
string ,
inputSchema:
{
Description: This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. ,
Enum:
{
EventGridSchema: No description available. ,
CustomEventSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
eventTypeInfo:
{
Description: Event Type Information for the domain. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
inputSchemaMapping:
{
Description: Information about the InputSchemaMapping which specified the info about mapping event payload. ,
Required: False ,
}
{
inputSchemaMappingType:
{
Description: Type of the custom mapping ,
Enum:
{
Json: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
metricResourceId:
{
Description: Metric resource id for the Event Grid Domain Resource. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain. ,
Required: False ,
}
boolean ,
autoCreateTopicWithFirstSubscription:
{
Description: This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed. ,
Required: False ,
}
boolean ,
autoDeleteTopicWithLastSubscription:
{
Description: This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. ,
Required: False ,
}
boolean ,
dataResidencyBoundary:
{
Description: Data Residency Boundary of the resource. ,
Enum:
{
WithinGeopair: No description available. ,
WithinRegion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The Sku pricing tier for the Event Grid Domain resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name of the resource. The possible values are: Basic or Premium. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity information for the Event Grid Domain resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Event Grid Domain resource. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the Event Grid Domain Resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this domain ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint for the Event Grid Domain Resource which is used for publishing the events. ,
Required: False ,
}
string ,
inputSchema:
{
Description: This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. ,
Enum:
{
EventGridSchema: No description available. ,
CustomEventSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
eventTypeInfo:
{
Description: Event Type Information for the domain. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
inputSchemaMapping:
{
Description: Information about the InputSchemaMapping which specified the info about mapping event payload. ,
Required: False ,
}
{
inputSchemaMappingType:
{
Description: Type of the custom mapping ,
Enum:
{
Json: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
metricResourceId:
{
Description: Metric resource id for the Event Grid Domain Resource. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain. ,
Required: False ,
}
boolean ,
autoCreateTopicWithFirstSubscription:
{
Description: This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed. ,
Required: False ,
}
boolean ,
autoDeleteTopicWithLastSubscription:
{
Description: This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. ,
Required: False ,
}
boolean ,
dataResidencyBoundary:
{
Description: Data Residency Boundary of the resource. ,
Enum:
{
WithinGeopair: No description available. ,
WithinRegion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The Sku pricing tier for the Event Grid Domain resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name of the resource. The possible values are: Basic or Premium. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity information for the Event Grid Domain resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
Domains_Delete (new)
Description :  Delete existing domain.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{}
Domains_Update (new)
Description :  Asynchronously updates a domain with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
domainUpdateParameters:
{
Description: Domain update information. ,
Required: True ,
}
{
tags:
{
Description: Tags of the domains resource. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this domain ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain. ,
Required: False ,
}
boolean ,
autoCreateTopicWithFirstSubscription:
{
Description: This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed. ,
Required: False ,
}
boolean ,
autoDeleteTopicWithLastSubscription:
{
Description: This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. ,
Required: False ,
}
boolean ,
dataResidencyBoundary:
{
Description: The data residency boundary for the domain. ,
Enum:
{
WithinGeopair: No description available. ,
WithinRegion: No description available. ,
}
,
Required: False ,
}
enum ,
eventTypeInfo:
{
Description: The eventTypeInfo for the domain. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
identity:
{
Description: Identity information for the resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The Sku pricing tier for the domain. ,
Required: False ,
}
{
name:
{
Description: The Sku name of the resource. The possible values are: Basic or Premium. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (201)

{
properties:
{
Description: Properties of the Event Grid Domain resource. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the Event Grid Domain Resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this domain ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint for the Event Grid Domain Resource which is used for publishing the events. ,
Required: False ,
}
string ,
inputSchema:
{
Description: This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. ,
Enum:
{
EventGridSchema: No description available. ,
CustomEventSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
eventTypeInfo:
{
Description: Event Type Information for the domain. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
inputSchemaMapping:
{
Description: Information about the InputSchemaMapping which specified the info about mapping event payload. ,
Required: False ,
}
{
inputSchemaMappingType:
{
Description: Type of the custom mapping ,
Enum:
{
Json: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
metricResourceId:
{
Description: Metric resource id for the Event Grid Domain Resource. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain. ,
Required: False ,
}
boolean ,
autoCreateTopicWithFirstSubscription:
{
Description: This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed. ,
Required: False ,
}
boolean ,
autoDeleteTopicWithLastSubscription:
{
Description: This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. ,
Required: False ,
}
boolean ,
dataResidencyBoundary:
{
Description: Data Residency Boundary of the resource. ,
Enum:
{
WithinGeopair: No description available. ,
WithinRegion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The Sku pricing tier for the Event Grid Domain resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name of the resource. The possible values are: Basic or Premium. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity information for the Event Grid Domain resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
Domains_ListBySubscription (new)
Description :  List all the domains under an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/domains
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of Domains. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Event Grid Domain resource. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the Event Grid Domain Resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this domain ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint for the Event Grid Domain Resource which is used for publishing the events. ,
Required: False ,
}
string ,
inputSchema:
{
Description: This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. ,
Enum:
{
EventGridSchema: No description available. ,
CustomEventSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
eventTypeInfo:
{
Description: Event Type Information for the domain. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
inputSchemaMapping:
{
Description: Information about the InputSchemaMapping which specified the info about mapping event payload. ,
Required: False ,
}
{
inputSchemaMappingType:
{
Description: Type of the custom mapping ,
Enum:
{
Json: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
metricResourceId:
{
Description: Metric resource id for the Event Grid Domain Resource. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain. ,
Required: False ,
}
boolean ,
autoCreateTopicWithFirstSubscription:
{
Description: This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed. ,
Required: False ,
}
boolean ,
autoDeleteTopicWithLastSubscription:
{
Description: This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. ,
Required: False ,
}
boolean ,
dataResidencyBoundary:
{
Description: Data Residency Boundary of the resource. ,
Enum:
{
WithinGeopair: No description available. ,
WithinRegion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The Sku pricing tier for the Event Grid Domain resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name of the resource. The possible values are: Basic or Premium. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity information for the Event Grid Domain resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of domains. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
Domains_ListByResourceGroup (new)
Description :  List all the domains under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of Domains. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Event Grid Domain resource. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the Event Grid Domain Resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this domain ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint for the Event Grid Domain Resource which is used for publishing the events. ,
Required: False ,
}
string ,
inputSchema:
{
Description: This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. ,
Enum:
{
EventGridSchema: No description available. ,
CustomEventSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
eventTypeInfo:
{
Description: Event Type Information for the domain. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
inputSchemaMapping:
{
Description: Information about the InputSchemaMapping which specified the info about mapping event payload. ,
Required: False ,
}
{
inputSchemaMappingType:
{
Description: Type of the custom mapping ,
Enum:
{
Json: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
metricResourceId:
{
Description: Metric resource id for the Event Grid Domain Resource. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain. ,
Required: False ,
}
boolean ,
autoCreateTopicWithFirstSubscription:
{
Description: This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed. ,
Required: False ,
}
boolean ,
autoDeleteTopicWithLastSubscription:
{
Description: This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. ,
Required: False ,
}
boolean ,
dataResidencyBoundary:
{
Description: Data Residency Boundary of the resource. ,
Enum:
{
WithinGeopair: No description available. ,
WithinRegion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The Sku pricing tier for the Event Grid Domain resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name of the resource. The possible values are: Basic or Premium. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity information for the Event Grid Domain resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of domains. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
Domains_ListSharedAccessKeys (new)
Description :  List the two keys used to publish to a domain.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/listKeys
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
key1:
{
Description: Shared access key1 for the domain. ,
Required: False ,
}
string ,
key2:
{
Description: Shared access key2 for the domain. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
Domains_RegenerateKey (new)
Description :  Regenerate a shared access key for a domain.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/regenerateKey
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
regenerateKeyRequest:
{
Description: Request body to regenerate key. ,
Required: True ,
}
{
keyName:
{
Description: Key name to regenerate key1 or key2. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
key1:
{
Description: Shared access key1 for the domain. ,
Required: False ,
}
string ,
key2:
{
Description: Shared access key2 for the domain. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
DomainTopics_Get (new)
Description :  Get properties of a domain topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
domainTopicName:
{
Description: Name of the topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Domain Topic. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the domain topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
DomainTopics_CreateOrUpdate (new)
Description :  Asynchronously creates or updates a new domain topic with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
domainTopicName:
{
Description: Name of the domain topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Domain Topic. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the domain topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
DomainTopics_Delete (new)
Description :  Delete existing domain topic.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
domainTopicName:
{
Description: Name of the domain topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{}
DomainTopics_ListByDomain (new)
Description :  List all the topics in a domain.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Domain name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of Domain Topics. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Domain Topic. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the domain topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of domain topics. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
DomainTopicEventSubscriptions_GetDeliveryAttributes (new)
Description :  Get all delivery attributes for an event subscription for domain topic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}/getDeliveryAttributes
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the top level domain. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the domain topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of DeliveryAttributeMapping ,
Required: False ,
}
[
{
name:
{
Description: Name of the delivery attribute or header. ,
Required: False ,
}
string ,
type:
{
Description: Type of the delivery attribute or header name. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{}
TopicEventSubscriptions_GetDeliveryAttributes (new)
Description :  Get all delivery attributes for an event subscription for topic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}/getDeliveryAttributes
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of DeliveryAttributeMapping ,
Required: False ,
}
[
{
name:
{
Description: Name of the delivery attribute or header. ,
Required: False ,
}
string ,
type:
{
Description: Type of the delivery attribute or header name. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{}
DomainEventSubscriptions_GetDeliveryAttributes (new)
Description :  Get all delivery attributes for an event subscription for domain.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}/getDeliveryAttributes
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of DeliveryAttributeMapping ,
Required: False ,
}
[
{
name:
{
Description: Name of the delivery attribute or header. ,
Required: False ,
}
string ,
type:
{
Description: Type of the delivery attribute or header name. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{}
EventSubscriptions_GetDeliveryAttributes (new)
Description :  Get all delivery attributes for an event subscription.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}/getDeliveryAttributes
{
scope:
{
Description: The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of DeliveryAttributeMapping ,
Required: False ,
}
[
{
name:
{
Description: Name of the delivery attribute or header. ,
Required: False ,
}
string ,
type:
{
Description: Type of the delivery attribute or header name. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{}
SystemTopicEventSubscriptions_GetDeliveryAttributes (new)
Description :  Get all delivery attributes for an event subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}/getDeliveryAttributes
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
systemTopicName:
{
Description: Name of the system topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of DeliveryAttributeMapping ,
Required: False ,
}
[
{
name:
{
Description: Name of the delivery attribute or header. ,
Required: False ,
}
string ,
type:
{
Description: Type of the delivery attribute or header name. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{}
NamespaceTopicEventSubscriptions_Get (new)
Description :  Get properties of an event subscription of a namespace topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the namespace topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be found. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
deliveryConfiguration:
{
Description: Information about the delivery configuration of the event subscription. ,
Required: False ,
}
{
deliveryMode:
{
Description: Delivery mode of the event subscription. ,
Enum:
{
Queue: No description available. ,
Push: No description available. ,
}
,
Required: False ,
}
enum ,
queue:
{
Description: This property should be populated when deliveryMode is queue and represents information about the queue subscription. ,
Required: False ,
}
{
receiveLockDurationInSeconds:
{
Description: Maximum period in seconds in which once the message is in received (by the client) state and waiting to be accepted, released or rejected. If this time elapsed after a message has been received by the client and not transitioned into accepted (not processed), released or rejected, the message is available for redelivery. This is an optional field, where default is 60 seconds, minimum is 60 seconds and maximum is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDeliveryCount:
{
Description: The maximum delivery count of the events. ,
Format: int32 ,
Required: False ,
}
integer ,
deadLetterDestinationWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
eventTimeToLive:
{
Description: Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: - (n) is replaced by the value of each time element that follows the (n). - P is the duration (or Period) designator and is always placed at the beginning of the duration. - Y is the year designator, and it follows the value for the number of years. - M is the month designator, and it follows the value for the number of months. - W is the week designator, and it follows the value for the number of weeks. - D is the day designator, and it follows the value for the number of days. - T is the time designator, and it precedes the time components. - H is the hour designator, and it follows the value for the number of hours. - M is the minute designator, and it follows the value for the number of minutes. - S is the second designator, and it follows the value for the number of seconds. This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined by topic’s EventRetentionInDays value. The followings are examples of valid values: - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day. ,
Format: duration ,
Required: False ,
}
string ,
}
,
push:
{
Description: This property should be populated when deliveryMode is push and represents information about the push subscription. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: The maximum delivery count of the events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLive:
{
Description: Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: - (n) is replaced by the value of each time element that follows the (n). - P is the duration (or Period) designator and is always placed at the beginning of the duration. - Y is the year designator, and it follows the value for the number of years. - M is the month designator, and it follows the value for the number of months. - W is the week designator, and it follows the value for the number of weeks. - D is the day designator, and it follows the value for the number of days. - T is the time designator, and it precedes the time components. - H is the hour designator, and it follows the value for the number of hours. - M is the minute designator, and it follows the value for the number of minutes. - S is the second designator, and it follows the value for the number of seconds. This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined by topic’s EventRetentionInDays value. The followings are examples of valid values: - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day. ,
Required: False ,
}
string ,
deadLetterDestinationWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, namespace) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
filtersConfiguration:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
filters:
{
Description: An array of filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
tags:
{
Description: Tags relating to Event Subscription resource. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceTopicEventSubscriptions_CreateOrUpdate (new)
Description :  Asynchronously creates or updates an event subscription of a namespace topic with the specified parameters. Existing event subscriptions will be updated with this API.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the namespace topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be created. Event subscription names must be between 3 and 50 characters in length and use alphanumeric letters only. ,
Required: True ,
}
string ,
eventSubscriptionInfo:
{
Description: Event subscription properties containing the delivery mode, filter information, and others. ,
Required: True ,
}
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
deliveryConfiguration:
{
Description: Information about the delivery configuration of the event subscription. ,
Required: False ,
}
{
deliveryMode:
{
Description: Delivery mode of the event subscription. ,
Enum:
{
Queue: No description available. ,
Push: No description available. ,
}
,
Required: False ,
}
enum ,
queue:
{
Description: This property should be populated when deliveryMode is queue and represents information about the queue subscription. ,
Required: False ,
}
{
receiveLockDurationInSeconds:
{
Description: Maximum period in seconds in which once the message is in received (by the client) state and waiting to be accepted, released or rejected. If this time elapsed after a message has been received by the client and not transitioned into accepted (not processed), released or rejected, the message is available for redelivery. This is an optional field, where default is 60 seconds, minimum is 60 seconds and maximum is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDeliveryCount:
{
Description: The maximum delivery count of the events. ,
Format: int32 ,
Required: False ,
}
integer ,
deadLetterDestinationWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
eventTimeToLive:
{
Description: Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: - (n) is replaced by the value of each time element that follows the (n). - P is the duration (or Period) designator and is always placed at the beginning of the duration. - Y is the year designator, and it follows the value for the number of years. - M is the month designator, and it follows the value for the number of months. - W is the week designator, and it follows the value for the number of weeks. - D is the day designator, and it follows the value for the number of days. - T is the time designator, and it precedes the time components. - H is the hour designator, and it follows the value for the number of hours. - M is the minute designator, and it follows the value for the number of minutes. - S is the second designator, and it follows the value for the number of seconds. This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined by topic’s EventRetentionInDays value. The followings are examples of valid values: - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day. ,
Format: duration ,
Required: False ,
}
string ,
}
,
push:
{
Description: This property should be populated when deliveryMode is push and represents information about the push subscription. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: The maximum delivery count of the events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLive:
{
Description: Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: - (n) is replaced by the value of each time element that follows the (n). - P is the duration (or Period) designator and is always placed at the beginning of the duration. - Y is the year designator, and it follows the value for the number of years. - M is the month designator, and it follows the value for the number of months. - W is the week designator, and it follows the value for the number of weeks. - D is the day designator, and it follows the value for the number of days. - T is the time designator, and it precedes the time components. - H is the hour designator, and it follows the value for the number of hours. - M is the minute designator, and it follows the value for the number of minutes. - S is the second designator, and it follows the value for the number of seconds. This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined by topic’s EventRetentionInDays value. The followings are examples of valid values: - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day. ,
Required: False ,
}
string ,
deadLetterDestinationWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, namespace) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
filtersConfiguration:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
filters:
{
Description: An array of filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
tags:
{
Description: Tags relating to Event Subscription resource. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
deliveryConfiguration:
{
Description: Information about the delivery configuration of the event subscription. ,
Required: False ,
}
{
deliveryMode:
{
Description: Delivery mode of the event subscription. ,
Enum:
{
Queue: No description available. ,
Push: No description available. ,
}
,
Required: False ,
}
enum ,
queue:
{
Description: This property should be populated when deliveryMode is queue and represents information about the queue subscription. ,
Required: False ,
}
{
receiveLockDurationInSeconds:
{
Description: Maximum period in seconds in which once the message is in received (by the client) state and waiting to be accepted, released or rejected. If this time elapsed after a message has been received by the client and not transitioned into accepted (not processed), released or rejected, the message is available for redelivery. This is an optional field, where default is 60 seconds, minimum is 60 seconds and maximum is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDeliveryCount:
{
Description: The maximum delivery count of the events. ,
Format: int32 ,
Required: False ,
}
integer ,
deadLetterDestinationWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
eventTimeToLive:
{
Description: Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: - (n) is replaced by the value of each time element that follows the (n). - P is the duration (or Period) designator and is always placed at the beginning of the duration. - Y is the year designator, and it follows the value for the number of years. - M is the month designator, and it follows the value for the number of months. - W is the week designator, and it follows the value for the number of weeks. - D is the day designator, and it follows the value for the number of days. - T is the time designator, and it precedes the time components. - H is the hour designator, and it follows the value for the number of hours. - M is the minute designator, and it follows the value for the number of minutes. - S is the second designator, and it follows the value for the number of seconds. This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined by topic’s EventRetentionInDays value. The followings are examples of valid values: - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day. ,
Format: duration ,
Required: False ,
}
string ,
}
,
push:
{
Description: This property should be populated when deliveryMode is push and represents information about the push subscription. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: The maximum delivery count of the events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLive:
{
Description: Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: - (n) is replaced by the value of each time element that follows the (n). - P is the duration (or Period) designator and is always placed at the beginning of the duration. - Y is the year designator, and it follows the value for the number of years. - M is the month designator, and it follows the value for the number of months. - W is the week designator, and it follows the value for the number of weeks. - D is the day designator, and it follows the value for the number of days. - T is the time designator, and it precedes the time components. - H is the hour designator, and it follows the value for the number of hours. - M is the minute designator, and it follows the value for the number of minutes. - S is the second designator, and it follows the value for the number of seconds. This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined by topic’s EventRetentionInDays value. The followings are examples of valid values: - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day. ,
Required: False ,
}
string ,
deadLetterDestinationWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, namespace) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
filtersConfiguration:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
filters:
{
Description: An array of filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
tags:
{
Description: Tags relating to Event Subscription resource. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
deliveryConfiguration:
{
Description: Information about the delivery configuration of the event subscription. ,
Required: False ,
}
{
deliveryMode:
{
Description: Delivery mode of the event subscription. ,
Enum:
{
Queue: No description available. ,
Push: No description available. ,
}
,
Required: False ,
}
enum ,
queue:
{
Description: This property should be populated when deliveryMode is queue and represents information about the queue subscription. ,
Required: False ,
}
{
receiveLockDurationInSeconds:
{
Description: Maximum period in seconds in which once the message is in received (by the client) state and waiting to be accepted, released or rejected. If this time elapsed after a message has been received by the client and not transitioned into accepted (not processed), released or rejected, the message is available for redelivery. This is an optional field, where default is 60 seconds, minimum is 60 seconds and maximum is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDeliveryCount:
{
Description: The maximum delivery count of the events. ,
Format: int32 ,
Required: False ,
}
integer ,
deadLetterDestinationWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
eventTimeToLive:
{
Description: Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: - (n) is replaced by the value of each time element that follows the (n). - P is the duration (or Period) designator and is always placed at the beginning of the duration. - Y is the year designator, and it follows the value for the number of years. - M is the month designator, and it follows the value for the number of months. - W is the week designator, and it follows the value for the number of weeks. - D is the day designator, and it follows the value for the number of days. - T is the time designator, and it precedes the time components. - H is the hour designator, and it follows the value for the number of hours. - M is the minute designator, and it follows the value for the number of minutes. - S is the second designator, and it follows the value for the number of seconds. This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined by topic’s EventRetentionInDays value. The followings are examples of valid values: - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day. ,
Format: duration ,
Required: False ,
}
string ,
}
,
push:
{
Description: This property should be populated when deliveryMode is push and represents information about the push subscription. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: The maximum delivery count of the events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLive:
{
Description: Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: - (n) is replaced by the value of each time element that follows the (n). - P is the duration (or Period) designator and is always placed at the beginning of the duration. - Y is the year designator, and it follows the value for the number of years. - M is the month designator, and it follows the value for the number of months. - W is the week designator, and it follows the value for the number of weeks. - D is the day designator, and it follows the value for the number of days. - T is the time designator, and it precedes the time components. - H is the hour designator, and it follows the value for the number of hours. - M is the minute designator, and it follows the value for the number of minutes. - S is the second designator, and it follows the value for the number of seconds. This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined by topic’s EventRetentionInDays value. The followings are examples of valid values: - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day. ,
Required: False ,
}
string ,
deadLetterDestinationWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, namespace) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
filtersConfiguration:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
filters:
{
Description: An array of filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
tags:
{
Description: Tags relating to Event Subscription resource. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceTopicEventSubscriptions_Delete (new)
Description :  Delete an existing event subscription of a namespace topic.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the namespace topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceTopicEventSubscriptions_Update (new)
Description :  Update an existing event subscription of a namespace topic.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the namespace topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be updated. ,
Required: True ,
}
string ,
eventSubscriptionUpdateParameters:
{
Description: Updated event subscription information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Event Subscription update parameters. ,
Required: False ,
}
{
deliveryConfiguration:
{
Description: Information about the delivery configuration of the event subscription. ,
Required: False ,
}
{
deliveryMode:
{
Description: Delivery mode of the event subscription. ,
Enum:
{
Queue: No description available. ,
Push: No description available. ,
}
,
Required: False ,
}
enum ,
queue:
{
Description: This property should be populated when deliveryMode is queue and represents information about the queue subscription. ,
Required: False ,
}
{
receiveLockDurationInSeconds:
{
Description: Maximum period in seconds in which once the message is in received (by the client) state and waiting to be accepted, released or rejected. If this time elapsed after a message has been received by the client and not transitioned into accepted (not processed), released or rejected, the message is available for redelivery. This is an optional field, where default is 60 seconds, minimum is 60 seconds and maximum is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDeliveryCount:
{
Description: The maximum delivery count of the events. ,
Format: int32 ,
Required: False ,
}
integer ,
deadLetterDestinationWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
eventTimeToLive:
{
Description: Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: - (n) is replaced by the value of each time element that follows the (n). - P is the duration (or Period) designator and is always placed at the beginning of the duration. - Y is the year designator, and it follows the value for the number of years. - M is the month designator, and it follows the value for the number of months. - W is the week designator, and it follows the value for the number of weeks. - D is the day designator, and it follows the value for the number of days. - T is the time designator, and it precedes the time components. - H is the hour designator, and it follows the value for the number of hours. - M is the minute designator, and it follows the value for the number of minutes. - S is the second designator, and it follows the value for the number of seconds. This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined by topic’s EventRetentionInDays value. The followings are examples of valid values: - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day. ,
Format: duration ,
Required: False ,
}
string ,
}
,
push:
{
Description: This property should be populated when deliveryMode is push and represents information about the push subscription. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: The maximum delivery count of the events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLive:
{
Description: Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: - (n) is replaced by the value of each time element that follows the (n). - P is the duration (or Period) designator and is always placed at the beginning of the duration. - Y is the year designator, and it follows the value for the number of years. - M is the month designator, and it follows the value for the number of months. - W is the week designator, and it follows the value for the number of weeks. - D is the day designator, and it follows the value for the number of days. - T is the time designator, and it precedes the time components. - H is the hour designator, and it follows the value for the number of hours. - M is the minute designator, and it follows the value for the number of minutes. - S is the second designator, and it follows the value for the number of seconds. This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined by topic’s EventRetentionInDays value. The followings are examples of valid values: - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day. ,
Required: False ,
}
string ,
deadLetterDestinationWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, namespace) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
filtersConfiguration:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
filters:
{
Description: An array of filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
tags:
{
Description: Tags relating to Event Subscription resource. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
deliveryConfiguration:
{
Description: Information about the delivery configuration of the event subscription. ,
Required: False ,
}
{
deliveryMode:
{
Description: Delivery mode of the event subscription. ,
Enum:
{
Queue: No description available. ,
Push: No description available. ,
}
,
Required: False ,
}
enum ,
queue:
{
Description: This property should be populated when deliveryMode is queue and represents information about the queue subscription. ,
Required: False ,
}
{
receiveLockDurationInSeconds:
{
Description: Maximum period in seconds in which once the message is in received (by the client) state and waiting to be accepted, released or rejected. If this time elapsed after a message has been received by the client and not transitioned into accepted (not processed), released or rejected, the message is available for redelivery. This is an optional field, where default is 60 seconds, minimum is 60 seconds and maximum is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDeliveryCount:
{
Description: The maximum delivery count of the events. ,
Format: int32 ,
Required: False ,
}
integer ,
deadLetterDestinationWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
eventTimeToLive:
{
Description: Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: - (n) is replaced by the value of each time element that follows the (n). - P is the duration (or Period) designator and is always placed at the beginning of the duration. - Y is the year designator, and it follows the value for the number of years. - M is the month designator, and it follows the value for the number of months. - W is the week designator, and it follows the value for the number of weeks. - D is the day designator, and it follows the value for the number of days. - T is the time designator, and it precedes the time components. - H is the hour designator, and it follows the value for the number of hours. - M is the minute designator, and it follows the value for the number of minutes. - S is the second designator, and it follows the value for the number of seconds. This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined by topic’s EventRetentionInDays value. The followings are examples of valid values: - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day. ,
Format: duration ,
Required: False ,
}
string ,
}
,
push:
{
Description: This property should be populated when deliveryMode is push and represents information about the push subscription. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: The maximum delivery count of the events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLive:
{
Description: Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: - (n) is replaced by the value of each time element that follows the (n). - P is the duration (or Period) designator and is always placed at the beginning of the duration. - Y is the year designator, and it follows the value for the number of years. - M is the month designator, and it follows the value for the number of months. - W is the week designator, and it follows the value for the number of weeks. - D is the day designator, and it follows the value for the number of days. - T is the time designator, and it precedes the time components. - H is the hour designator, and it follows the value for the number of hours. - M is the minute designator, and it follows the value for the number of minutes. - S is the second designator, and it follows the value for the number of seconds. This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined by topic’s EventRetentionInDays value. The followings are examples of valid values: - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day. ,
Required: False ,
}
string ,
deadLetterDestinationWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, namespace) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
filtersConfiguration:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
filters:
{
Description: An array of filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
tags:
{
Description: Tags relating to Event Subscription resource. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Event Subscription. ,
}
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
deliveryConfiguration:
{
Description: Information about the delivery configuration of the event subscription. ,
Required: False ,
}
{
deliveryMode:
{
Description: Delivery mode of the event subscription. ,
Enum:
{
Queue: No description available. ,
Push: No description available. ,
}
,
Required: False ,
}
enum ,
queue:
{
Description: This property should be populated when deliveryMode is queue and represents information about the queue subscription. ,
Required: False ,
}
{
receiveLockDurationInSeconds:
{
Description: Maximum period in seconds in which once the message is in received (by the client) state and waiting to be accepted, released or rejected. If this time elapsed after a message has been received by the client and not transitioned into accepted (not processed), released or rejected, the message is available for redelivery. This is an optional field, where default is 60 seconds, minimum is 60 seconds and maximum is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDeliveryCount:
{
Description: The maximum delivery count of the events. ,
Format: int32 ,
Required: False ,
}
integer ,
deadLetterDestinationWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
eventTimeToLive:
{
Description: Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: - (n) is replaced by the value of each time element that follows the (n). - P is the duration (or Period) designator and is always placed at the beginning of the duration. - Y is the year designator, and it follows the value for the number of years. - M is the month designator, and it follows the value for the number of months. - W is the week designator, and it follows the value for the number of weeks. - D is the day designator, and it follows the value for the number of days. - T is the time designator, and it precedes the time components. - H is the hour designator, and it follows the value for the number of hours. - M is the minute designator, and it follows the value for the number of minutes. - S is the second designator, and it follows the value for the number of seconds. This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined by topic’s EventRetentionInDays value. The followings are examples of valid values: - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day. ,
Format: duration ,
Required: False ,
}
string ,
}
,
push:
{
Description: This property should be populated when deliveryMode is push and represents information about the push subscription. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: The maximum delivery count of the events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLive:
{
Description: Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: - (n) is replaced by the value of each time element that follows the (n). - P is the duration (or Period) designator and is always placed at the beginning of the duration. - Y is the year designator, and it follows the value for the number of years. - M is the month designator, and it follows the value for the number of months. - W is the week designator, and it follows the value for the number of weeks. - D is the day designator, and it follows the value for the number of days. - T is the time designator, and it precedes the time components. - H is the hour designator, and it follows the value for the number of hours. - M is the minute designator, and it follows the value for the number of minutes. - S is the second designator, and it follows the value for the number of seconds. This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined by topic’s EventRetentionInDays value. The followings are examples of valid values: - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day. ,
Required: False ,
}
string ,
deadLetterDestinationWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, namespace) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
filtersConfiguration:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
filters:
{
Description: An array of filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
tags:
{
Description: Tags relating to Event Subscription resource. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceTopicEventSubscriptions_ListByNamespaceTopic (new)
Description :  List event subscriptions that belong to a specific namespace topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/eventSubscriptions
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the namespace topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of Subscriptions. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
deliveryConfiguration:
{
Description: Information about the delivery configuration of the event subscription. ,
Required: False ,
}
{
deliveryMode:
{
Description: Delivery mode of the event subscription. ,
Enum:
{
Queue: No description available. ,
Push: No description available. ,
}
,
Required: False ,
}
enum ,
queue:
{
Description: This property should be populated when deliveryMode is queue and represents information about the queue subscription. ,
Required: False ,
}
{
receiveLockDurationInSeconds:
{
Description: Maximum period in seconds in which once the message is in received (by the client) state and waiting to be accepted, released or rejected. If this time elapsed after a message has been received by the client and not transitioned into accepted (not processed), released or rejected, the message is available for redelivery. This is an optional field, where default is 60 seconds, minimum is 60 seconds and maximum is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDeliveryCount:
{
Description: The maximum delivery count of the events. ,
Format: int32 ,
Required: False ,
}
integer ,
deadLetterDestinationWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
eventTimeToLive:
{
Description: Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: - (n) is replaced by the value of each time element that follows the (n). - P is the duration (or Period) designator and is always placed at the beginning of the duration. - Y is the year designator, and it follows the value for the number of years. - M is the month designator, and it follows the value for the number of months. - W is the week designator, and it follows the value for the number of weeks. - D is the day designator, and it follows the value for the number of days. - T is the time designator, and it precedes the time components. - H is the hour designator, and it follows the value for the number of hours. - M is the minute designator, and it follows the value for the number of minutes. - S is the second designator, and it follows the value for the number of seconds. This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined by topic’s EventRetentionInDays value. The followings are examples of valid values: - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day. ,
Format: duration ,
Required: False ,
}
string ,
}
,
push:
{
Description: This property should be populated when deliveryMode is push and represents information about the push subscription. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: The maximum delivery count of the events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLive:
{
Description: Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: - (n) is replaced by the value of each time element that follows the (n). - P is the duration (or Period) designator and is always placed at the beginning of the duration. - Y is the year designator, and it follows the value for the number of years. - M is the month designator, and it follows the value for the number of months. - W is the week designator, and it follows the value for the number of weeks. - D is the day designator, and it follows the value for the number of days. - T is the time designator, and it precedes the time components. - H is the hour designator, and it follows the value for the number of hours. - M is the minute designator, and it follows the value for the number of minutes. - S is the second designator, and it follows the value for the number of seconds. This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined by topic’s EventRetentionInDays value. The followings are examples of valid values: - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day. ,
Required: False ,
}
string ,
deadLetterDestinationWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, namespace) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
filtersConfiguration:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
filters:
{
Description: An array of filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
tags:
{
Description: Tags relating to Event Subscription resource. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of event subscriptions ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceTopicEventSubscriptions_GetDeliveryAttributes (new)
Description :  Get all delivery attributes for an event subscription of a namespace topic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}/getDeliveryAttributes
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the namespace topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of DeliveryAttributeMapping ,
Required: False ,
}
[
{
name:
{
Description: Name of the delivery attribute or header. ,
Required: False ,
}
string ,
type:
{
Description: Type of the delivery attribute or header name. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EventSubscriptions_Get (new)
Description :  Get properties of an event subscription.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}
{
scope:
{
Description: The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be found. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
EventSubscriptions_CreateOrUpdate (new)
Description :  Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}
{
scope:
{
Description: The identifier of the resource to which the event subscription needs to be created or updated. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only. ,
Required: True ,
}
string ,
eventSubscriptionInfo:
{
Description: Event subscription properties containing the destination and filter information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
EventSubscriptions_Delete (new)
Description :  Delete an existing event subscription.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}
{
scope:
{
Description: The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{}
EventSubscriptions_Update (new)
Description :  Asynchronously updates an existing event subscription.
Reference :  Link ¶

⚼ Request

PATCH:  /{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}
{
scope:
{
Description: The scope of existing event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be updated. ,
Required: True ,
}
string ,
eventSubscriptionUpdateParameters:
{
Description: Updated event subscription information. ,
Required: True ,
}
{
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Information about the expiration time for the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
DomainTopicEventSubscriptions_Get (new)
Description :  Get properties of a nested event subscription for a domain topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the top level domain. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the domain topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be found. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
DomainTopicEventSubscriptions_CreateOrUpdate (new)
Description :  Asynchronously creates a new event subscription or updates an existing event subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the top level domain. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the domain topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and use alphanumeric letters only. ,
Required: True ,
}
string ,
eventSubscriptionInfo:
{
Description: Event subscription properties containing the destination and filter information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
DomainTopicEventSubscriptions_Delete (new)
Description :  Delete a nested existing event subscription for a domain topic.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the top level domain. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the domain topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{}
DomainTopicEventSubscriptions_Update (new)
Description :  Update an existing event subscription for a domain topic.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be updated. ,
Required: True ,
}
string ,
eventSubscriptionUpdateParameters:
{
Description: Updated event subscription information. ,
Required: True ,
}
{
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Information about the expiration time for the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
TopicEventSubscriptions_Get (new)
Description :  Get properties of an event subscription of a topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be found. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
TopicEventSubscriptions_CreateOrUpdate (new)
Description :  Asynchronously creates a new event subscription or updates an existing event subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the domain topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and use alphanumeric letters only. ,
Required: True ,
}
string ,
eventSubscriptionInfo:
{
Description: Event subscription properties containing the destination and filter information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
TopicEventSubscriptions_Delete (new)
Description :  Delete an existing event subscription for a topic.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{}
TopicEventSubscriptions_Update (new)
Description :  Update an existing event subscription for a topic.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be updated. ,
Required: True ,
}
string ,
eventSubscriptionUpdateParameters:
{
Description: Updated event subscription information. ,
Required: True ,
}
{
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Information about the expiration time for the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
DomainEventSubscriptions_Get (new)
Description :  Get properties of an event subscription of a domain.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be found. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
DomainEventSubscriptions_CreateOrUpdate (new)
Description :  Asynchronously creates a new event subscription or updates an existing event subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and use alphanumeric letters only. ,
Required: True ,
}
string ,
eventSubscriptionInfo:
{
Description: Event subscription properties containing the destination and filter information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
DomainEventSubscriptions_Delete (new)
Description :  Delete an existing event subscription for a domain.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{}
DomainEventSubscriptions_Update (new)
Description :  Update an existing event subscription for a topic.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be updated. ,
Required: True ,
}
string ,
eventSubscriptionUpdateParameters:
{
Description: Updated event subscription information. ,
Required: True ,
}
{
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Information about the expiration time for the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
SystemTopicEventSubscriptions_Get (new)
Description :  Get an event subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
systemTopicName:
{
Description: Name of the system topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be found. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
SystemTopicEventSubscriptions_CreateOrUpdate (new)
Description :  Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
systemTopicName:
{
Description: Name of the system topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and use alphanumeric letters only. ,
Required: True ,
}
string ,
eventSubscriptionInfo:
{
Description: Event subscription properties containing the destination and filter information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
SystemTopicEventSubscriptions_Delete (new)
Description :  Delete an existing event subscription of a system topic.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
systemTopicName:
{
Description: Name of the system topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{}
SystemTopicEventSubscriptions_Update (new)
Description :  Update an existing event subscription of a system topic.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
systemTopicName:
{
Description: Name of the system topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be updated. ,
Required: True ,
}
string ,
eventSubscriptionUpdateParameters:
{
Description: Updated event subscription information. ,
Required: True ,
}
{
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Information about the expiration time for the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
SystemTopicEventSubscriptions_GetFullUrl (new)
Description :  Get the full endpoint URL for an event subscription of a system topic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}/getFullUrl
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
systemTopicName:
{
Description: Name of the system topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endpointUrl:
{
Description: The URL that represents the endpoint of the destination of an event subscription. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
EventSubscriptions_GetFullUrl (new)
Description :  Get the full endpoint URL for an event subscription.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}/getFullUrl
{
scope:
{
Description: The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endpointUrl:
{
Description: The URL that represents the endpoint of the destination of an event subscription. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
SystemTopicEventSubscriptions_ListBySystemTopic (new)
Description :  List event subscriptions that belong to a specific system topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
systemTopicName:
{
Description: Name of the system topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of EventSubscriptions ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of event subscriptions ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
PartnerTopicEventSubscriptions_Get (new)
Description :  Get properties of an event subscription of a partner topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerTopicName:
{
Description: Name of the partner topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be found. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
PartnerTopicEventSubscriptions_CreateOrUpdate (new)
Description :  Asynchronously creates or updates an event subscription of a partner topic with the specified parameters. Existing event subscriptions will be updated with this API.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerTopicName:
{
Description: Name of the partner topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and use alphanumeric letters only. ,
Required: True ,
}
string ,
eventSubscriptionInfo:
{
Description: Event subscription properties containing the destination and filter information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
PartnerTopicEventSubscriptions_Delete (new)
Description :  Delete an existing event subscription of a partner topic.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerTopicName:
{
Description: Name of the partner topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{}
PartnerTopicEventSubscriptions_Update (new)
Description :  Update an existing event subscription of a partner topic.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerTopicName:
{
Description: Name of the partner topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription to be updated. ,
Required: True ,
}
string ,
eventSubscriptionUpdateParameters:
{
Description: Updated event subscription information. ,
Required: True ,
}
{
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Information about the expiration time for the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
PartnerTopicEventSubscriptions_GetFullUrl (new)
Description :  Get the full endpoint URL for an event subscription of a partner topic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}/getFullUrl
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerTopicName:
{
Description: Name of the partner topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endpointUrl:
{
Description: The URL that represents the endpoint of the destination of an event subscription. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
PartnerTopicEventSubscriptions_ListByPartnerTopic (new)
Description :  List event subscriptions that belong to a specific partner topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerTopicName:
{
Description: Name of the partner topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of EventSubscriptions ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of event subscriptions ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
DomainTopicEventSubscriptions_GetFullUrl (new)
Description :  Get the full endpoint URL for a nested event subscription for domain topic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}/getFullUrl
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the top level domain. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the domain topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endpointUrl:
{
Description: The URL that represents the endpoint of the destination of an event subscription. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
TopicEventSubscriptions_GetFullUrl (new)
Description :  Get the full endpoint URL for an event subscription for topic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}/getFullUrl
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the domain topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endpointUrl:
{
Description: The URL that represents the endpoint of the destination of an event subscription. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
DomainEventSubscriptions_GetFullUrl (new)
Description :  Get the full endpoint URL for an event subscription for domain.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}/getFullUrl
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endpointUrl:
{
Description: The URL that represents the endpoint of the destination of an event subscription. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
EventSubscriptions_ListGlobalBySubscription (new)
Description :  List all aggregated global event subscriptions under a specific Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/eventSubscriptions
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of EventSubscriptions ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of event subscriptions ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
EventSubscriptions_ListGlobalBySubscriptionForTopicType (new)
Description :  List all global event subscriptions under an Azure subscription for a topic type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
topicTypeName:
{
Description: Name of the topic type. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of EventSubscriptions ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of event subscriptions ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
EventSubscriptions_ListGlobalByResourceGroup (new)
Description :  List all global event subscriptions under a specific Azure subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/eventSubscriptions
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of EventSubscriptions ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of event subscriptions ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
EventSubscriptions_ListGlobalByResourceGroupForTopicType (new)
Description :  List all global event subscriptions under a resource group for a specific topic type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
topicTypeName:
{
Description: Name of the topic type. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of EventSubscriptions ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of event subscriptions ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
EventSubscriptions_ListRegionalBySubscription (new)
Description :  List all event subscriptions from the given location under a specific Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/eventSubscriptions
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Name of the location. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of EventSubscriptions ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of event subscriptions ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
EventSubscriptions_ListRegionalByResourceGroup (new)
Description :  List all event subscriptions from the given location under a specific Azure subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/eventSubscriptions
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
location:
{
Description: Name of the location. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of EventSubscriptions ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of event subscriptions ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
EventSubscriptions_ListRegionalBySubscriptionForTopicType (new)
Description :  List all event subscriptions from the given location under a specific Azure subscription and topic type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Name of the location. ,
Required: True ,
}
string ,
topicTypeName:
{
Description: Name of the topic type. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of EventSubscriptions ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of event subscriptions ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
EventSubscriptions_ListRegionalByResourceGroupForTopicType (new)
Description :  List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
location:
{
Description: Name of the location. ,
Required: True ,
}
string ,
topicTypeName:
{
Description: Name of the topic type. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of EventSubscriptions ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of event subscriptions ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
EventSubscriptions_ListByResource (new)
Description :  List all event subscriptions that have been created for a specific resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventSubscriptions
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
providerNamespace:
{
Description: Namespace of the provider of the topic. ,
Required: True ,
}
string ,
resourceTypeName:
{
Description: Name of the resource type. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of EventSubscriptions ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of event subscriptions ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
TopicEventSubscriptions_List (new)
Description :  List all event subscriptions that have been created for a specific topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of EventSubscriptions ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of event subscriptions ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
DomainEventSubscriptions_List (new)
Description :  List all event subscriptions that have been created for a specific topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of EventSubscriptions ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of event subscriptions ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
EventSubscriptions_ListByDomainTopic (new)
Description :  List all event subscriptions that have been created for a specific domain topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/providers/Microsoft.EventGrid/eventSubscriptions
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the top level domain. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the domain topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of EventSubscriptions ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of event subscriptions ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
DomainTopicEventSubscriptions_List (new)
Description :  List all event subscriptions that have been created for a specific domain topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the top level domain. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the domain topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of EventSubscriptions ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the event subscription. ,
Required: False ,
}
{
topic:
{
Description: Name of the topic of the event subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the event subscription. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
AwaitingManualAction: No description available. ,
}
,
Required: False ,
}
enum ,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deliveryWithResourceIdentity:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when delivering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
destination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the event subscription destination. ,
Enum:
{
WebHook: No description available. ,
EventHub: No description available. ,
StorageQueue: No description available. ,
HybridConnection: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
AzureFunction: No description available. ,
PartnerDestination: No description available. ,
MonitorAlert: No description available. ,
NamespaceTopic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
filter:
{
Description: Information about the filter for the event subscription. ,
Required: False ,
}
{
subjectBeginsWith:
{
Description: 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. ,
Required: False ,
}
string ,
subjectEndsWith:
{
Description: An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path. ,
Required: False ,
}
string ,
includedEventTypes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
isSubjectCaseSensitive:
{
Description: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. ,
Required: False ,
}
boolean ,
enableAdvancedFilteringOnArrays:
{
Description: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. ,
Required: False ,
}
boolean ,
advancedFilters:
{
Description: An array of advanced filters that are used for filtering event subscriptions. ,
Required: False ,
}
[
{
operatorType:
{
Description: The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. ,
Enum:
{
NumberIn: No description available. ,
NumberNotIn: No description available. ,
NumberLessThan: No description available. ,
NumberGreaterThan: No description available. ,
NumberLessThanOrEquals: No description available. ,
NumberGreaterThanOrEquals: No description available. ,
BoolEquals: No description available. ,
StringIn: No description available. ,
StringNotIn: No description available. ,
StringBeginsWith: No description available. ,
StringEndsWith: No description available. ,
StringContains: No description available. ,
NumberInRange: No description available. ,
NumberNotInRange: No description available. ,
StringNotBeginsWith: No description available. ,
StringNotEndsWith: No description available. ,
StringNotContains: No description available. ,
IsNullOrUndefined: No description available. ,
IsNotNull: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: The field/property in the event based on which you want to filter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
labels:
{
Description: List of user defined labels. ,
Required: False ,
}
[
string ,
]
,
expirationTimeUtc:
{
Description: Expiration time of the event subscription. ,
Format: date-time ,
Required: False ,
}
string ,
eventDeliverySchema:
{
Description: The event delivery schema for the event subscription. ,
Enum:
{
EventGridSchema: No description available. ,
CustomInputSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. ,
Required: False ,
}
{
maxDeliveryAttempts:
{
Description: Maximum number of delivery retry attempts for events. ,
Format: int32 ,
Required: False ,
}
integer ,
eventTimeToLiveInMinutes:
{
Description: Time To Live (in minutes) for events. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deadLetterDestination:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
deadLetterWithResourceIdentity:
{
Description: The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. ,
Required: False ,
}
{
identity:
{
Description: The identity to use when dead-lettering events. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
federatedIdentityCredentialInfo:
{
Description: The details of the Federated Identity Credential (FIC) used with the resource delivery. ,
Required: False ,
}
{
federatedClientId:
{
Description: The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
deadLetterDestination:
{
Description: Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. ,
Required: False ,
}
{
endpointType:
{
Description: Type of the endpoint for the dead letter destination ,
Enum:
{
StorageBlob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of event subscriptions ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
PartnerTopicEventSubscriptions_GetDeliveryAttributes (new)
Description :  Get all delivery attributes for an event subscription of a partner topic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}/getDeliveryAttributes
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerTopicName:
{
Description: Name of the partner topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of DeliveryAttributeMapping ,
Required: False ,
}
[
{
name:
{
Description: Name of the delivery attribute or header. ,
Required: False ,
}
string ,
type:
{
Description: Type of the delivery attribute or header name. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{}
Namespaces_Get (new)
Description :  Get properties of a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Namespace resource. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the namespace resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
topicsConfiguration:
{
Description: Topics configuration information for the namespace resource ,
Required: False ,
}
{
hostname:
{
Description: The hostname for the topics configuration. This is a read-only property. ,
Required: False ,
}
string ,
customDomains:
{
Description: List of custom domain configurations for the namespace. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
topicSpacesConfiguration:
{
Description: Topic spaces configuration information for the namespace resource ,
Required: False ,
}
{
state:
{
Description: Indicate if Topic Spaces Configuration is enabled for the namespace. Default is Disabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
routeTopicResourceId:
{
Description: Fully qualified Azure Resource Id for the Event Grid Topic to which events will be routed to from TopicSpaces under a namespace. This property should be in the following format '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft.EventGrid/topics/{topicName}'. This topic should reside in the same region where namespace is located. ,
Required: False ,
}
string ,
hostname:
{
Description: The endpoint for the topic spaces configuration. This is a read-only property. ,
Required: False ,
}
string ,
routingEnrichments:
{
Description: Routing enrichments for topic spaces configuration ,
Required: False ,
}
{
static:
{
Required: False ,
}
[
{
key:
{
Description: Static routing enrichment key. ,
Required: False ,
}
string ,
valueType:
{
Description: Static routing enrichment value type. For e.g. this property value can be 'String'. ,
Enum:
{
String: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dynamic:
{
Required: False ,
}
[
{
key:
{
Description: Dynamic routing enrichment key. ,
Required: False ,
}
string ,
value:
{
Description: Dynamic routing enrichment value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
clientAuthentication:
{
Description: Client authentication settings for topic spaces configuration. ,
Required: False ,
}
{
alternativeAuthenticationNameSources:
{
Description: Alternative authentication name sources related to client authentication settings for namespace resource. ,
Required: False ,
}
[
string ,
]
,
customJwtAuthentication:
{
Description: Custom JWT authentication settings for namespace resource. ,
Required: False ,
}
{
tokenIssuer:
{
Description: Expected JWT token issuer. ,
Required: False ,
}
string ,
issuerCertificates:
{
Description: Information about the certificates that are used for token validation. We currently support maximum 2 certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: Keyvault certificate URL in https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion format. ,
Required: True ,
}
string ,
identity:
{
Description: The identity that will be used to access the certificate. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
encodedIssuerCertificates:
{
Description: Information about the encoded public certificates that are used for custom authentication. ,
Required: False ,
}
[
{
kid:
{
Description: Identifier for the certificate. ,
Required: True ,
}
string ,
encodedCertificate:
{
Description: Certificate in pem format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
maximumSessionExpiryInHours:
{
Description: The maximum session expiry in hours. The property default value is 1 hour. Min allowed value is 1 hour and max allowed value is 8 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumClientSessionsPerAuthenticationName:
{
Description: The maximum number of sessions per authentication name. The property default value is 1. Min allowed value is 1 and max allowed value is 100. ,
Format: int32 ,
Required: False ,
}
integer ,
routingIdentityInfo:
{
Description: Routing identity info for topic spaces configuration. ,
Required: False ,
}
{
type:
{
Description: Routing identity type for topic spaces configuration. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Required: False ,
}
string ,
}
,
customDomains:
{
Description: List of custom domain configurations for the namespace. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
isZoneRedundant:
{
Description: This is an optional property and it allows the user to specify if the namespace resource supports zone-redundancy capability or not. If this property is not specified explicitly by the user, its default value depends on the following conditions: a. For Availability Zones enabled regions - The default property value would be true. b. For non-Availability Zones enabled regions - The default property value would be false. Once specified, this property cannot be updated. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this namespace. Only TLS version 1.2 is supported. ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Represents available Sku pricing tiers. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Specifies the number of Throughput Units that defines the capacity for the namespace. The property default value is 1 which signifies 1 Throughput Unit = 1MB/s ingress and 2MB/s egress per namespace. Min capacity is 1 and max allowed capacity is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity information for the Namespace resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdate (new)
Description :  Asynchronously creates or updates a new namespace with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
namespaceInfo:
{
Description: Namespace information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Namespace resource. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the namespace resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
topicsConfiguration:
{
Description: Topics configuration information for the namespace resource ,
Required: False ,
}
{
hostname:
{
Description: The hostname for the topics configuration. This is a read-only property. ,
Required: False ,
}
string ,
customDomains:
{
Description: List of custom domain configurations for the namespace. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
topicSpacesConfiguration:
{
Description: Topic spaces configuration information for the namespace resource ,
Required: False ,
}
{
state:
{
Description: Indicate if Topic Spaces Configuration is enabled for the namespace. Default is Disabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
routeTopicResourceId:
{
Description: Fully qualified Azure Resource Id for the Event Grid Topic to which events will be routed to from TopicSpaces under a namespace. This property should be in the following format '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft.EventGrid/topics/{topicName}'. This topic should reside in the same region where namespace is located. ,
Required: False ,
}
string ,
hostname:
{
Description: The endpoint for the topic spaces configuration. This is a read-only property. ,
Required: False ,
}
string ,
routingEnrichments:
{
Description: Routing enrichments for topic spaces configuration ,
Required: False ,
}
{
static:
{
Required: False ,
}
[
{
key:
{
Description: Static routing enrichment key. ,
Required: False ,
}
string ,
valueType:
{
Description: Static routing enrichment value type. For e.g. this property value can be 'String'. ,
Enum:
{
String: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dynamic:
{
Required: False ,
}
[
{
key:
{
Description: Dynamic routing enrichment key. ,
Required: False ,
}
string ,
value:
{
Description: Dynamic routing enrichment value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
clientAuthentication:
{
Description: Client authentication settings for topic spaces configuration. ,
Required: False ,
}
{
alternativeAuthenticationNameSources:
{
Description: Alternative authentication name sources related to client authentication settings for namespace resource. ,
Required: False ,
}
[
string ,
]
,
customJwtAuthentication:
{
Description: Custom JWT authentication settings for namespace resource. ,
Required: False ,
}
{
tokenIssuer:
{
Description: Expected JWT token issuer. ,
Required: False ,
}
string ,
issuerCertificates:
{
Description: Information about the certificates that are used for token validation. We currently support maximum 2 certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: Keyvault certificate URL in https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion format. ,
Required: True ,
}
string ,
identity:
{
Description: The identity that will be used to access the certificate. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
encodedIssuerCertificates:
{
Description: Information about the encoded public certificates that are used for custom authentication. ,
Required: False ,
}
[
{
kid:
{
Description: Identifier for the certificate. ,
Required: True ,
}
string ,
encodedCertificate:
{
Description: Certificate in pem format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
maximumSessionExpiryInHours:
{
Description: The maximum session expiry in hours. The property default value is 1 hour. Min allowed value is 1 hour and max allowed value is 8 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumClientSessionsPerAuthenticationName:
{
Description: The maximum number of sessions per authentication name. The property default value is 1. Min allowed value is 1 and max allowed value is 100. ,
Format: int32 ,
Required: False ,
}
integer ,
routingIdentityInfo:
{
Description: Routing identity info for topic spaces configuration. ,
Required: False ,
}
{
type:
{
Description: Routing identity type for topic spaces configuration. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Required: False ,
}
string ,
}
,
customDomains:
{
Description: List of custom domain configurations for the namespace. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
isZoneRedundant:
{
Description: This is an optional property and it allows the user to specify if the namespace resource supports zone-redundancy capability or not. If this property is not specified explicitly by the user, its default value depends on the following conditions: a. For Availability Zones enabled regions - The default property value would be true. b. For non-Availability Zones enabled regions - The default property value would be false. Once specified, this property cannot be updated. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this namespace. Only TLS version 1.2 is supported. ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Represents available Sku pricing tiers. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Specifies the number of Throughput Units that defines the capacity for the namespace. The property default value is 1 which signifies 1 Throughput Unit = 1MB/s ingress and 2MB/s egress per namespace. Min capacity is 1 and max allowed capacity is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity information for the Namespace resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Namespace resource. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the namespace resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
topicsConfiguration:
{
Description: Topics configuration information for the namespace resource ,
Required: False ,
}
{
hostname:
{
Description: The hostname for the topics configuration. This is a read-only property. ,
Required: False ,
}
string ,
customDomains:
{
Description: List of custom domain configurations for the namespace. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
topicSpacesConfiguration:
{
Description: Topic spaces configuration information for the namespace resource ,
Required: False ,
}
{
state:
{
Description: Indicate if Topic Spaces Configuration is enabled for the namespace. Default is Disabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
routeTopicResourceId:
{
Description: Fully qualified Azure Resource Id for the Event Grid Topic to which events will be routed to from TopicSpaces under a namespace. This property should be in the following format '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft.EventGrid/topics/{topicName}'. This topic should reside in the same region where namespace is located. ,
Required: False ,
}
string ,
hostname:
{
Description: The endpoint for the topic spaces configuration. This is a read-only property. ,
Required: False ,
}
string ,
routingEnrichments:
{
Description: Routing enrichments for topic spaces configuration ,
Required: False ,
}
{
static:
{
Required: False ,
}
[
{
key:
{
Description: Static routing enrichment key. ,
Required: False ,
}
string ,
valueType:
{
Description: Static routing enrichment value type. For e.g. this property value can be 'String'. ,
Enum:
{
String: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dynamic:
{
Required: False ,
}
[
{
key:
{
Description: Dynamic routing enrichment key. ,
Required: False ,
}
string ,
value:
{
Description: Dynamic routing enrichment value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
clientAuthentication:
{
Description: Client authentication settings for topic spaces configuration. ,
Required: False ,
}
{
alternativeAuthenticationNameSources:
{
Description: Alternative authentication name sources related to client authentication settings for namespace resource. ,
Required: False ,
}
[
string ,
]
,
customJwtAuthentication:
{
Description: Custom JWT authentication settings for namespace resource. ,
Required: False ,
}
{
tokenIssuer:
{
Description: Expected JWT token issuer. ,
Required: False ,
}
string ,
issuerCertificates:
{
Description: Information about the certificates that are used for token validation. We currently support maximum 2 certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: Keyvault certificate URL in https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion format. ,
Required: True ,
}
string ,
identity:
{
Description: The identity that will be used to access the certificate. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
encodedIssuerCertificates:
{
Description: Information about the encoded public certificates that are used for custom authentication. ,
Required: False ,
}
[
{
kid:
{
Description: Identifier for the certificate. ,
Required: True ,
}
string ,
encodedCertificate:
{
Description: Certificate in pem format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
maximumSessionExpiryInHours:
{
Description: The maximum session expiry in hours. The property default value is 1 hour. Min allowed value is 1 hour and max allowed value is 8 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumClientSessionsPerAuthenticationName:
{
Description: The maximum number of sessions per authentication name. The property default value is 1. Min allowed value is 1 and max allowed value is 100. ,
Format: int32 ,
Required: False ,
}
integer ,
routingIdentityInfo:
{
Description: Routing identity info for topic spaces configuration. ,
Required: False ,
}
{
type:
{
Description: Routing identity type for topic spaces configuration. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Required: False ,
}
string ,
}
,
customDomains:
{
Description: List of custom domain configurations for the namespace. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
isZoneRedundant:
{
Description: This is an optional property and it allows the user to specify if the namespace resource supports zone-redundancy capability or not. If this property is not specified explicitly by the user, its default value depends on the following conditions: a. For Availability Zones enabled regions - The default property value would be true. b. For non-Availability Zones enabled regions - The default property value would be false. Once specified, this property cannot be updated. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this namespace. Only TLS version 1.2 is supported. ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Represents available Sku pricing tiers. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Specifies the number of Throughput Units that defines the capacity for the namespace. The property default value is 1 which signifies 1 Throughput Unit = 1MB/s ingress and 2MB/s egress per namespace. Min capacity is 1 and max allowed capacity is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity information for the Namespace resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Namespace resource. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the namespace resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
topicsConfiguration:
{
Description: Topics configuration information for the namespace resource ,
Required: False ,
}
{
hostname:
{
Description: The hostname for the topics configuration. This is a read-only property. ,
Required: False ,
}
string ,
customDomains:
{
Description: List of custom domain configurations for the namespace. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
topicSpacesConfiguration:
{
Description: Topic spaces configuration information for the namespace resource ,
Required: False ,
}
{
state:
{
Description: Indicate if Topic Spaces Configuration is enabled for the namespace. Default is Disabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
routeTopicResourceId:
{
Description: Fully qualified Azure Resource Id for the Event Grid Topic to which events will be routed to from TopicSpaces under a namespace. This property should be in the following format '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft.EventGrid/topics/{topicName}'. This topic should reside in the same region where namespace is located. ,
Required: False ,
}
string ,
hostname:
{
Description: The endpoint for the topic spaces configuration. This is a read-only property. ,
Required: False ,
}
string ,
routingEnrichments:
{
Description: Routing enrichments for topic spaces configuration ,
Required: False ,
}
{
static:
{
Required: False ,
}
[
{
key:
{
Description: Static routing enrichment key. ,
Required: False ,
}
string ,
valueType:
{
Description: Static routing enrichment value type. For e.g. this property value can be 'String'. ,
Enum:
{
String: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dynamic:
{
Required: False ,
}
[
{
key:
{
Description: Dynamic routing enrichment key. ,
Required: False ,
}
string ,
value:
{
Description: Dynamic routing enrichment value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
clientAuthentication:
{
Description: Client authentication settings for topic spaces configuration. ,
Required: False ,
}
{
alternativeAuthenticationNameSources:
{
Description: Alternative authentication name sources related to client authentication settings for namespace resource. ,
Required: False ,
}
[
string ,
]
,
customJwtAuthentication:
{
Description: Custom JWT authentication settings for namespace resource. ,
Required: False ,
}
{
tokenIssuer:
{
Description: Expected JWT token issuer. ,
Required: False ,
}
string ,
issuerCertificates:
{
Description: Information about the certificates that are used for token validation. We currently support maximum 2 certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: Keyvault certificate URL in https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion format. ,
Required: True ,
}
string ,
identity:
{
Description: The identity that will be used to access the certificate. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
encodedIssuerCertificates:
{
Description: Information about the encoded public certificates that are used for custom authentication. ,
Required: False ,
}
[
{
kid:
{
Description: Identifier for the certificate. ,
Required: True ,
}
string ,
encodedCertificate:
{
Description: Certificate in pem format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
maximumSessionExpiryInHours:
{
Description: The maximum session expiry in hours. The property default value is 1 hour. Min allowed value is 1 hour and max allowed value is 8 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumClientSessionsPerAuthenticationName:
{
Description: The maximum number of sessions per authentication name. The property default value is 1. Min allowed value is 1 and max allowed value is 100. ,
Format: int32 ,
Required: False ,
}
integer ,
routingIdentityInfo:
{
Description: Routing identity info for topic spaces configuration. ,
Required: False ,
}
{
type:
{
Description: Routing identity type for topic spaces configuration. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Required: False ,
}
string ,
}
,
customDomains:
{
Description: List of custom domain configurations for the namespace. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
isZoneRedundant:
{
Description: This is an optional property and it allows the user to specify if the namespace resource supports zone-redundancy capability or not. If this property is not specified explicitly by the user, its default value depends on the following conditions: a. For Availability Zones enabled regions - The default property value would be true. b. For non-Availability Zones enabled regions - The default property value would be false. Once specified, this property cannot be updated. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this namespace. Only TLS version 1.2 is supported. ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Represents available Sku pricing tiers. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Specifies the number of Throughput Units that defines the capacity for the namespace. The property default value is 1 which signifies 1 Throughput Unit = 1MB/s ingress and 2MB/s egress per namespace. Min capacity is 1 and max allowed capacity is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity information for the Namespace resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Delete (new)
Description :  Delete existing namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Update (new)
Description :  Asynchronously updates a namespace with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
namespaceUpdateParameters:
{
Description: Namespace update information. ,
Required: True ,
}
{
tags:
{
Description: Tags of the namespace resource. ,
Required: False ,
}
object ,
identity:
{
Description: Namespace resource identity information. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: Represents available Sku pricing tiers. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Specifies the number of Throughput Units that defines the capacity for the namespace. The property default value is 1 which signifies 1 Throughput Unit = 1MB/s ingress and 2MB/s egress per namespace. Min capacity is 1 and max allowed capacity is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Properties of the namespace resource. ,
Required: False ,
}
{
topicSpacesConfiguration:
{
Description: Topic spaces configuration properties that can be updated. ,
Required: False ,
}
{
state:
{
Description: Indicate if Topic Spaces Configuration is enabled for the namespace. Default is Disabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
routeTopicResourceId:
{
Description: This property is used to specify custom topic to which events will be routed to from topic spaces configuration under namespace. ,
Required: False ,
}
string ,
routingEnrichments:
{
Description: Routing enrichments for topic spaces configuration. ,
Required: False ,
}
{
static:
{
Required: False ,
}
[
{
key:
{
Description: Static routing enrichment key. ,
Required: False ,
}
string ,
valueType:
{
Description: Static routing enrichment value type. For e.g. this property value can be 'String'. ,
Enum:
{
String: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dynamic:
{
Required: False ,
}
[
{
key:
{
Description: Dynamic routing enrichment key. ,
Required: False ,
}
string ,
value:
{
Description: Dynamic routing enrichment value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
clientAuthentication:
{
Description: Client authentication settings for topic spaces configuration. ,
Required: False ,
}
{
alternativeAuthenticationNameSources:
{
Description: Alternative authentication name sources related to client authentication settings for namespace resource. ,
Required: False ,
}
[
string ,
]
,
customJwtAuthentication:
{
Description: Custom JWT authentication settings for namespace resource. ,
Required: False ,
}
{
tokenIssuer:
{
Description: Expected JWT token issuer. ,
Required: False ,
}
string ,
issuerCertificates:
{
Description: Information about the certificates that are used for token validation. We currently support maximum 2 certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: Keyvault certificate URL in https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion format. ,
Required: True ,
}
string ,
identity:
{
Description: The identity that will be used to access the certificate. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
encodedIssuerCertificates:
{
Description: Information about the encoded public certificates that are used for custom authentication. ,
Required: False ,
}
[
{
kid:
{
Description: Identifier for the certificate. ,
Required: True ,
}
string ,
encodedCertificate:
{
Description: Certificate in pem format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
maximumSessionExpiryInHours:
{
Description: The maximum session expiry in hours. The property default value is 1 hour. Min allowed value is 1 hour and max allowed value is 8 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumClientSessionsPerAuthenticationName:
{
Description: The maximum number of sessions per authentication name. The property default value is 1. Min allowed value is 1 and max allowed value is 100. ,
Format: int32 ,
Required: False ,
}
integer ,
routingIdentityInfo:
{
Description: Routing identity info for topic spaces configuration. ,
Required: False ,
}
{
type:
{
Description: Routing identity type for topic spaces configuration. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Required: False ,
}
string ,
}
,
customDomains:
{
Description: Custom domain info for topic spaces configuration. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
topicsConfiguration:
{
Description: Topics configuration properties that can be updated. ,
Required: False ,
}
{
customDomains:
{
Description: Custom domain info for topics configuration. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Namespace resource. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the namespace resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
topicsConfiguration:
{
Description: Topics configuration information for the namespace resource ,
Required: False ,
}
{
hostname:
{
Description: The hostname for the topics configuration. This is a read-only property. ,
Required: False ,
}
string ,
customDomains:
{
Description: List of custom domain configurations for the namespace. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
topicSpacesConfiguration:
{
Description: Topic spaces configuration information for the namespace resource ,
Required: False ,
}
{
state:
{
Description: Indicate if Topic Spaces Configuration is enabled for the namespace. Default is Disabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
routeTopicResourceId:
{
Description: Fully qualified Azure Resource Id for the Event Grid Topic to which events will be routed to from TopicSpaces under a namespace. This property should be in the following format '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft.EventGrid/topics/{topicName}'. This topic should reside in the same region where namespace is located. ,
Required: False ,
}
string ,
hostname:
{
Description: The endpoint for the topic spaces configuration. This is a read-only property. ,
Required: False ,
}
string ,
routingEnrichments:
{
Description: Routing enrichments for topic spaces configuration ,
Required: False ,
}
{
static:
{
Required: False ,
}
[
{
key:
{
Description: Static routing enrichment key. ,
Required: False ,
}
string ,
valueType:
{
Description: Static routing enrichment value type. For e.g. this property value can be 'String'. ,
Enum:
{
String: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dynamic:
{
Required: False ,
}
[
{
key:
{
Description: Dynamic routing enrichment key. ,
Required: False ,
}
string ,
value:
{
Description: Dynamic routing enrichment value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
clientAuthentication:
{
Description: Client authentication settings for topic spaces configuration. ,
Required: False ,
}
{
alternativeAuthenticationNameSources:
{
Description: Alternative authentication name sources related to client authentication settings for namespace resource. ,
Required: False ,
}
[
string ,
]
,
customJwtAuthentication:
{
Description: Custom JWT authentication settings for namespace resource. ,
Required: False ,
}
{
tokenIssuer:
{
Description: Expected JWT token issuer. ,
Required: False ,
}
string ,
issuerCertificates:
{
Description: Information about the certificates that are used for token validation. We currently support maximum 2 certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: Keyvault certificate URL in https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion format. ,
Required: True ,
}
string ,
identity:
{
Description: The identity that will be used to access the certificate. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
encodedIssuerCertificates:
{
Description: Information about the encoded public certificates that are used for custom authentication. ,
Required: False ,
}
[
{
kid:
{
Description: Identifier for the certificate. ,
Required: True ,
}
string ,
encodedCertificate:
{
Description: Certificate in pem format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
maximumSessionExpiryInHours:
{
Description: The maximum session expiry in hours. The property default value is 1 hour. Min allowed value is 1 hour and max allowed value is 8 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumClientSessionsPerAuthenticationName:
{
Description: The maximum number of sessions per authentication name. The property default value is 1. Min allowed value is 1 and max allowed value is 100. ,
Format: int32 ,
Required: False ,
}
integer ,
routingIdentityInfo:
{
Description: Routing identity info for topic spaces configuration. ,
Required: False ,
}
{
type:
{
Description: Routing identity type for topic spaces configuration. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Required: False ,
}
string ,
}
,
customDomains:
{
Description: List of custom domain configurations for the namespace. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
isZoneRedundant:
{
Description: This is an optional property and it allows the user to specify if the namespace resource supports zone-redundancy capability or not. If this property is not specified explicitly by the user, its default value depends on the following conditions: a. For Availability Zones enabled regions - The default property value would be true. b. For non-Availability Zones enabled regions - The default property value would be false. Once specified, this property cannot be updated. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this namespace. Only TLS version 1.2 is supported. ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Represents available Sku pricing tiers. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Specifies the number of Throughput Units that defines the capacity for the namespace. The property default value is 1 which signifies 1 Throughput Unit = 1MB/s ingress and 2MB/s egress per namespace. Min capacity is 1 and max allowed capacity is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity information for the Namespace resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Namespace resource. ,
}
{
properties:
{
Description: Properties of the Namespace resource. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the namespace resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
topicsConfiguration:
{
Description: Topics configuration information for the namespace resource ,
Required: False ,
}
{
hostname:
{
Description: The hostname for the topics configuration. This is a read-only property. ,
Required: False ,
}
string ,
customDomains:
{
Description: List of custom domain configurations for the namespace. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
topicSpacesConfiguration:
{
Description: Topic spaces configuration information for the namespace resource ,
Required: False ,
}
{
state:
{
Description: Indicate if Topic Spaces Configuration is enabled for the namespace. Default is Disabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
routeTopicResourceId:
{
Description: Fully qualified Azure Resource Id for the Event Grid Topic to which events will be routed to from TopicSpaces under a namespace. This property should be in the following format '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft.EventGrid/topics/{topicName}'. This topic should reside in the same region where namespace is located. ,
Required: False ,
}
string ,
hostname:
{
Description: The endpoint for the topic spaces configuration. This is a read-only property. ,
Required: False ,
}
string ,
routingEnrichments:
{
Description: Routing enrichments for topic spaces configuration ,
Required: False ,
}
{
static:
{
Required: False ,
}
[
{
key:
{
Description: Static routing enrichment key. ,
Required: False ,
}
string ,
valueType:
{
Description: Static routing enrichment value type. For e.g. this property value can be 'String'. ,
Enum:
{
String: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dynamic:
{
Required: False ,
}
[
{
key:
{
Description: Dynamic routing enrichment key. ,
Required: False ,
}
string ,
value:
{
Description: Dynamic routing enrichment value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
clientAuthentication:
{
Description: Client authentication settings for topic spaces configuration. ,
Required: False ,
}
{
alternativeAuthenticationNameSources:
{
Description: Alternative authentication name sources related to client authentication settings for namespace resource. ,
Required: False ,
}
[
string ,
]
,
customJwtAuthentication:
{
Description: Custom JWT authentication settings for namespace resource. ,
Required: False ,
}
{
tokenIssuer:
{
Description: Expected JWT token issuer. ,
Required: False ,
}
string ,
issuerCertificates:
{
Description: Information about the certificates that are used for token validation. We currently support maximum 2 certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: Keyvault certificate URL in https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion format. ,
Required: True ,
}
string ,
identity:
{
Description: The identity that will be used to access the certificate. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
encodedIssuerCertificates:
{
Description: Information about the encoded public certificates that are used for custom authentication. ,
Required: False ,
}
[
{
kid:
{
Description: Identifier for the certificate. ,
Required: True ,
}
string ,
encodedCertificate:
{
Description: Certificate in pem format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
maximumSessionExpiryInHours:
{
Description: The maximum session expiry in hours. The property default value is 1 hour. Min allowed value is 1 hour and max allowed value is 8 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumClientSessionsPerAuthenticationName:
{
Description: The maximum number of sessions per authentication name. The property default value is 1. Min allowed value is 1 and max allowed value is 100. ,
Format: int32 ,
Required: False ,
}
integer ,
routingIdentityInfo:
{
Description: Routing identity info for topic spaces configuration. ,
Required: False ,
}
{
type:
{
Description: Routing identity type for topic spaces configuration. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Required: False ,
}
string ,
}
,
customDomains:
{
Description: List of custom domain configurations for the namespace. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
isZoneRedundant:
{
Description: This is an optional property and it allows the user to specify if the namespace resource supports zone-redundancy capability or not. If this property is not specified explicitly by the user, its default value depends on the following conditions: a. For Availability Zones enabled regions - The default property value would be true. b. For non-Availability Zones enabled regions - The default property value would be false. Once specified, this property cannot be updated. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this namespace. Only TLS version 1.2 is supported. ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Represents available Sku pricing tiers. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Specifies the number of Throughput Units that defines the capacity for the namespace. The property default value is 1 which signifies 1 Throughput Unit = 1MB/s ingress and 2MB/s egress per namespace. Min capacity is 1 and max allowed capacity is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity information for the Namespace resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListBySubscription (new)
Description :  List all the namespaces under an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/namespaces
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of namespaces. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Namespace resource. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the namespace resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
topicsConfiguration:
{
Description: Topics configuration information for the namespace resource ,
Required: False ,
}
{
hostname:
{
Description: The hostname for the topics configuration. This is a read-only property. ,
Required: False ,
}
string ,
customDomains:
{
Description: List of custom domain configurations for the namespace. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
topicSpacesConfiguration:
{
Description: Topic spaces configuration information for the namespace resource ,
Required: False ,
}
{
state:
{
Description: Indicate if Topic Spaces Configuration is enabled for the namespace. Default is Disabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
routeTopicResourceId:
{
Description: Fully qualified Azure Resource Id for the Event Grid Topic to which events will be routed to from TopicSpaces under a namespace. This property should be in the following format '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft.EventGrid/topics/{topicName}'. This topic should reside in the same region where namespace is located. ,
Required: False ,
}
string ,
hostname:
{
Description: The endpoint for the topic spaces configuration. This is a read-only property. ,
Required: False ,
}
string ,
routingEnrichments:
{
Description: Routing enrichments for topic spaces configuration ,
Required: False ,
}
{
static:
{
Required: False ,
}
[
{
key:
{
Description: Static routing enrichment key. ,
Required: False ,
}
string ,
valueType:
{
Description: Static routing enrichment value type. For e.g. this property value can be 'String'. ,
Enum:
{
String: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dynamic:
{
Required: False ,
}
[
{
key:
{
Description: Dynamic routing enrichment key. ,
Required: False ,
}
string ,
value:
{
Description: Dynamic routing enrichment value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
clientAuthentication:
{
Description: Client authentication settings for topic spaces configuration. ,
Required: False ,
}
{
alternativeAuthenticationNameSources:
{
Description: Alternative authentication name sources related to client authentication settings for namespace resource. ,
Required: False ,
}
[
string ,
]
,
customJwtAuthentication:
{
Description: Custom JWT authentication settings for namespace resource. ,
Required: False ,
}
{
tokenIssuer:
{
Description: Expected JWT token issuer. ,
Required: False ,
}
string ,
issuerCertificates:
{
Description: Information about the certificates that are used for token validation. We currently support maximum 2 certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: Keyvault certificate URL in https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion format. ,
Required: True ,
}
string ,
identity:
{
Description: The identity that will be used to access the certificate. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
encodedIssuerCertificates:
{
Description: Information about the encoded public certificates that are used for custom authentication. ,
Required: False ,
}
[
{
kid:
{
Description: Identifier for the certificate. ,
Required: True ,
}
string ,
encodedCertificate:
{
Description: Certificate in pem format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
maximumSessionExpiryInHours:
{
Description: The maximum session expiry in hours. The property default value is 1 hour. Min allowed value is 1 hour and max allowed value is 8 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumClientSessionsPerAuthenticationName:
{
Description: The maximum number of sessions per authentication name. The property default value is 1. Min allowed value is 1 and max allowed value is 100. ,
Format: int32 ,
Required: False ,
}
integer ,
routingIdentityInfo:
{
Description: Routing identity info for topic spaces configuration. ,
Required: False ,
}
{
type:
{
Description: Routing identity type for topic spaces configuration. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Required: False ,
}
string ,
}
,
customDomains:
{
Description: List of custom domain configurations for the namespace. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
isZoneRedundant:
{
Description: This is an optional property and it allows the user to specify if the namespace resource supports zone-redundancy capability or not. If this property is not specified explicitly by the user, its default value depends on the following conditions: a. For Availability Zones enabled regions - The default property value would be true. b. For non-Availability Zones enabled regions - The default property value would be false. Once specified, this property cannot be updated. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this namespace. Only TLS version 1.2 is supported. ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Represents available Sku pricing tiers. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Specifies the number of Throughput Units that defines the capacity for the namespace. The property default value is 1 which signifies 1 Throughput Unit = 1MB/s ingress and 2MB/s egress per namespace. Min capacity is 1 and max allowed capacity is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity information for the Namespace resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListByResourceGroup (new)
Description :  List all the namespaces under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of namespaces. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Namespace resource. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the namespace resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
topicsConfiguration:
{
Description: Topics configuration information for the namespace resource ,
Required: False ,
}
{
hostname:
{
Description: The hostname for the topics configuration. This is a read-only property. ,
Required: False ,
}
string ,
customDomains:
{
Description: List of custom domain configurations for the namespace. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
topicSpacesConfiguration:
{
Description: Topic spaces configuration information for the namespace resource ,
Required: False ,
}
{
state:
{
Description: Indicate if Topic Spaces Configuration is enabled for the namespace. Default is Disabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
routeTopicResourceId:
{
Description: Fully qualified Azure Resource Id for the Event Grid Topic to which events will be routed to from TopicSpaces under a namespace. This property should be in the following format '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft.EventGrid/topics/{topicName}'. This topic should reside in the same region where namespace is located. ,
Required: False ,
}
string ,
hostname:
{
Description: The endpoint for the topic spaces configuration. This is a read-only property. ,
Required: False ,
}
string ,
routingEnrichments:
{
Description: Routing enrichments for topic spaces configuration ,
Required: False ,
}
{
static:
{
Required: False ,
}
[
{
key:
{
Description: Static routing enrichment key. ,
Required: False ,
}
string ,
valueType:
{
Description: Static routing enrichment value type. For e.g. this property value can be 'String'. ,
Enum:
{
String: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dynamic:
{
Required: False ,
}
[
{
key:
{
Description: Dynamic routing enrichment key. ,
Required: False ,
}
string ,
value:
{
Description: Dynamic routing enrichment value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
clientAuthentication:
{
Description: Client authentication settings for topic spaces configuration. ,
Required: False ,
}
{
alternativeAuthenticationNameSources:
{
Description: Alternative authentication name sources related to client authentication settings for namespace resource. ,
Required: False ,
}
[
string ,
]
,
customJwtAuthentication:
{
Description: Custom JWT authentication settings for namespace resource. ,
Required: False ,
}
{
tokenIssuer:
{
Description: Expected JWT token issuer. ,
Required: False ,
}
string ,
issuerCertificates:
{
Description: Information about the certificates that are used for token validation. We currently support maximum 2 certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: Keyvault certificate URL in https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion format. ,
Required: True ,
}
string ,
identity:
{
Description: The identity that will be used to access the certificate. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
encodedIssuerCertificates:
{
Description: Information about the encoded public certificates that are used for custom authentication. ,
Required: False ,
}
[
{
kid:
{
Description: Identifier for the certificate. ,
Required: True ,
}
string ,
encodedCertificate:
{
Description: Certificate in pem format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
maximumSessionExpiryInHours:
{
Description: The maximum session expiry in hours. The property default value is 1 hour. Min allowed value is 1 hour and max allowed value is 8 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumClientSessionsPerAuthenticationName:
{
Description: The maximum number of sessions per authentication name. The property default value is 1. Min allowed value is 1 and max allowed value is 100. ,
Format: int32 ,
Required: False ,
}
integer ,
routingIdentityInfo:
{
Description: Routing identity info for topic spaces configuration. ,
Required: False ,
}
{
type:
{
Description: Routing identity type for topic spaces configuration. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Required: False ,
}
string ,
}
,
customDomains:
{
Description: List of custom domain configurations for the namespace. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
isZoneRedundant:
{
Description: This is an optional property and it allows the user to specify if the namespace resource supports zone-redundancy capability or not. If this property is not specified explicitly by the user, its default value depends on the following conditions: a. For Availability Zones enabled regions - The default property value would be true. b. For non-Availability Zones enabled regions - The default property value would be false. Once specified, this property cannot be updated. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this namespace. Only TLS version 1.2 is supported. ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Represents available Sku pricing tiers. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Specifies the number of Throughput Units that defines the capacity for the namespace. The property default value is 1 which signifies 1 Throughput Unit = 1MB/s ingress and 2MB/s egress per namespace. Min capacity is 1 and max allowed capacity is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity information for the Namespace resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListSharedAccessKeys (new)
Description :  List the two keys used to publish to a namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/listKeys
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
key1:
{
Description: Shared access key1 for the namespace. ,
Required: False ,
}
string ,
key2:
{
Description: Shared access key2 for the namespace. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_RegenerateKey (new)
Description :  Regenerate a shared access key for a namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/regenerateKey
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the Namespace. ,
Required: True ,
}
string ,
regenerateKeyRequest:
{
Description: Request body to regenerate key. ,
Required: True ,
}
{
keyName:
{
Description: Key name to regenerate key1 or key2. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
key1:
{
Description: Shared access key1 for the namespace. ,
Required: False ,
}
string ,
key2:
{
Description: Shared access key2 for the namespace. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceTopics_Get (new)
Description :  Get properties of a namespace topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the namespace topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the namespace topic. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
publisherType:
{
Description: Publisher type of the namespace topic. ,
Enum:
{
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
inputSchema:
{
Description: This determines the format that is expected for incoming events published to the topic. ,
Enum:
{
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
eventRetentionInDays:
{
Description: Event retention for the namespace topic expressed in days. The property default value is 1 day. Min event retention duration value is 1 day and max event retention duration value is 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceTopics_CreateOrUpdate (new)
Description :  Asynchronously creates a new namespace topic with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the namespace topic. ,
Required: True ,
}
string ,
namespaceTopicInfo:
{
Description: Namespace topic information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the namespace topic. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
publisherType:
{
Description: Publisher type of the namespace topic. ,
Enum:
{
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
inputSchema:
{
Description: This determines the format that is expected for incoming events published to the topic. ,
Enum:
{
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
eventRetentionInDays:
{
Description: Event retention for the namespace topic expressed in days. The property default value is 1 day. Min event retention duration value is 1 day and max event retention duration value is 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the namespace topic. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
publisherType:
{
Description: Publisher type of the namespace topic. ,
Enum:
{
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
inputSchema:
{
Description: This determines the format that is expected for incoming events published to the topic. ,
Enum:
{
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
eventRetentionInDays:
{
Description: Event retention for the namespace topic expressed in days. The property default value is 1 day. Min event retention duration value is 1 day and max event retention duration value is 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the namespace topic. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
publisherType:
{
Description: Publisher type of the namespace topic. ,
Enum:
{
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
inputSchema:
{
Description: This determines the format that is expected for incoming events published to the topic. ,
Enum:
{
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
eventRetentionInDays:
{
Description: Event retention for the namespace topic expressed in days. The property default value is 1 day. Min event retention duration value is 1 day and max event retention duration value is 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceTopics_Delete (new)
Description :  Delete existing namespace topic.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceTopics_Update (new)
Description :  Asynchronously updates a namespace topic with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the namespace topic. ,
Required: True ,
}
string ,
namespaceTopicUpdateParameters:
{
Description: Namespace topic update information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the namespace topic resource. ,
Required: False ,
}
{
eventRetentionInDays:
{
Description: Event retention for the namespace topic expressed in days. The property default value is 1 day. Min event retention duration value is 1 day and max event retention duration value is 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the namespace topic. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
publisherType:
{
Description: Publisher type of the namespace topic. ,
Enum:
{
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
inputSchema:
{
Description: This determines the format that is expected for incoming events published to the topic. ,
Enum:
{
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
eventRetentionInDays:
{
Description: Event retention for the namespace topic expressed in days. The property default value is 1 day. Min event retention duration value is 1 day and max event retention duration value is 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Namespace topic details. ,
}
{
properties:
{
Description: Properties of the namespace topic. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
publisherType:
{
Description: Publisher type of the namespace topic. ,
Enum:
{
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
inputSchema:
{
Description: This determines the format that is expected for incoming events published to the topic. ,
Enum:
{
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
eventRetentionInDays:
{
Description: Event retention for the namespace topic expressed in days. The property default value is 1 day. Min event retention duration value is 1 day and max event retention duration value is 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceTopics_ListByNamespace (new)
Description :  List all the namespace topics under a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of namespace topics. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the namespace topic. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the namespace topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
DeleteFailed: No description available. ,
CreateFailed: No description available. ,
UpdatedFailed: No description available. ,
}
,
Required: False ,
}
enum ,
publisherType:
{
Description: Publisher type of the namespace topic. ,
Enum:
{
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
inputSchema:
{
Description: This determines the format that is expected for incoming events published to the topic. ,
Enum:
{
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
eventRetentionInDays:
{
Description: Event retention for the namespace topic expressed in days. The property default value is 1 day. Min event retention duration value is 1 day and max event retention duration value is 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of namespace topics. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceTopics_ListSharedAccessKeys (new)
Description :  List the two keys used to publish to a namespace topic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/listKeys
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
key1:
{
Description: Shared access key1 for the topic. ,
Required: False ,
}
string ,
key2:
{
Description: Shared access key2 for the topic. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceTopics_RegenerateKey (new)
Description :  Regenerate a shared access key for a namespace topic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/regenerateKey
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the topic. ,
Required: True ,
}
string ,
regenerateKeyRequest:
{
Description: Request body to regenerate key. ,
Required: True ,
}
{
keyName:
{
Description: Key name to regenerate key1 or key2 ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
key1:
{
Description: Shared access key1 for the topic. ,
Required: False ,
}
string ,
key2:
{
Description: Shared access key2 for the topic. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the available operations supported by the Microsoft.EventGrid resource provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.EventGrid/operations
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of operations ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: Display name of the operation. ,
Required: False ,
}
{
provider:
{
Description: Name of the provider ,
Required: False ,
}
string ,
resource:
{
Description: Name of the resource type ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation. ,
Required: False ,
}
string ,
isDataAction:
{
Description: This Boolean is used to determine if the operation is a data plane action or not. ,
Required: False ,
}
boolean ,
properties:
{
Description: Properties of the operation. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{}
PartnerConfigurations_Get (new)
Description :  Get properties of a partner configuration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the partner configuration. ,
Required: False ,
}
{
partnerAuthorization:
{
Description: The details of authorized partners. ,
Required: False ,
}
{
defaultMaximumExpirationTimeInDays:
{
Description: Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days. ,
Format: int32 ,
Required: False ,
}
integer ,
authorizedPartnersList:
{
Description: The list of authorized partners. ,
Required: False ,
}
[
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
partnerName:
{
Description: The partner name. ,
Required: False ,
}
string ,
authorizationExpirationTimeInUtc:
{
Description: Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the partner configuration. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{}
PartnerConfigurations_CreateOrUpdate (new)
Description :  Synchronously creates or updates a partner configuration with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerConfigurationInfo:
{
Description: Partner configuration information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the partner configuration. ,
Required: False ,
}
{
partnerAuthorization:
{
Description: The details of authorized partners. ,
Required: False ,
}
{
defaultMaximumExpirationTimeInDays:
{
Description: Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days. ,
Format: int32 ,
Required: False ,
}
integer ,
authorizedPartnersList:
{
Description: The list of authorized partners. ,
Required: False ,
}
[
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
partnerName:
{
Description: The partner name. ,
Required: False ,
}
string ,
authorizationExpirationTimeInUtc:
{
Description: Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the partner configuration. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the partner configuration. ,
Required: False ,
}
{
partnerAuthorization:
{
Description: The details of authorized partners. ,
Required: False ,
}
{
defaultMaximumExpirationTimeInDays:
{
Description: Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days. ,
Format: int32 ,
Required: False ,
}
integer ,
authorizedPartnersList:
{
Description: The list of authorized partners. ,
Required: False ,
}
[
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
partnerName:
{
Description: The partner name. ,
Required: False ,
}
string ,
authorizationExpirationTimeInUtc:
{
Description: Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the partner configuration. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the partner configuration. ,
Required: False ,
}
{
partnerAuthorization:
{
Description: The details of authorized partners. ,
Required: False ,
}
{
defaultMaximumExpirationTimeInDays:
{
Description: Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days. ,
Format: int32 ,
Required: False ,
}
integer ,
authorizedPartnersList:
{
Description: The list of authorized partners. ,
Required: False ,
}
[
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
partnerName:
{
Description: The partner name. ,
Required: False ,
}
string ,
authorizationExpirationTimeInUtc:
{
Description: Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the partner configuration. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{}
PartnerConfigurations_Delete (new)
Description :  Delete existing partner configuration.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{}
PartnerConfigurations_Update (new)
Description :  Synchronously updates a partner configuration with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerConfigurationUpdateParameters:
{
Description: Partner configuration update information. ,
Required: True ,
}
{
tags:
{
Description: Tags of the partner configuration resource. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the Topic resource. ,
Required: False ,
}
{
defaultMaximumExpirationTimeInDays:
{
Description: The default time used to validate the maximum expiration time for each authorized partners in days. Allowed values ar between 1 and 365 days. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the partner configuration. ,
Required: False ,
}
{
partnerAuthorization:
{
Description: The details of authorized partners. ,
Required: False ,
}
{
defaultMaximumExpirationTimeInDays:
{
Description: Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days. ,
Format: int32 ,
Required: False ,
}
integer ,
authorizedPartnersList:
{
Description: The list of authorized partners. ,
Required: False ,
}
[
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
partnerName:
{
Description: The partner name. ,
Required: False ,
}
string ,
authorizationExpirationTimeInUtc:
{
Description: Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the partner configuration. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the partner configuration. ,
Required: False ,
}
{
partnerAuthorization:
{
Description: The details of authorized partners. ,
Required: False ,
}
{
defaultMaximumExpirationTimeInDays:
{
Description: Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days. ,
Format: int32 ,
Required: False ,
}
integer ,
authorizedPartnersList:
{
Description: The list of authorized partners. ,
Required: False ,
}
[
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
partnerName:
{
Description: The partner name. ,
Required: False ,
}
string ,
authorizationExpirationTimeInUtc:
{
Description: Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the partner configuration. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{}
PartnerConfigurations_ListByResourceGroup (new)
Description :  List all the partner configurations under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of partner configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the partner configuration. ,
Required: False ,
}
{
partnerAuthorization:
{
Description: The details of authorized partners. ,
Required: False ,
}
{
defaultMaximumExpirationTimeInDays:
{
Description: Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days. ,
Format: int32 ,
Required: False ,
}
integer ,
authorizedPartnersList:
{
Description: The list of authorized partners. ,
Required: False ,
}
[
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
partnerName:
{
Description: The partner name. ,
Required: False ,
}
string ,
authorizationExpirationTimeInUtc:
{
Description: Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the partner configuration. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: A link for the next page of partner configurations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
PartnerConfigurations_ListBySubscription (new)
Description :  List all the partner configurations under an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerConfigurations
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of partner configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the partner configuration. ,
Required: False ,
}
{
partnerAuthorization:
{
Description: The details of authorized partners. ,
Required: False ,
}
{
defaultMaximumExpirationTimeInDays:
{
Description: Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days. ,
Format: int32 ,
Required: False ,
}
integer ,
authorizedPartnersList:
{
Description: The list of authorized partners. ,
Required: False ,
}
[
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
partnerName:
{
Description: The partner name. ,
Required: False ,
}
string ,
authorizationExpirationTimeInUtc:
{
Description: Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the partner configuration. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: A link for the next page of partner configurations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
PartnerConfigurations_AuthorizePartner (new)
Description :  Authorize a single partner either by partner registration immutable Id or by partner name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default/authorizePartner
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerInfo:
{
Description: The information of the partner to be authorized. ,
Required: True ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
partnerName:
{
Description: The partner name. ,
Required: False ,
}
string ,
authorizationExpirationTimeInUtc:
{
Description: Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the partner configuration. ,
Required: False ,
}
{
partnerAuthorization:
{
Description: The details of authorized partners. ,
Required: False ,
}
{
defaultMaximumExpirationTimeInDays:
{
Description: Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days. ,
Format: int32 ,
Required: False ,
}
integer ,
authorizedPartnersList:
{
Description: The list of authorized partners. ,
Required: False ,
}
[
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
partnerName:
{
Description: The partner name. ,
Required: False ,
}
string ,
authorizationExpirationTimeInUtc:
{
Description: Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the partner configuration. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{}
PartnerConfigurations_UnauthorizePartner (new)
Description :  Unauthorize a single partner either by partner registration immutable Id or by partner name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default/unauthorizePartner
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerInfo:
{
Description: The information of the partner to be unauthorized. ,
Required: True ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
partnerName:
{
Description: The partner name. ,
Required: False ,
}
string ,
authorizationExpirationTimeInUtc:
{
Description: Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the partner configuration. ,
Required: False ,
}
{
partnerAuthorization:
{
Description: The details of authorized partners. ,
Required: False ,
}
{
defaultMaximumExpirationTimeInDays:
{
Description: Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days. ,
Format: int32 ,
Required: False ,
}
integer ,
authorizedPartnersList:
{
Description: The list of authorized partners. ,
Required: False ,
}
[
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
partnerName:
{
Description: The partner name. ,
Required: False ,
}
string ,
authorizationExpirationTimeInUtc:
{
Description: Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the partner configuration. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{}
PartnerDestinations_Get (new)
Description :  Get properties of a partner destination.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations/{partnerDestinationName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerDestinationName:
{
Description: Name of the partner destination. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Partner Destination. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutable Id of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
endpointServiceContext:
{
Description: Endpoint context associated with this partner destination. ,
Required: False ,
}
string ,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the partner destination. If this timer expires and the partner destination was never activated, the partner destination and corresponding channel are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the partner destination. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredChannelResourceDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: Activation state of the partner destination. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
}
,
Required: False ,
}
enum ,
endpointBaseUrl:
{
Description: Endpoint Base URL of the partner destination ,
Required: False ,
}
string ,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PartnerDestinations_CreateOrUpdate (new)
Description :  Asynchronously creates a new partner destination with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations/{partnerDestinationName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerDestinationName:
{
Description: Name of the partner destination. ,
Required: True ,
}
string ,
partnerDestination:
{
Description: Partner destination create information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Partner Destination. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutable Id of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
endpointServiceContext:
{
Description: Endpoint context associated with this partner destination. ,
Required: False ,
}
string ,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the partner destination. If this timer expires and the partner destination was never activated, the partner destination and corresponding channel are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the partner destination. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredChannelResourceDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: Activation state of the partner destination. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
}
,
Required: False ,
}
enum ,
endpointBaseUrl:
{
Description: Endpoint Base URL of the partner destination ,
Required: False ,
}
string ,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Partner Destination. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutable Id of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
endpointServiceContext:
{
Description: Endpoint context associated with this partner destination. ,
Required: False ,
}
string ,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the partner destination. If this timer expires and the partner destination was never activated, the partner destination and corresponding channel are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the partner destination. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredChannelResourceDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: Activation state of the partner destination. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
}
,
Required: False ,
}
enum ,
endpointBaseUrl:
{
Description: Endpoint Base URL of the partner destination ,
Required: False ,
}
string ,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Partner Destination. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutable Id of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
endpointServiceContext:
{
Description: Endpoint context associated with this partner destination. ,
Required: False ,
}
string ,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the partner destination. If this timer expires and the partner destination was never activated, the partner destination and corresponding channel are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the partner destination. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredChannelResourceDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: Activation state of the partner destination. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
}
,
Required: False ,
}
enum ,
endpointBaseUrl:
{
Description: Endpoint Base URL of the partner destination ,
Required: False ,
}
string ,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PartnerDestinations_Delete (new)
Description :  Delete existing partner destination.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations/{partnerDestinationName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerDestinationName:
{
Description: Name of the partner destination. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PartnerDestinations_Update (new)
Description :  Asynchronously updates a partner destination with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations/{partnerDestinationName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerDestinationName:
{
Description: Name of the partner destination. ,
Required: True ,
}
string ,
partnerDestinationUpdateParameters:
{
Description: Partner destination update information. ,
Required: True ,
}
{
tags:
{
Description: Tags of the Partner Destination resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Partner Destination. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutable Id of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
endpointServiceContext:
{
Description: Endpoint context associated with this partner destination. ,
Required: False ,
}
string ,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the partner destination. If this timer expires and the partner destination was never activated, the partner destination and corresponding channel are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the partner destination. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredChannelResourceDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: Activation state of the partner destination. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
}
,
Required: False ,
}
enum ,
endpointBaseUrl:
{
Description: Endpoint Base URL of the partner destination ,
Required: False ,
}
string ,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Partner Destination. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutable Id of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
endpointServiceContext:
{
Description: Endpoint context associated with this partner destination. ,
Required: False ,
}
string ,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the partner destination. If this timer expires and the partner destination was never activated, the partner destination and corresponding channel are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the partner destination. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredChannelResourceDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: Activation state of the partner destination. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
}
,
Required: False ,
}
enum ,
endpointBaseUrl:
{
Description: Endpoint Base URL of the partner destination ,
Required: False ,
}
string ,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Event Grid Partner Destination. ,
}
{
properties:
{
Description: Properties of the Partner Destination. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutable Id of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
endpointServiceContext:
{
Description: Endpoint context associated with this partner destination. ,
Required: False ,
}
string ,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the partner destination. If this timer expires and the partner destination was never activated, the partner destination and corresponding channel are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the partner destination. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredChannelResourceDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: Activation state of the partner destination. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
}
,
Required: False ,
}
enum ,
endpointBaseUrl:
{
Description: Endpoint Base URL of the partner destination ,
Required: False ,
}
string ,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PartnerDestinations_ListBySubscription (new)
Description :  List all the partner destinations under an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerDestinations
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of partner destinations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Partner Destination. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutable Id of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
endpointServiceContext:
{
Description: Endpoint context associated with this partner destination. ,
Required: False ,
}
string ,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the partner destination. If this timer expires and the partner destination was never activated, the partner destination and corresponding channel are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the partner destination. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredChannelResourceDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: Activation state of the partner destination. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
}
,
Required: False ,
}
enum ,
endpointBaseUrl:
{
Description: Endpoint Base URL of the partner destination ,
Required: False ,
}
string ,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of partner destinations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PartnerDestinations_ListByResourceGroup (new)
Description :  List all the partner destinations under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of partner destinations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Partner Destination. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutable Id of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
endpointServiceContext:
{
Description: Endpoint context associated with this partner destination. ,
Required: False ,
}
string ,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the partner destination. If this timer expires and the partner destination was never activated, the partner destination and corresponding channel are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the partner destination. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredChannelResourceDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: Activation state of the partner destination. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
}
,
Required: False ,
}
enum ,
endpointBaseUrl:
{
Description: Endpoint Base URL of the partner destination ,
Required: False ,
}
string ,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of partner destinations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PartnerDestinations_Activate (new)
Description :  Activate a newly created partner destination.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations/{partnerDestinationName}/activate
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerDestinationName:
{
Description: Name of the partner destination. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Partner Destination. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutable Id of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
endpointServiceContext:
{
Description: Endpoint context associated with this partner destination. ,
Required: False ,
}
string ,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the partner destination. If this timer expires and the partner destination was never activated, the partner destination and corresponding channel are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the partner destination. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredChannelResourceDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: Activation state of the partner destination. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
}
,
Required: False ,
}
enum ,
endpointBaseUrl:
{
Description: Endpoint Base URL of the partner destination ,
Required: False ,
}
string ,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PartnerNamespaces_Get (new)
Description :  Get properties of a partner namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerNamespaceName:
{
Description: Name of the partner namespace. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Partner Namespace. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the partner namespace. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerRegistrationFullyQualifiedId:
{
Description: The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}. ,
Required: False ,
}
string ,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this partner namespace ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint for the partner namespace. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace. ,
Required: False ,
}
boolean ,
partnerTopicRoutingMode:
{
Description: This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic. ,
Enum:
{
SourceEventAttribute: No description available. ,
ChannelNameHeader: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PartnerNamespaces_CreateOrUpdate (new)
Description :  Asynchronously creates a new partner namespace with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerNamespaceName:
{
Description: Name of the partner namespace. ,
Required: True ,
}
string ,
partnerNamespaceInfo:
{
Description: PartnerNamespace information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Partner Namespace. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the partner namespace. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerRegistrationFullyQualifiedId:
{
Description: The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}. ,
Required: False ,
}
string ,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this partner namespace ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint for the partner namespace. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace. ,
Required: False ,
}
boolean ,
partnerTopicRoutingMode:
{
Description: This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic. ,
Enum:
{
SourceEventAttribute: No description available. ,
ChannelNameHeader: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Partner Namespace. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the partner namespace. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerRegistrationFullyQualifiedId:
{
Description: The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}. ,
Required: False ,
}
string ,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this partner namespace ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint for the partner namespace. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace. ,
Required: False ,
}
boolean ,
partnerTopicRoutingMode:
{
Description: This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic. ,
Enum:
{
SourceEventAttribute: No description available. ,
ChannelNameHeader: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PartnerNamespaces_Delete (new)
Description :  Delete existing partner namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerNamespaceName:
{
Description: Name of the partner namespace. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PartnerNamespaces_Update (new)
Description :  Asynchronously updates a partner namespace with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerNamespaceName:
{
Description: Name of the partner namespace. ,
Required: True ,
}
string ,
partnerNamespaceUpdateParameters:
{
Description: Partner namespace update information. ,
Required: True ,
}
{
tags:
{
Description: Tags of the Partner Namespace. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the Partner Namespace. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this domain ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (201)

{
properties:
{
Description: Properties of the Partner Namespace. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the partner namespace. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerRegistrationFullyQualifiedId:
{
Description: The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}. ,
Required: False ,
}
string ,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this partner namespace ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint for the partner namespace. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace. ,
Required: False ,
}
boolean ,
partnerTopicRoutingMode:
{
Description: This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic. ,
Enum:
{
SourceEventAttribute: No description available. ,
ChannelNameHeader: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PartnerNamespaces_ListBySubscription (new)
Description :  List all the partner namespaces under an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerNamespaces
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of partner namespaces. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Partner Namespace. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the partner namespace. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerRegistrationFullyQualifiedId:
{
Description: The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}. ,
Required: False ,
}
string ,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this partner namespace ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint for the partner namespace. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace. ,
Required: False ,
}
boolean ,
partnerTopicRoutingMode:
{
Description: This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic. ,
Enum:
{
SourceEventAttribute: No description available. ,
ChannelNameHeader: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of partner namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PartnerNamespaces_ListByResourceGroup (new)
Description :  List all the partner namespaces under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of partner namespaces. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Partner Namespace. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the partner namespace. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerRegistrationFullyQualifiedId:
{
Description: The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}. ,
Required: False ,
}
string ,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this partner namespace ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint for the partner namespace. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace. ,
Required: False ,
}
boolean ,
partnerTopicRoutingMode:
{
Description: This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic. ,
Enum:
{
SourceEventAttribute: No description available. ,
ChannelNameHeader: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of partner namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PartnerNamespaces_ListSharedAccessKeys (new)
Description :  List the two keys used to publish to a partner namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/listKeys
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerNamespaceName:
{
Description: Name of the partner namespace. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
key1:
{
Description: Shared access key1 for the partner namespace. ,
Required: False ,
}
string ,
key2:
{
Description: Shared access key2 for the partner namespace. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PartnerNamespaces_RegenerateKey (new)
Description :  Regenerate a shared access key for a partner namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/regenerateKey
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerNamespaceName:
{
Description: Name of the partner namespace. ,
Required: True ,
}
string ,
regenerateKeyRequest:
{
Description: Request body to regenerate key. ,
Required: True ,
}
{
keyName:
{
Description: Key name to regenerate (key1 or key2). ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
key1:
{
Description: Shared access key1 for the partner namespace. ,
Required: False ,
}
string ,
key2:
{
Description: Shared access key2 for the partner namespace. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PartnerRegistrations_Get (new)
Description :  Gets a partner registration with the specified parameters.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerRegistrationName:
{
Description: Name of the partner registration. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the partner registration. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the partner registration. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. Note: This property is marked for deprecation and is not supported in any future GA API version ,
Format: uuid ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
PartnerRegistrations_CreateOrUpdate (new)
Description :  Creates a new partner registration with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerRegistrationName:
{
Description: Name of the partner registration. ,
Required: True ,
}
string ,
partnerRegistrationInfo:
{
Description: PartnerRegistration information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the partner registration. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the partner registration. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. Note: This property is marked for deprecation and is not supported in any future GA API version ,
Format: uuid ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the partner registration. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the partner registration. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. Note: This property is marked for deprecation and is not supported in any future GA API version ,
Format: uuid ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Information about a partner registration. ,
}
{
properties:
{
Description: Properties of the partner registration. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the partner registration. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. Note: This property is marked for deprecation and is not supported in any future GA API version ,
Format: uuid ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{}
PartnerRegistrations_Delete (new)
Description :  Deletes a partner registration with the specified parameters.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerRegistrationName:
{
Description: Name of the partner registration. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{}
PartnerRegistrations_Update (new)
Description :  Updates a partner registration with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerRegistrationName:
{
Description: Name of the partner registration. ,
Required: True ,
}
string ,
partnerRegistrationUpdateParameters:
{
Description: Partner registration update information. ,
Required: True ,
}
{
tags:
{
Description: Tags of the partner registration resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (201)

{
properties:
{
Description: Properties of the partner registration. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the partner registration. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. Note: This property is marked for deprecation and is not supported in any future GA API version ,
Format: uuid ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
PartnerRegistrations_ListBySubscription (new)
Description :  List all the partner registrations under an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerRegistrations
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of partner registrations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the partner registration. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the partner registration. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. Note: This property is marked for deprecation and is not supported in any future GA API version ,
Format: uuid ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of partner registrations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
PartnerRegistrations_ListByResourceGroup (new)
Description :  List all the partner registrations under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of partner registrations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the partner registration. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the partner registration. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. Note: This property is marked for deprecation and is not supported in any future GA API version ,
Format: uuid ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of partner registrations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
PartnerTopics_Get (new)
Description :  Get properties of a partner topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerTopicName:
{
Description: Name of the partner topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Partner Topic. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
source:
{
Description: Source associated with this partner topic. This represents a unique partner resource. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type information from the corresponding event channel. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the partner topic. If this timer expires while the partner topic is still never activated, the partner topic and corresponding event channel are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the partner topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredChannelResourceDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: Activation state of the partner topic. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
partnerTopicFriendlyDescription:
{
Description: Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer. ,
Required: False ,
}
string ,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process by the subscriber. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Identity information for the Partner Topic resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{}
PartnerTopics_CreateOrUpdate (new)
Description :  Asynchronously creates a new partner topic with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerTopicName:
{
Description: Name of the partner topic. ,
Required: True ,
}
string ,
partnerTopicInfo:
{
Description: Partner Topic information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Partner Topic. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
source:
{
Description: Source associated with this partner topic. This represents a unique partner resource. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type information from the corresponding event channel. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the partner topic. If this timer expires while the partner topic is still never activated, the partner topic and corresponding event channel are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the partner topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredChannelResourceDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: Activation state of the partner topic. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
partnerTopicFriendlyDescription:
{
Description: Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer. ,
Required: False ,
}
string ,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process by the subscriber. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Identity information for the Partner Topic resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Partner Topic. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
source:
{
Description: Source associated with this partner topic. This represents a unique partner resource. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type information from the corresponding event channel. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the partner topic. If this timer expires while the partner topic is still never activated, the partner topic and corresponding event channel are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the partner topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredChannelResourceDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: Activation state of the partner topic. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
partnerTopicFriendlyDescription:
{
Description: Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer. ,
Required: False ,
}
string ,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process by the subscriber. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Identity information for the Partner Topic resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Partner Topic. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
source:
{
Description: Source associated with this partner topic. This represents a unique partner resource. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type information from the corresponding event channel. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the partner topic. If this timer expires while the partner topic is still never activated, the partner topic and corresponding event channel are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the partner topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredChannelResourceDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: Activation state of the partner topic. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
partnerTopicFriendlyDescription:
{
Description: Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer. ,
Required: False ,
}
string ,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process by the subscriber. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Identity information for the Partner Topic resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{}
PartnerTopics_Delete (new)
Description :  Delete existing partner topic.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerTopicName:
{
Description: Name of the partner topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{}
PartnerTopics_Update (new)
Description :  Asynchronously updates a partner topic with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerTopicName:
{
Description: Name of the partner topic. ,
Required: True ,
}
string ,
partnerTopicUpdateParameters:
{
Description: PartnerTopic update information. ,
Required: True ,
}
{
tags:
{
Description: Tags of the Partner Topic resource. ,
Required: False ,
}
object ,
identity:
{
Description: Identity information for the Partner Topic resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (201)

{
properties:
{
Description: Properties of the Partner Topic. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
source:
{
Description: Source associated with this partner topic. This represents a unique partner resource. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type information from the corresponding event channel. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the partner topic. If this timer expires while the partner topic is still never activated, the partner topic and corresponding event channel are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the partner topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredChannelResourceDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: Activation state of the partner topic. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
partnerTopicFriendlyDescription:
{
Description: Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer. ,
Required: False ,
}
string ,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process by the subscriber. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Identity information for the Partner Topic resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{}
PartnerTopics_ListBySubscription (new)
Description :  List all the partner topics under an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerTopics
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of partner topics. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Partner Topic. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
source:
{
Description: Source associated with this partner topic. This represents a unique partner resource. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type information from the corresponding event channel. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the partner topic. If this timer expires while the partner topic is still never activated, the partner topic and corresponding event channel are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the partner topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredChannelResourceDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: Activation state of the partner topic. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
partnerTopicFriendlyDescription:
{
Description: Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer. ,
Required: False ,
}
string ,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process by the subscriber. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Identity information for the Partner Topic resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of partner topics. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
PartnerTopics_ListByResourceGroup (new)
Description :  List all the partner topics under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of partner topics. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Partner Topic. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
source:
{
Description: Source associated with this partner topic. This represents a unique partner resource. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type information from the corresponding event channel. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the partner topic. If this timer expires while the partner topic is still never activated, the partner topic and corresponding event channel are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the partner topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredChannelResourceDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: Activation state of the partner topic. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
partnerTopicFriendlyDescription:
{
Description: Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer. ,
Required: False ,
}
string ,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process by the subscriber. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Identity information for the Partner Topic resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of partner topics. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
PartnerTopics_Activate (new)
Description :  Activate a newly created partner topic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/activate
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerTopicName:
{
Description: Name of the partner topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Partner Topic. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
source:
{
Description: Source associated with this partner topic. This represents a unique partner resource. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type information from the corresponding event channel. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the partner topic. If this timer expires while the partner topic is still never activated, the partner topic and corresponding event channel are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the partner topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredChannelResourceDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: Activation state of the partner topic. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
partnerTopicFriendlyDescription:
{
Description: Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer. ,
Required: False ,
}
string ,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process by the subscriber. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Identity information for the Partner Topic resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{}
PartnerTopics_Deactivate (new)
Description :  Deactivate specific partner topic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/deactivate
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
partnerTopicName:
{
Description: Name of the partner topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Partner Topic. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: The immutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
source:
{
Description: Source associated with this partner topic. This represents a unique partner resource. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type information from the corresponding event channel. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
expirationTimeIfNotActivatedUtc:
{
Description: Expiration time of the partner topic. If this timer expires while the partner topic is still never activated, the partner topic and corresponding event channel are deleted. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the partner topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
IdleDueToMirroredChannelResourceDeletion: No description available. ,
}
,
Required: False ,
}
enum ,
activationState:
{
Description: Activation state of the partner topic. ,
Enum:
{
NeverActivated: No description available. ,
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
partnerTopicFriendlyDescription:
{
Description: Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer. ,
Required: False ,
}
string ,
messageForActivation:
{
Description: Context or helpful message that can be used during the approval process by the subscriber. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Identity information for the Partner Topic resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{}
NetworkSecurityPerimeterConfigurations_Get (new)
Description :  Get a specific network security perimeter configuration with a topic or domain.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{resourceType}/{resourceName}/networkSecurityPerimeterConfigurations/{perimeterGuid}.{associationName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. This can be either \'topics\', or \'domains\'. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource (namely, either, the topic name or domain name). ,
Required: True ,
}
string ,
perimeterGuid:
{
Description: Unique identifier for perimeter ,
Required: True ,
}
string ,
associationName:
{
Description: Association name to association network security perimeter resource to profile ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the network security perimeter configuration. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to reflect configuration state and indicate status of nsp profile configuration retrieval. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: Provisioning issues to reflect status when attempting to retrieve nsp profile configuration. ,
Required: False ,
}
[
{
name:
{
Description: Provisioning issue name. ,
Required: False ,
}
string ,
properties:
{
Description: Provisioning issue properties. ,
Required: False ,
}
{
issueType:
{
Description: Provisioning issue type. ,
Enum:
{
MissingPerimeterConfiguration: No description available. ,
MissingIdentityConfiguration: No description available. ,
ConfigurationPropagationFailure: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Provisioning issue severity. ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Provisioning issue description. ,
Required: False ,
}
string ,
suggestedResourceIds:
{
Description: ARM IDs of resources that can be associated to the same perimeter to remediate the issue. ,
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Description: Access rules that can be added to the same profile to remediate the issue. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: Perimeter info for nsp association. ,
Required: False ,
}
{
id:
{
Description: Arm id for network security perimeter. ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Network security perimeter guid. ,
Required: False ,
}
string ,
location:
{
Description: Network security perimeter location. ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Nsp association name and access mode of association. ,
Required: False ,
}
{
name:
{
Description: Association name ,
Required: False ,
}
string ,
accessMode:
{
Description: Network security perimeter access mode. ,
Enum:
{
Learning: No description available. ,
Enforced: No description available. ,
Audit: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Nsp profile configuration, access rules and diagnostic settings. ,
Required: False ,
}
{
name:
{
Description: Nsp configuration profile name. ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Access rules version number for nsp profile. ,
Required: False ,
}
string ,
accessRules:
{
Description: List of inbound or outbound access rule setup on the nsp profile. ,
Required: False ,
}
[
{
fullyQualifiedArmId:
{
Description: Fully Qualified Arm id for network security perimeter profile access rule. ,
Required: False ,
}
string ,
name:
{
Description: Name for nsp access rule. ,
Required: False ,
}
string ,
type:
{
Description: nsp access rule type. ,
Required: False ,
}
string ,
properties:
{
Description: NSP access rule properties. ,
Required: False ,
}
{
direction:
{
Description: NSP access rule direction. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes. ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: List of subscriptions. ,
Required: False ,
}
[
{
id:
{
Description: Subscription id. ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: Network security perimeters. ,
Required: False ,
}
[
{
id:
{
Description: Arm id for network security perimeter. ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Network security perimeter guid. ,
Required: False ,
}
string ,
location:
{
Description: Network security perimeter location. ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: Fully qualified domain names. ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: List of email addresses. ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: List of phone numbers. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Diagnostic settings version number for nsp profile. ,
Required: False ,
}
string ,
enabledLogCategories:
{
Description: Enabled log categories for nsp profile. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfigurations_Reconcile (new)
Description :  Reconcile a specific network security perimeter configuration for a given network security perimeter association with a topic or domain.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{resourceType}/{resourceName}/networkSecurityPerimeterConfigurations/{perimeterGuid}.{associationName}/reconcile
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. This can be either \'topics\' or \'domains\'. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource (namely, either, the topic name or domain name). ,
Required: True ,
}
string ,
perimeterGuid:
{
Description: Unique identifier for perimeter ,
Required: True ,
}
string ,
associationName:
{
Description: Association name to association network security perimeter resource to profile ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the network security perimeter configuration. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to reflect configuration state and indicate status of nsp profile configuration retrieval. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: Provisioning issues to reflect status when attempting to retrieve nsp profile configuration. ,
Required: False ,
}
[
{
name:
{
Description: Provisioning issue name. ,
Required: False ,
}
string ,
properties:
{
Description: Provisioning issue properties. ,
Required: False ,
}
{
issueType:
{
Description: Provisioning issue type. ,
Enum:
{
MissingPerimeterConfiguration: No description available. ,
MissingIdentityConfiguration: No description available. ,
ConfigurationPropagationFailure: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Provisioning issue severity. ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Provisioning issue description. ,
Required: False ,
}
string ,
suggestedResourceIds:
{
Description: ARM IDs of resources that can be associated to the same perimeter to remediate the issue. ,
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Description: Access rules that can be added to the same profile to remediate the issue. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: Perimeter info for nsp association. ,
Required: False ,
}
{
id:
{
Description: Arm id for network security perimeter. ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Network security perimeter guid. ,
Required: False ,
}
string ,
location:
{
Description: Network security perimeter location. ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Nsp association name and access mode of association. ,
Required: False ,
}
{
name:
{
Description: Association name ,
Required: False ,
}
string ,
accessMode:
{
Description: Network security perimeter access mode. ,
Enum:
{
Learning: No description available. ,
Enforced: No description available. ,
Audit: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Nsp profile configuration, access rules and diagnostic settings. ,
Required: False ,
}
{
name:
{
Description: Nsp configuration profile name. ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Access rules version number for nsp profile. ,
Required: False ,
}
string ,
accessRules:
{
Description: List of inbound or outbound access rule setup on the nsp profile. ,
Required: False ,
}
[
{
fullyQualifiedArmId:
{
Description: Fully Qualified Arm id for network security perimeter profile access rule. ,
Required: False ,
}
string ,
name:
{
Description: Name for nsp access rule. ,
Required: False ,
}
string ,
type:
{
Description: nsp access rule type. ,
Required: False ,
}
string ,
properties:
{
Description: NSP access rule properties. ,
Required: False ,
}
{
direction:
{
Description: NSP access rule direction. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes. ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: List of subscriptions. ,
Required: False ,
}
[
{
id:
{
Description: Subscription id. ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: Network security perimeters. ,
Required: False ,
}
[
{
id:
{
Description: Arm id for network security perimeter. ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Network security perimeter guid. ,
Required: False ,
}
string ,
location:
{
Description: Network security perimeter location. ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: Fully qualified domain names. ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: List of email addresses. ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: List of phone numbers. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Diagnostic settings version number for nsp profile. ,
Required: False ,
}
string ,
enabledLogCategories:
{
Description: Enabled log categories for nsp profile. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfigurations_List (new)
Description :  Get all network security perimeter configurations associated with a topic or domain.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{resourceType}/{resourceName}/networkSecurityPerimeterConfigurations
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. This can be either \'topics\' or \'domains\'. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource (namely, either, the topic name or domain name). ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of all network security parameter configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the network security perimeter configuration. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to reflect configuration state and indicate status of nsp profile configuration retrieval. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: Provisioning issues to reflect status when attempting to retrieve nsp profile configuration. ,
Required: False ,
}
[
{
name:
{
Description: Provisioning issue name. ,
Required: False ,
}
string ,
properties:
{
Description: Provisioning issue properties. ,
Required: False ,
}
{
issueType:
{
Description: Provisioning issue type. ,
Enum:
{
MissingPerimeterConfiguration: No description available. ,
MissingIdentityConfiguration: No description available. ,
ConfigurationPropagationFailure: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Provisioning issue severity. ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Provisioning issue description. ,
Required: False ,
}
string ,
suggestedResourceIds:
{
Description: ARM IDs of resources that can be associated to the same perimeter to remediate the issue. ,
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Description: Access rules that can be added to the same profile to remediate the issue. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: Perimeter info for nsp association. ,
Required: False ,
}
{
id:
{
Description: Arm id for network security perimeter. ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Network security perimeter guid. ,
Required: False ,
}
string ,
location:
{
Description: Network security perimeter location. ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Nsp association name and access mode of association. ,
Required: False ,
}
{
name:
{
Description: Association name ,
Required: False ,
}
string ,
accessMode:
{
Description: Network security perimeter access mode. ,
Enum:
{
Learning: No description available. ,
Enforced: No description available. ,
Audit: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Nsp profile configuration, access rules and diagnostic settings. ,
Required: False ,
}
{
name:
{
Description: Nsp configuration profile name. ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Access rules version number for nsp profile. ,
Required: False ,
}
string ,
accessRules:
{
Description: List of inbound or outbound access rule setup on the nsp profile. ,
Required: False ,
}
[
{
fullyQualifiedArmId:
{
Description: Fully Qualified Arm id for network security perimeter profile access rule. ,
Required: False ,
}
string ,
name:
{
Description: Name for nsp access rule. ,
Required: False ,
}
string ,
type:
{
Description: nsp access rule type. ,
Required: False ,
}
string ,
properties:
{
Description: NSP access rule properties. ,
Required: False ,
}
{
direction:
{
Description: NSP access rule direction. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes. ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: List of subscriptions. ,
Required: False ,
}
[
{
id:
{
Description: Subscription id. ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: Network security perimeters. ,
Required: False ,
}
[
{
id:
{
Description: Arm id for network security perimeter. ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Network security perimeter guid. ,
Required: False ,
}
string ,
location:
{
Description: Network security perimeter location. ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: Fully qualified domain names. ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: List of email addresses. ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: List of phone numbers. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Diagnostic settings version number for nsp profile. ,
Required: False ,
}
string ,
enabledLogCategories:
{
Description: Enabled log categories for nsp profile. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of Network Security Perimeter Configuration. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PermissionBindings_Get (new)
Description :  Get properties of a permission binding.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/permissionBindings/{permissionBindingName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
permissionBindingName:
{
Description: Name of the permission binding. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of permission binding. ,
Required: False ,
}
{
description:
{
Description: Description for the Permission Binding resource. ,
Required: False ,
}
string ,
topicSpaceName:
{
Description: The name of the Topic Space resource that the permission is bound to. The Topic space needs to be a resource under the same namespace the permission binding is a part of. ,
Required: False ,
}
string ,
permission:
{
Description: The allowed permission. ,
Enum:
{
Publisher: No description available. ,
Subscriber: No description available. ,
}
,
Required: False ,
}
enum ,
clientGroupName:
{
Description: The name of the client group resource that the permission is bound to. The client group needs to be a resource under the same namespace the permission binding is a part of. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the PermissionBinding resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PermissionBindings_CreateOrUpdate (new)
Description :  Create or update a permission binding with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/permissionBindings/{permissionBindingName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
permissionBindingName:
{
Description: The permission binding name. ,
Required: True ,
}
string ,
permissionBindingInfo:
{
Description: Permission binding information. ,
Required: True ,
}
{
properties:
{
Description: The properties of permission binding. ,
Required: False ,
}
{
description:
{
Description: Description for the Permission Binding resource. ,
Required: False ,
}
string ,
topicSpaceName:
{
Description: The name of the Topic Space resource that the permission is bound to. The Topic space needs to be a resource under the same namespace the permission binding is a part of. ,
Required: False ,
}
string ,
permission:
{
Description: The allowed permission. ,
Enum:
{
Publisher: No description available. ,
Subscriber: No description available. ,
}
,
Required: False ,
}
enum ,
clientGroupName:
{
Description: The name of the client group resource that the permission is bound to. The client group needs to be a resource under the same namespace the permission binding is a part of. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the PermissionBinding resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of permission binding. ,
Required: False ,
}
{
description:
{
Description: Description for the Permission Binding resource. ,
Required: False ,
}
string ,
topicSpaceName:
{
Description: The name of the Topic Space resource that the permission is bound to. The Topic space needs to be a resource under the same namespace the permission binding is a part of. ,
Required: False ,
}
string ,
permission:
{
Description: The allowed permission. ,
Enum:
{
Publisher: No description available. ,
Subscriber: No description available. ,
}
,
Required: False ,
}
enum ,
clientGroupName:
{
Description: The name of the client group resource that the permission is bound to. The client group needs to be a resource under the same namespace the permission binding is a part of. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the PermissionBinding resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of permission binding. ,
Required: False ,
}
{
description:
{
Description: Description for the Permission Binding resource. ,
Required: False ,
}
string ,
topicSpaceName:
{
Description: The name of the Topic Space resource that the permission is bound to. The Topic space needs to be a resource under the same namespace the permission binding is a part of. ,
Required: False ,
}
string ,
permission:
{
Description: The allowed permission. ,
Enum:
{
Publisher: No description available. ,
Subscriber: No description available. ,
}
,
Required: False ,
}
enum ,
clientGroupName:
{
Description: The name of the client group resource that the permission is bound to. The client group needs to be a resource under the same namespace the permission binding is a part of. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the PermissionBinding resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PermissionBindings_Delete (new)
Description :  Delete an existing permission binding.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/permissionBindings/{permissionBindingName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
permissionBindingName:
{
Description: Name of the permission binding. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PermissionBindings_ListByNamespace (new)
Description :  Get all the permission bindings under a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/permissionBindings
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of Permission Binding. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of permission binding. ,
Required: False ,
}
{
description:
{
Description: Description for the Permission Binding resource. ,
Required: False ,
}
string ,
topicSpaceName:
{
Description: The name of the Topic Space resource that the permission is bound to. The Topic space needs to be a resource under the same namespace the permission binding is a part of. ,
Required: False ,
}
string ,
permission:
{
Description: The allowed permission. ,
Enum:
{
Publisher: No description available. ,
Subscriber: No description available. ,
}
,
Required: False ,
}
enum ,
clientGroupName:
{
Description: The name of the client group resource that the permission is bound to. The client group needs to be a resource under the same namespace the permission binding is a part of. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the PermissionBinding resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of Permission Binding. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Get a specific private endpoint connection under a topic, domain, or partner namespace or namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
parentType:
{
Description: The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\' or \'namespaces\'. ,
Required: True ,
}
string ,
parentName:
{
Description: The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name or namespace name). ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection connection. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{}
PrivateEndpointConnections_Update (new)
Description :  Update a specific private endpoint connection under a topic, domain or partner namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
parentType:
{
Description: The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\' or \'namespaces\'. ,
Required: True ,
}
string ,
parentName:
{
Description: The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name or namespace name). ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection connection. ,
Required: True ,
}
string ,
privateEndpointConnection:
{
Description: The private endpoint connection object to update. ,
Required: True ,
}
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{}
PrivateEndpointConnections_Delete (new)
Description :  Delete a specific private endpoint connection under a topic, domain, or partner namespace or namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
parentType:
{
Description: The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\' or \'namespaces\'. ,
Required: True ,
}
string ,
parentName:
{
Description: The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name or namespace name). ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection connection. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{}
PrivateEndpointConnections_ListByResource (new)
Description :  Get all private endpoint connections under a topic, domain, or partner namespace or namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
parentType:
{
Description: The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\' or \'namespaces\'. ,
Required: True ,
}
string ,
parentName:
{
Description: The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name or namespace name). ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of private endpoint connection resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of private endpoint connection resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
PrivateLinkResources_Get (new)
Description :  Get properties of a private link resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateLinkResources/{privateLinkResourceName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
parentType:
{
Description: The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\' or \'namespaces\'. ,
Required: True ,
}
string ,
parentName:
{
Description: The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name or namespace name). ,
Required: True ,
}
string ,
privateLinkResourceName:
{
Description: The name of private link resource will be either topic, domain, partnerNamespace or namespace. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the private link resource. ,
Required: False ,
}
{
groupId:
{
Required: False ,
}
string ,
displayName:
{
Required: False ,
}
string ,
requiredMembers:
{
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Required: False ,
}
[
string ,
]
,
}
,
id:
{
Description: Fully qualified identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
PrivateLinkResources_ListByResource (new)
Description :  List all the private link resources under a topic, domain, or partner namespace or namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateLinkResources
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
parentType:
{
Description: The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\' or \'namespaces\'. ,
Required: True ,
}
string ,
parentName:
{
Description: The name of the parent resource (namely, either, the topic name, domain name, or partner namespace or namespace name). ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link resource. ,
Required: False ,
}
{
groupId:
{
Required: False ,
}
string ,
displayName:
{
Required: False ,
}
string ,
requiredMembers:
{
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Required: False ,
}
[
string ,
]
,
}
,
id:
{
Description: Fully qualified identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: A link for the next page of private link resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
SystemTopics_Get (new)
Description :  Get properties of a system topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
systemTopicName:
{
Description: Name of the system topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the system topic. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the system topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source for the system topic. ,
Required: False ,
}
string ,
topicType:
{
Description: TopicType for the system topic. ,
Required: False ,
}
string ,
metricResourceId:
{
Description: Metric resource id for the system topic. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Identity information for the resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{}
SystemTopics_CreateOrUpdate (new)
Description :  Asynchronously creates a new system topic with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
systemTopicName:
{
Description: Name of the system topic. ,
Required: True ,
}
string ,
systemTopicInfo:
{
Description: System Topic information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the system topic. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the system topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source for the system topic. ,
Required: False ,
}
string ,
topicType:
{
Description: TopicType for the system topic. ,
Required: False ,
}
string ,
metricResourceId:
{
Description: Metric resource id for the system topic. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Identity information for the resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the system topic. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the system topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source for the system topic. ,
Required: False ,
}
string ,
topicType:
{
Description: TopicType for the system topic. ,
Required: False ,
}
string ,
metricResourceId:
{
Description: Metric resource id for the system topic. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Identity information for the resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the system topic. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the system topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source for the system topic. ,
Required: False ,
}
string ,
topicType:
{
Description: TopicType for the system topic. ,
Required: False ,
}
string ,
metricResourceId:
{
Description: Metric resource id for the system topic. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Identity information for the resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{}
SystemTopics_Delete (new)
Description :  Delete existing system topic.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
systemTopicName:
{
Description: Name of the system topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{}
SystemTopics_Update (new)
Description :  Asynchronously updates a system topic with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
systemTopicName:
{
Description: Name of the system topic. ,
Required: True ,
}
string ,
systemTopicUpdateParameters:
{
Description: SystemTopic update information. ,
Required: True ,
}
{
tags:
{
Description: Tags of the system topic. ,
Required: False ,
}
object ,
identity:
{
Description: Resource identity information. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the system topic. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the system topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source for the system topic. ,
Required: False ,
}
string ,
topicType:
{
Description: TopicType for the system topic. ,
Required: False ,
}
string ,
metricResourceId:
{
Description: Metric resource id for the system topic. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Identity information for the resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the system topic. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the system topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source for the system topic. ,
Required: False ,
}
string ,
topicType:
{
Description: TopicType for the system topic. ,
Required: False ,
}
string ,
metricResourceId:
{
Description: Metric resource id for the system topic. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Identity information for the resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{}
SystemTopics_ListBySubscription (new)
Description :  List all the system topics under an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/systemTopics
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of system Topics. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the system topic. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the system topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source for the system topic. ,
Required: False ,
}
string ,
topicType:
{
Description: TopicType for the system topic. ,
Required: False ,
}
string ,
metricResourceId:
{
Description: Metric resource id for the system topic. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Identity information for the resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of topics. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
SystemTopics_ListByResourceGroup (new)
Description :  List all the system topics under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of system Topics. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the system topic. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the system topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source for the system topic. ,
Required: False ,
}
string ,
topicType:
{
Description: TopicType for the system topic. ,
Required: False ,
}
string ,
metricResourceId:
{
Description: Metric resource id for the system topic. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Identity information for the resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of topics. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
Topics_Get (new)
Description :  Get properties of a topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the topic. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint for the topic. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type Information for the user topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this topic ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
inputSchema:
{
Description: This determines the format that Event Grid should expect for incoming events published to the topic. ,
Enum:
{
EventGridSchema: No description available. ,
CustomEventSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
inputSchemaMapping:
{
Description: 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. ,
Required: False ,
}
{
inputSchemaMappingType:
{
Description: Type of the custom mapping ,
Enum:
{
Json: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
metricResourceId:
{
Description: Metric resource id for the topic. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic. ,
Required: False ,
}
boolean ,
dataResidencyBoundary:
{
Description: Data Residency Boundary of the resource. ,
Enum:
{
WithinGeopair: No description available. ,
WithinRegion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The Sku pricing tier for the topic. ,
Required: False ,
}
{
name:
{
Description: The Sku name of the resource. The possible values are: Basic or Premium. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity information for the resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: Kind of the resource. ,
Enum:
{
Azure: No description available. ,
AzureArc: No description available. ,
}
,
Required: False ,
}
enum ,
extendedLocation:
{
Description: Extended location of the resource. ,
Required: False ,
}
{
name:
{
Description: Fully qualified name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extended location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
Topics_CreateOrUpdate (new)
Description :  Asynchronously creates a new topic with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the topic. ,
Required: True ,
}
string ,
topicInfo:
{
Description: Topic information. ,
Required: True ,
}
{
properties:
{
Description: Properties of the topic. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint for the topic. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type Information for the user topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this topic ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
inputSchema:
{
Description: This determines the format that Event Grid should expect for incoming events published to the topic. ,
Enum:
{
EventGridSchema: No description available. ,
CustomEventSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
inputSchemaMapping:
{
Description: 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. ,
Required: False ,
}
{
inputSchemaMappingType:
{
Description: Type of the custom mapping ,
Enum:
{
Json: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
metricResourceId:
{
Description: Metric resource id for the topic. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic. ,
Required: False ,
}
boolean ,
dataResidencyBoundary:
{
Description: Data Residency Boundary of the resource. ,
Enum:
{
WithinGeopair: No description available. ,
WithinRegion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The Sku pricing tier for the topic. ,
Required: False ,
}
{
name:
{
Description: The Sku name of the resource. The possible values are: Basic or Premium. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity information for the resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: Kind of the resource. ,
Enum:
{
Azure: No description available. ,
AzureArc: No description available. ,
}
,
Required: False ,
}
enum ,
extendedLocation:
{
Description: Extended location of the resource. ,
Required: False ,
}
{
name:
{
Description: Fully qualified name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extended location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the topic. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint for the topic. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type Information for the user topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this topic ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
inputSchema:
{
Description: This determines the format that Event Grid should expect for incoming events published to the topic. ,
Enum:
{
EventGridSchema: No description available. ,
CustomEventSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
inputSchemaMapping:
{
Description: 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. ,
Required: False ,
}
{
inputSchemaMappingType:
{
Description: Type of the custom mapping ,
Enum:
{
Json: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
metricResourceId:
{
Description: Metric resource id for the topic. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic. ,
Required: False ,
}
boolean ,
dataResidencyBoundary:
{
Description: Data Residency Boundary of the resource. ,
Enum:
{
WithinGeopair: No description available. ,
WithinRegion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The Sku pricing tier for the topic. ,
Required: False ,
}
{
name:
{
Description: The Sku name of the resource. The possible values are: Basic or Premium. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity information for the resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: Kind of the resource. ,
Enum:
{
Azure: No description available. ,
AzureArc: No description available. ,
}
,
Required: False ,
}
enum ,
extendedLocation:
{
Description: Extended location of the resource. ,
Required: False ,
}
{
name:
{
Description: Fully qualified name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extended location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
Topics_Delete (new)
Description :  Delete existing topic.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{}
Topics_Update (new)
Description :  Asynchronously updates a topic with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the topic. ,
Required: True ,
}
string ,
topicUpdateParameters:
{
Description: Topic update information. ,
Required: True ,
}
{
tags:
{
Description: Tags of the Topic resource. ,
Required: False ,
}
object ,
identity:
{
Description: Topic resource identity information. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of the Topic resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this domain ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic. ,
Required: False ,
}
boolean ,
dataResidencyBoundary:
{
Description: The data residency boundary for the topic. ,
Enum:
{
WithinGeopair: No description available. ,
WithinRegion: No description available. ,
}
,
Required: False ,
}
enum ,
eventTypeInfo:
{
Description: The eventTypeInfo for the topic. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
sku:
{
Description: The Sku pricing tier for the topic. ,
Required: False ,
}
{
name:
{
Description: The Sku name of the resource. The possible values are: Basic or Premium. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (201)

{
properties:
{
Description: Properties of the topic. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint for the topic. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type Information for the user topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this topic ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
inputSchema:
{
Description: This determines the format that Event Grid should expect for incoming events published to the topic. ,
Enum:
{
EventGridSchema: No description available. ,
CustomEventSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
inputSchemaMapping:
{
Description: 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. ,
Required: False ,
}
{
inputSchemaMappingType:
{
Description: Type of the custom mapping ,
Enum:
{
Json: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
metricResourceId:
{
Description: Metric resource id for the topic. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic. ,
Required: False ,
}
boolean ,
dataResidencyBoundary:
{
Description: Data Residency Boundary of the resource. ,
Enum:
{
WithinGeopair: No description available. ,
WithinRegion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The Sku pricing tier for the topic. ,
Required: False ,
}
{
name:
{
Description: The Sku name of the resource. The possible values are: Basic or Premium. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity information for the resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: Kind of the resource. ,
Enum:
{
Azure: No description available. ,
AzureArc: No description available. ,
}
,
Required: False ,
}
enum ,
extendedLocation:
{
Description: Extended location of the resource. ,
Required: False ,
}
{
name:
{
Description: Fully qualified name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extended location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
Topics_ListBySubscription (new)
Description :  List all the topics under an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topics
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of Topics ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the topic. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint for the topic. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type Information for the user topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this topic ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
inputSchema:
{
Description: This determines the format that Event Grid should expect for incoming events published to the topic. ,
Enum:
{
EventGridSchema: No description available. ,
CustomEventSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
inputSchemaMapping:
{
Description: 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. ,
Required: False ,
}
{
inputSchemaMappingType:
{
Description: Type of the custom mapping ,
Enum:
{
Json: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
metricResourceId:
{
Description: Metric resource id for the topic. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic. ,
Required: False ,
}
boolean ,
dataResidencyBoundary:
{
Description: Data Residency Boundary of the resource. ,
Enum:
{
WithinGeopair: No description available. ,
WithinRegion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The Sku pricing tier for the topic. ,
Required: False ,
}
{
name:
{
Description: The Sku name of the resource. The possible values are: Basic or Premium. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity information for the resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: Kind of the resource. ,
Enum:
{
Azure: No description available. ,
AzureArc: No description available. ,
}
,
Required: False ,
}
enum ,
extendedLocation:
{
Description: Extended location of the resource. ,
Required: False ,
}
{
name:
{
Description: Fully qualified name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extended location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of topics ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
Topics_ListByResourceGroup (new)
Description :  List all the topics under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of Topics ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the topic. ,
Required: False ,
}
{
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required (if any). ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the topic. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint for the topic. ,
Required: False ,
}
string ,
eventTypeInfo:
{
Description: Event Type Information for the user topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published. ,
Required: False ,
}
{
kind:
{
Description: The kind of event type used. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
inlineEventTypes:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
minimumTlsVersionAllowed:
{
Description: Minimum TLS version of the publisher allowed to publish to this topic ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
inputSchema:
{
Description: This determines the format that Event Grid should expect for incoming events published to the topic. ,
Enum:
{
EventGridSchema: No description available. ,
CustomEventSchema: No description available. ,
CloudEventSchemaV1_0: No description available. ,
}
,
Required: False ,
}
enum ,
inputSchemaMapping:
{
Description: 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. ,
Required: False ,
}
{
inputSchemaMappingType:
{
Description: Type of the custom mapping ,
Enum:
{
Json: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
metricResourceId:
{
Description: Metric resource id for the topic. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
inboundIpRules:
{
Description: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Address in CIDR notation e.g., 10.0.0.0/8. ,
Required: False ,
}
string ,
action:
{
Description: Action to perform based on the match or no match of the IpMask. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
disableLocalAuth:
{
Description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic. ,
Required: False ,
}
boolean ,
dataResidencyBoundary:
{
Description: Data Residency Boundary of the resource. ,
Enum:
{
WithinGeopair: No description available. ,
WithinRegion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The Sku pricing tier for the topic. ,
Required: False ,
}
{
name:
{
Description: The Sku name of the resource. The possible values are: Basic or Premium. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity information for the resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: Kind of the resource. ,
Enum:
{
Azure: No description available. ,
AzureArc: No description available. ,
}
,
Required: False ,
}
enum ,
extendedLocation:
{
Description: Extended location of the resource. ,
Required: False ,
}
{
name:
{
Description: Fully qualified name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extended location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of topics ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
Topics_ListSharedAccessKeys (new)
Description :  List the two keys used to publish to a topic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/listKeys
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
key1:
{
Description: Shared access key1 for the topic. ,
Required: False ,
}
string ,
key2:
{
Description: Shared access key2 for the topic. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
Topics_RegenerateKey (new)
Description :  Regenerate a shared access key for a topic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/regenerateKey
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the topic. ,
Required: True ,
}
string ,
regenerateKeyRequest:
{
Description: Request body to regenerate key. ,
Required: True ,
}
{
keyName:
{
Description: Key name to regenerate key1 or key2 ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
key1:
{
Description: Shared access key1 for the topic. ,
Required: False ,
}
string ,
key2:
{
Description: Shared access key2 for the topic. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{}
Topics_ListEventTypes (new)
Description :  List event types for a topic.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventTypes
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
providerNamespace:
{
Description: Namespace of the provider of the topic. ,
Required: True ,
}
string ,
resourceTypeName:
{
Description: Name of the topic type. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the topic. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of event types ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the event type. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the event type. ,
Required: False ,
}
string ,
description:
{
Description: Description of the event type. ,
Required: False ,
}
string ,
schemaUrl:
{
Description: URL of the schema for this event type. ,
Required: False ,
}
string ,
isInDefaultSet:
{
Description: IsInDefaultSet flag of the event type. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
}

⚐ Response (default)

{}
ExtensionTopics_Get (new)
Description :  Get the properties of an extension topic.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.EventGrid/extensionTopics/default
{
scope:
{
Description: The identifier of the resource to which extension topic is queried. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for Azure resource. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the extension topic. ,
Required: False ,
}
{
description:
{
Description: Description of the extension topic. ,
Required: False ,
}
string ,
systemTopic:
{
Description: System topic resource id which is mapped to the source. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
TopicSpaces_Get (new)
Description :  Get properties of a topic space.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topicSpaces/{topicSpaceName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
topicSpaceName:
{
Description: Name of the Topic space. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of topic space. ,
Required: False ,
}
{
description:
{
Description: Description for the Topic Space resource. ,
Required: False ,
}
string ,
topicTemplates:
{
Description: The topic filters in the topic space. Example: "topicTemplates": [ "devices/foo/bar", "devices/topic1/+", "devices/${principal.name}/${principal.attributes.keyName}" ]. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the TopicSpace resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TopicSpaces_CreateOrUpdate (new)
Description :  Create or update a topic space with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topicSpaces/{topicSpaceName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
topicSpaceName:
{
Description: The topic space name. ,
Required: True ,
}
string ,
topicSpaceInfo:
{
Description: Topic space information. ,
Required: True ,
}
{
properties:
{
Description: The properties of topic space. ,
Required: False ,
}
{
description:
{
Description: Description for the Topic Space resource. ,
Required: False ,
}
string ,
topicTemplates:
{
Description: The topic filters in the topic space. Example: "topicTemplates": [ "devices/foo/bar", "devices/topic1/+", "devices/${principal.name}/${principal.attributes.keyName}" ]. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the TopicSpace resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of topic space. ,
Required: False ,
}
{
description:
{
Description: Description for the Topic Space resource. ,
Required: False ,
}
string ,
topicTemplates:
{
Description: The topic filters in the topic space. Example: "topicTemplates": [ "devices/foo/bar", "devices/topic1/+", "devices/${principal.name}/${principal.attributes.keyName}" ]. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the TopicSpace resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of topic space. ,
Required: False ,
}
{
description:
{
Description: Description for the Topic Space resource. ,
Required: False ,
}
string ,
topicTemplates:
{
Description: The topic filters in the topic space. Example: "topicTemplates": [ "devices/foo/bar", "devices/topic1/+", "devices/${principal.name}/${principal.attributes.keyName}" ]. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the TopicSpace resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TopicSpaces_Delete (new)
Description :  Delete an existing topic space.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topicSpaces/{topicSpaceName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
topicSpaceName:
{
Description: Name of the Topic space. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TopicSpaces_ListByNamespace (new)
Description :  Get all the topic spaces under a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topicSpaces
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of Topic Space. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of topic space. ,
Required: False ,
}
{
description:
{
Description: Description for the Topic Space resource. ,
Required: False ,
}
string ,
topicTemplates:
{
Description: The topic filters in the topic space. Example: "topicTemplates": [ "devices/foo/bar", "devices/topic1/+", "devices/${principal.name}/${principal.attributes.keyName}" ]. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the TopicSpace resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of Topic Space. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TopicTypes_List (new)
Description :  List all registered topic types.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.EventGrid/topicTypes
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of topic types ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the topic type info ,
Required: False ,
}
{
provider:
{
Description: Namespace of the provider of the topic type. ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name for the topic type. ,
Required: False ,
}
string ,
description:
{
Description: Description of the topic type. ,
Required: False ,
}
string ,
resourceRegionType:
{
Description: Region type of the resource. ,
Enum:
{
RegionalResource: No description available. ,
GlobalResource: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the topic type. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
supportedLocations:
{
Description: List of locations supported by this topic type. ,
Required: False ,
}
[
string ,
]
,
sourceResourceFormat:
{
Description: Source resource format. ,
Required: False ,
}
string ,
supportedScopesForSource:
{
Description: Supported source scopes. ,
Required: False ,
}
[
string ,
]
,
areRegionalAndGlobalSourcesSupported:
{
Description: Flag to indicate that a topic type can support both regional or global system topics. ,
Required: False ,
}
boolean ,
additionalEnforcedPermissions:
{
Description: Permissions which are enforced for creating and updating system topics of this this topic type. ,
Required: False ,
}
[
{
permissionName:
{
Required: False ,
}
string ,
isDataAction:
{
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{}
TopicTypes_Get (new)
Description :  Get information about a topic type.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.EventGrid/topicTypes/{topicTypeName}
{
topicTypeName:
{
Description: Name of the topic type. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the topic type info ,
Required: False ,
}
{
provider:
{
Description: Namespace of the provider of the topic type. ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name for the topic type. ,
Required: False ,
}
string ,
description:
{
Description: Description of the topic type. ,
Required: False ,
}
string ,
resourceRegionType:
{
Description: Region type of the resource. ,
Enum:
{
RegionalResource: No description available. ,
GlobalResource: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the topic type. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
supportedLocations:
{
Description: List of locations supported by this topic type. ,
Required: False ,
}
[
string ,
]
,
sourceResourceFormat:
{
Description: Source resource format. ,
Required: False ,
}
string ,
supportedScopesForSource:
{
Description: Supported source scopes. ,
Required: False ,
}
[
string ,
]
,
areRegionalAndGlobalSourcesSupported:
{
Description: Flag to indicate that a topic type can support both regional or global system topics. ,
Required: False ,
}
boolean ,
additionalEnforcedPermissions:
{
Description: Permissions which are enforced for creating and updating system topics of this this topic type. ,
Required: False ,
}
[
{
permissionName:
{
Required: False ,
}
string ,
isDataAction:
{
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (default)

{}
TopicTypes_ListEventTypes (new)
Description :  List event types for a topic type.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventTypes
{
topicTypeName:
{
Description: Name of the topic type. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of event types ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the event type. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the event type. ,
Required: False ,
}
string ,
description:
{
Description: Description of the event type. ,
Required: False ,
}
string ,
schemaUrl:
{
Description: URL of the schema for this event type. ,
Required: False ,
}
string ,
isInDefaultSet:
{
Description: IsInDefaultSet flag of the event type. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
}

⚐ Response (default)

{}
VerifiedPartners_Get (new)
Description :  Get properties of a verified partner.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.EventGrid/verifiedPartners/{verifiedPartnerName}
{
verifiedPartnerName:
{
Description: Name of the verified partner. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the verified partner. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: ImmutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
organizationName:
{
Description: Official name of the Partner. ,
Required: False ,
}
string ,
partnerDisplayName:
{
Description: Display name of the verified partner. ,
Required: False ,
}
string ,
partnerTopicDetails:
{
Description: Details of the partner topic scenario. ,
Required: False ,
}
{
description:
{
Description: This is short description about the partner. The length of this description should not exceed 256 characters. ,
Required: False ,
}
string ,
longDescription:
{
Description: Long description for the partner's scenarios and integration.Length of this description should not exceed 2048 characters. ,
Required: False ,
}
string ,
setupUri:
{
Description: URI of the partner website that can be used by Azure customers to setup Event Grid integration on an event source. ,
Required: False ,
}
string ,
}
,
partnerDestinationDetails:
{
Description: Details of the partner destination scenario. ,
Required: False ,
}
{
description:
{
Description: This is short description about the partner. The length of this description should not exceed 256 characters. ,
Required: False ,
}
string ,
longDescription:
{
Description: Long description for the partner's scenarios and integration.Length of this description should not exceed 2048 characters. ,
Required: False ,
}
string ,
setupUri:
{
Description: URI of the partner website that can be used by Azure customers to setup Event Grid integration on an event source. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the verified partner. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
VerifiedPartners_List (new)
Description :  Get a list of all verified partners.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.EventGrid/verifiedPartners
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of verified partners. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the verified partner. ,
Required: False ,
}
{
partnerRegistrationImmutableId:
{
Description: ImmutableId of the corresponding partner registration. ,
Format: uuid ,
Required: False ,
}
string ,
organizationName:
{
Description: Official name of the Partner. ,
Required: False ,
}
string ,
partnerDisplayName:
{
Description: Display name of the verified partner. ,
Required: False ,
}
string ,
partnerTopicDetails:
{
Description: Details of the partner topic scenario. ,
Required: False ,
}
{
description:
{
Description: This is short description about the partner. The length of this description should not exceed 256 characters. ,
Required: False ,
}
string ,
longDescription:
{
Description: Long description for the partner's scenarios and integration.Length of this description should not exceed 2048 characters. ,
Required: False ,
}
string ,
setupUri:
{
Description: URI of the partner website that can be used by Azure customers to setup Event Grid integration on an event source. ,
Required: False ,
}
string ,
}
,
partnerDestinationDetails:
{
Description: Details of the partner destination scenario. ,
Required: False ,
}
{
description:
{
Description: This is short description about the partner. The length of this description should not exceed 256 characters. ,
Required: False ,
}
string ,
longDescription:
{
Description: Long description for the partner's scenarios and integration.Length of this description should not exceed 2048 characters. ,
Required: False ,
}
string ,
setupUri:
{
Description: URI of the partner website that can be used by Azure customers to setup Event Grid integration on an event source. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the verified partner. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to the Event Grid resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of verified partners if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
Namespaces_ValidateCustomDomainOwnership (new)
Description :  Performs ownership validation via checking TXT records for all custom domains in a namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/validateCustomDomainOwnership
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the Namespace. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
customDomainsForTopicsConfiguration:
{
Description: List of custom domain configurations for the namespace under topics configuration. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
customDomainsForTopicSpacesConfiguration:
{
Description: List of custom domain configurations for the namespace under topic spaces configuration. ,
Required: False ,
}
[
{
fullyQualifiedDomainName:
{
Description: Fully Qualified Domain Name (FQDN) for the custom domain. ,
Required: True ,
}
string ,
validationState:
{
Description: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
ErrorRetrievingDnsRecord: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: The user identity associated with the resource. ,
Required: False ,
}
string ,
}
,
certificateUrl:
{
Description: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) ,
Required: False ,
}
string ,
expectedTxtRecordName:
{
Description: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value. ,
Required: False ,
}
string ,
expectedTxtRecordValue:
{
Description: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceTopicEventSubscriptions_GetFullUrl (new)
Description :  Get the full endpoint URL for an event subscription of a namespace topic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}/getFullUrl
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the namespace. ,
Required: True ,
}
string ,
topicName:
{
Description: Name of the namespace topic. ,
Required: True ,
}
string ,
eventSubscriptionName:
{
Description: Name of the event subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endpointUrl:
{
Description: The URL that represents the endpoint of the destination of an event subscription. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}