Azure Event Grid Domains API

openapi: 3.2.0
info:
  version: '2025-02-15'
  title: EventGridManagementClient Domains API
  description: Azure EventGrid Management Client
servers:
- url: https://management.azure.com
tags:
- name: Domains
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}:
    get:
      tags:
      - Domains
      summary: Get a domain
      description: Get properties of a domain.
      operationId: Domains_Get
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        schema:
          type: string
      - name: domainName
        in: path
        description: Name of the domain.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
    put:
      tags:
      - Domains
      summary: Create or update a domain
      description: Asynchronously creates or updates a new domain with the specified parameters.
      operationId: Domains_CreateOrUpdate
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        schema:
          type: string
      - name: domainName
        in: path
        description: Name of the domain.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Domain'
        description: Domain information.
        required: true
    delete:
      tags:
      - Domains
      summary: Delete a domain
      description: Delete existing domain.
      operationId: Domains_Delete
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        schema:
          type: string
      - name: domainName
        in: path
        description: Name of the domain.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
          headers:
            Location:
              schema:
                type: string
        '204':
          description: NoContent
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
      x-ms-long-running-operation: true
    patch:
      tags:
      - Domains
      summary: Update a domain
      description: Asynchronously updates a domain with the specified parameters.
      operationId: Domains_Update
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        schema:
          type: string
      - name: domainName
        in: path
        description: Name of the domain.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        '201':
          description: Domain update request accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainUpdateParameters'
        description: Domain update information.
        required: true
  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/domains:
    get:
      tags:
      - Domains
      summary: List domains under an Azure subscription
      description: List all the domains under an Azure subscription.
      operationId: Domains_ListBySubscription
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/FilterParameter'
      - $ref: '#/components/parameters/TopParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainsListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains:
    get:
      tags:
      - Domains
      summary: List domains under a resource group
      description: List all the domains under a resource group.
      operationId: Domains_ListByResourceGroup
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/FilterParameter'
      - $ref: '#/components/parameters/TopParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainsListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/listKeys
  : post:
      tags:
      - Domains
      summary: List keys for a domain
      description: List the two keys used to publish to a domain.
      operationId: Domains_ListSharedAccessKeys
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        schema:
          type: string
      - name: domainName
        in: path
        description: Name of the domain.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainSharedAccessKeys'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/regenerateKey
  : post:
      tags:
      - Domains
      summary: Regenerate key for a domain
      description: Regenerate a shared access key for a domain.
      operationId: Domains_RegenerateKey
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        schema:
          type: string
      - name: domainName
        in: path
        description: Name of the domain.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainSharedAccessKeys'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainRegenerateKeyRequest'
        description: Request body to regenerate key.
        required: true
components:
  schemas:
    InlineEventProperties:
      description: Additional information about every inline event.
      type: object
      properties:
        description:
          description: The description for the inline event.
          type: string
        displayName:
          description: The displayName for the inline event.
          type: string
        documentationUrl:
          description: The documentationUrl for the inline event.
          type: string
        dataSchemaUrl:
          description: The dataSchemaUrl for the inline event.
          type: string
    IdentityInfo:
      description: The identity information for the resource.
      type: object
      properties:
        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
          - SystemAssigned
          - UserAssigned
          - SystemAssigned, UserAssigned
          type: string
          x-ms-enum:
            name: IdentityType
            modelAsString: true
        principalId:
          description: The principal ID of resource identity.
          type: string
        tenantId:
          description: The tenant ID of resource.
          type: 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.'
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UserIdentityProperties'
    DomainsListResult:
      description: Result of the List Domains operation.
      type: object
      properties:
        value:
          description: A collection of Domains.
          type: array
          items:
            $ref: '#/components/schemas/Domain'
        nextLink:
          description: A link for the next page of domains.
          type: string
    Domain:
      description: EventGrid Domain.
      type: object
      allOf:
      - $ref: '#/components/schemas/TrackedResource'
      properties:
        properties:
          $ref: '#/components/schemas/DomainProperties'
          description: Properties of the Event Grid Domain resource.
          x-ms-client-flatten: true
        identity:
          $ref: '#/components/schemas/IdentityInfo'
          description: Identity information for the Event Grid Domain resource.
        systemData:
          $ref: '#/components/schemas/systemData'
          description: The system metadata relating to the Event Grid resource.
          type: object
          readOnly: true
    UserIdentityProperties:
      description: The information about the user identity.
      type: object
      properties:
        principalId:
          description: The principal id of user assigned identity.
          type: string
        clientId:
          description: The client id of user assigned identity.
          type: string
    PrivateEndpointConnection:
      type: object
      allOf:
      - $ref: '#/components/schemas/Resource'
      properties:
        properties:
          $ref: '#/components/schemas/PrivateEndpointConnectionProperties'
          description: Properties of the PrivateEndpointConnection.
          x-ms-client-flatten: true
    PrivateEndpointConnectionProperties:
      description: Properties of the private endpoint connection resource.
      type: object
      properties:
        privateEndpoint:
          $ref: '#/components/schemas/PrivateEndpoint'
          description: The Private Endpoint resource for this Connection.
        groupIds:
          description: GroupIds from the private link service resource.
          type: array
          items:
            type: string
        privateLinkServiceConnectionState:
          $ref: '#/components/schemas/ConnectionState'
          description: Details about the state of the connection.
        provisioningState:
          description: Provisioning state of the Private Endpoint Connection.
          enum:
          - Creating
          - Updating
          - Deleting
          - Succeeded
          - Canceled
          - Failed
          type: string
          x-ms-enum:
            name: ResourceProvisioningState
            modelAsString: true
    TrackedResource:
      description: Definition of a Tracked Resource.
      required:
      - location
      type: object
      allOf:
      - $ref: '#/components/schemas/Resource'
      properties:
        location:
          description: Location of the resource.
          type: string
          x-ms-mutability:
          - read
          - create
        tags:
          description: Tags of the resource.
          type: object
          additionalProperties:
            type: string
    DomainRegenerateKeyRequest:
      description: Domain regenerate share access key request.
      required:
      - keyName
      type: object
      properties:
        keyName:
          description: Key name to regenerate key1 or key2.
          type: string
    PrivateEndpoint:
      description: PrivateEndpoint information.
      type: object
      properties:
        id:
          description: The ARM identifier for Private Endpoint.
          type: string
    Resource:
      description: Definition of a Resource.
      type: object
      properties:
        id:
          description: Fully qualified identifier of the resource.
          type: string
          readOnly: true
        name:
          description: Name of the resource.
          type: string
          readOnly: true
        type:
          description: Type of the resource.
          type: string
          readOnly: true
      x-ms-azure-resource: true
    DomainSharedAccessKeys:
      description: Shared access keys of the Domain.
      type: object
      properties:
        key1:
          description: Shared access key1 for the domain.
          type: string
        key2:
          description: Shared access key2 for the domain.
          type: string
    InputSchemaMapping:
      description: By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only supported type of InputSchemaMapping is 'JsonInputSchemaMapping'.
      required:
      - inputSchemaMappingType
      type: object
      properties:
        inputSchemaMappingType:
          description: Type of the custom mapping
          enum:
          - Json
          type: string
          x-ms-enum:
            name: InputSchemaMappingType
            modelAsString: true
      discriminator:
        propertyName: inputSchemaMappingType
    DomainUpdateParameters:
      description: Properties of the Domain update.
      type: object
      properties:
        tags:
          description: Tags of the domains resource.
          type: object
          additionalProperties:
            type: string
        properties:
          $ref: '#/components/schemas/DomainUpdateParameterProperties'
          description: Properties of the resource.
          x-ms-client-flatten: true
        identity:
          $ref: '#/components/schemas/IdentityInfo'
          description: Identity information for the resource.
    ConnectionState:
      description: ConnectionState information.
      type: object
      properties:
        status:
          description: Status of the connection.
          enum:
          - Pending
          - Approved
          - Rejected
          - Disconnected
          type: string
          x-ms-enum:
            name: PersistedConnectionStatus
            modelAsString: true
        description:
          description: Description of the connection state.
          type: string
        actionsRequired:
          description: Actions required (if any).
          type: string
    DomainUpdateParameterProperties:
      description: Information of domain update parameter properties.
      type: object
      properties:
        publicNetworkAccess:
          description: "This determines if traffic is allowed over public network. By default it is enabled. \nYou can further restrict to specific IPs by configuring <seealso cref=\"P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainUpdateParameterProperties.InboundIpRules\" />"
          enum:
          - Enabled
          - Disabled
          type: string
          x-ms-enum:
            name: PublicNetworkAccess
            modelAsString: true
          default: Enabled
        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.'
          type: array
          items:
            $ref: '#/components/schemas/InboundIpRule'
          x-ms-identifiers: []
        minimumTlsVersionAllowed:
          description: Minimum TLS version of the publisher allowed to publish to this domain
          enum:
          - '1.0'
          - '1.1'
          - '1.2'
          type: string
          x-ms-enum:
            name: TlsVersion
            modelAsString: true
        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.
          type: 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.'
          type: 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.'
          type: boolean
        dataResidencyBoundary:
          description: The data residency boundary for the domain.
          enum:
          - WithinGeopair
          - WithinRegion
          type: string
          x-ms-enum:
            name: DataResidencyBoundary
            modelAsString: true
        eventTypeInfo:
          $ref: '#/components/schemas/EventTypeInfo'
          description: The eventTypeInfo for the domain.
    systemData:
      type: object
      description: Metadata pertaining to creation and last modification of the resource.
      properties:
        createdBy:
          type: string
          description: The identity that created the resource.
        createdByType:
          type: string
          description: The type of identity that created the resource.
          enum:
          - User
          - Application
          - ManagedIdentity
          - Key
          x-ms-enum:
            name: createdByType
            modelAsString: true
        createdAt:
          type: string
          format: date-time
          description: The timestamp of resource creation (UTC).
        lastModifiedBy:
          type: string
          description: The identity that last modified the resource.
        lastModifiedByType:
          type: string
          description: The type of identity that last modified the resource.
          enum:
          - User
          - Application
          - ManagedIdentity
          - Key
          x-ms-enum:
            name: createdByType
            modelAsString: true
        lastModifiedAt:
          type: string
          format: date-time
          description: The timestamp of resource last modification (UTC)
      readOnly: true
    DomainProperties:
      description: Properties of the Event Grid Domain Resource.
      type: object
      properties:
        privateEndpointConnections:
          description: List of private endpoint connections.
          type: array
          items:
            $ref: '#/components/schemas/PrivateEndpointConnection'
          readOnly: true
        provisioningState:
          description: Provisioning state of the Event Grid Domain Resource.
          enum:
          - Creating
          - Updating
          - Deleting
          - Succeeded
          - Canceled
          - Failed
          type: string
          readOnly: true
          x-ms-enum:
            name: DomainProvisioningState
            modelAsString: true
        minimumTlsVersionAllowed:
          description: Minimum TLS version of the publisher allowed to publish to this domain
          enum:
          - '1.0'
          - '1.1'
          - '1.2'
          type: string
          x-ms-enum:
            name: TlsVersion
            modelAsString: true
        endpoint:
          description: Endpoint for the Event Grid Domain Resource which is used for publishing the events.
          type: string
          readOnly: true
        inputSchema:
          description: This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.
          enum:
          - EventGridSchema
          - CustomEventSchema
          - CloudEventSchemaV1_0
          type: string
          x-ms-enum:
            name: InputSchema
            modelAsString: true
          default: EventGridSchema
        eventTypeInfo:
          $ref: '#/components/schemas/EventTypeInfo'
          description: "Event Type Information for the domain. This information is provided by the publisher and can be used by the \nsubscriber to view different types of events that are published."
        inputSchemaMapping:
          $ref: '#/components/schemas/InputSchemaMapping'
          description: Information about the InputSchemaMapping which specified the info about mapping event payload.
        metricResourceId:
          description: Metric resource id for the Event Grid Domain Resource.
          type: string
          readOnly: true
        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 <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />'
          enum:
          - Enabled
          - Disabled
          type: string
          x-ms-enum:
            name: PublicNetworkAccess
            modelAsString: true
          default: Enabled
        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.'
          type: array
          items:
            $ref: '#/components/schemas/InboundIpRule'
          x-ms-identifiers: []
        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.
          default: false
          type: 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.'
          default: true
          type: 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.'
          default: true
          type: boolean
        dataResidencyBoundary:
          description: Data Residency Boundary of the resource.
          enum:
          - WithinGeopair
          - WithinRegion
          type: string
          x-ms-enum:
            name: DataResidencyBoundary
            modelAsString: true
    InboundIpRule:
      type: object
      properties:
        ipMask:
          description: IP Address in CIDR notation e.g., 10.0.0.0/8.
          type: string
        action:
          description: Action to perform based on the match or no match of the IpMask.
          enum:
          - Allow
          type: string
          x-ms-enum:
            name: IpActionType
            modelAsString: true
    EventTypeInfo:
      description: The event type information for Channels.
      type: object
      properties:
        kind:
          description: The kind of event type used.
          enum:
          - Inline
          type: string
          x-ms-enum:
            name: EventDefinitionKind
            modelAsString: true
        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.'
          type: object
          additionalProperties:
            $ref: '#/components/schemas/InlineEventProperties'
  parameters:
    TopParameter:
      name: $top
      in: query
      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.
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
      required: true
      schema:
        type: string
    FilterParameter:
      name: $filter
      in: query
      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
      x-ms-parameter-location: method
      schema:
        type: string
    ApiVersionParameter:
      name: api-version
      in: query
      description: Version of the API to be used with the client request.
      required: true
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow