Azure Event Grid Channels API

openapi: 3.2.0
info:
  version: '2025-02-15'
  title: EventGridManagementClient Channels API
  description: Azure EventGrid Management Client
servers:
- url: https://management.azure.com
tags:
- name: Channels
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}
  : get:
      tags:
      - Channels
      summary: Get a channel
      description: Get properties of a channel.
      operationId: Channels_Get
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the partners subscription.
        required: true
        schema:
          type: string
      - name: partnerNamespaceName
        in: path
        description: Name of the partner namespace.
        required: true
        schema:
          type: string
      - name: channelName
        in: path
        description: Name of the channel.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channel'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
    put:
      tags:
      - Channels
      summary: Create or update a channel
      description: Synchronously creates or updates a new channel with the specified parameters.
      operationId: Channels_CreateOrUpdate
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the partners subscription.
        required: true
        schema:
          type: string
      - name: partnerNamespaceName
        in: path
        description: Name of the partner namespace.
        required: true
        schema:
          type: string
      - name: channelName
        in: path
        description: Name of the channel.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channel'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channel'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Channel'
        description: Channel information.
        required: true
    delete:
      tags:
      - Channels
      summary: Delete a channel
      description: Delete an existing channel.
      operationId: Channels_Delete
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the partners subscription.
        required: true
        schema:
          type: string
      - name: partnerNamespaceName
        in: path
        description: Name of the partner namespace.
        required: true
        schema:
          type: string
      - name: channelName
        in: path
        description: Name of the channel.
        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:
      - Channels
      summary: Update a Channel
      description: Synchronously updates a channel with the specified parameters.
      operationId: Channels_Update
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the partners subscription.
        required: true
        schema:
          type: string
      - name: partnerNamespaceName
        in: path
        description: Name of the partner namespace.
        required: true
        schema:
          type: string
      - name: channelName
        in: path
        description: Name of the channel.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChannelUpdateParameters'
        description: Channel update information.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels
  : get:
      tags:
      - Channels
      summary: List channels
      description: List all the channels in a partner namespace.
      operationId: Channels_ListByPartnerNamespace
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the partners subscription.
        required: true
        schema:
          type: string
      - name: partnerNamespaceName
        in: path
        description: Name of the partner namespace.
        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/ChannelsListResult'
        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/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}/getFullUrl
  : post:
      tags:
      - Channels
      summary: Get full URL of partner destination channel
      description: Get the full endpoint URL of a partner destination channel.
      operationId: Channels_GetFullUrl
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the partners subscription.
        required: true
        schema:
          type: string
      - name: partnerNamespaceName
        in: path
        description: Name of the partner namespace.
        required: true
        schema:
          type: string
      - name: channelName
        in: path
        description: Name of the Channel.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSubscriptionFullUrl'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
components:
  schemas:
    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
    PartnerUpdateTopicInfo:
      description: Update properties for the corresponding partner topic of a channel.
      type: object
      properties:
        eventTypeInfo:
          $ref: '#/components/schemas/EventTypeInfo'
          description: Event type info for the partner topic
    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
    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'
    EventSubscriptionFullUrl:
      description: Full endpoint URL of an event subscription
      type: object
      properties:
        endpointUrl:
          description: The URL that represents the endpoint of the destination of an event subscription.
          type: string
    ChannelsListResult:
      description: Result of the List Channels operation
      type: object
      properties:
        value:
          description: A collection of Channels.
          type: array
          items:
            $ref: '#/components/schemas/Channel'
        nextLink:
          description: A link for the next page of channels.
          type: string
    ChannelProperties:
      description: Properties of the Channel.
      type: object
      properties:
        channelType:
          description: The type of the event channel which represents the direction flow of events.
          enum:
          - PartnerTopic
          type: string
          x-ms-enum:
            name: ChannelType
            modelAsString: true
        partnerTopicInfo:
          $ref: '#/components/schemas/PartnerTopicInfo'
          description: This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.
        messageForActivation:
          description: Context or helpful message that can be used during the approval process by the subscriber.
          type: string
        provisioningState:
          description: Provisioning state of the channel.
          enum:
          - Creating
          - Updating
          - Deleting
          - Succeeded
          - Canceled
          - Failed
          - IdleDueToMirroredPartnerTopicDeletion
          type: string
          x-ms-enum:
            name: ChannelProvisioningState
            modelAsString: true
        readinessState:
          description: The readiness state of the corresponding partner topic.
          enum:
          - NeverActivated
          - Activated
          type: string
          x-ms-enum:
            name: ReadinessState
            modelAsString: true
        expirationTimeIfNotActivatedUtc:
          format: date-time
          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.'
          type: string
    ChannelUpdateParameters:
      description: Properties of the Channel update.
      type: object
      properties:
        properties:
          $ref: '#/components/schemas/ChannelUpdateParametersProperties'
          x-ms-client-flatten: true
    ChannelUpdateParametersProperties:
      description: Properties of the channel update parameters.
      type: object
      properties:
        expirationTimeIfNotActivatedUtc:
          format: date-time
          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.'
          type: string
        partnerTopicInfo:
          $ref: '#/components/schemas/PartnerUpdateTopicInfo'
          description: Partner topic properties which can be updated if the channel is of type PartnerTopic.
    PartnerTopicInfo:
      description: Properties of the corresponding partner topic of a Channel.
      type: object
      properties:
        azureSubscriptionId:
          description: 'Azure subscription ID of the subscriber. The partner topic associated with the channel will be

            created under this Azure subscription.'
          type: string
        resourceGroupName:
          description: 'Azure Resource Group of the subscriber. The partner topic associated with the channel will be

            created under this resource group.'
          type: string
        name:
          description: Name of the partner topic associated with the channel.
          type: string
        eventTypeInfo:
          $ref: '#/components/schemas/EventTypeInfo'
          description: "Event Type Information for the partner topic. This information is provided by the publisher and can be used by the \nsubscriber to view different types of events that are published."
        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.'
          type: string
    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
    Channel:
      description: Channel info.
      type: object
      allOf:
      - $ref: '#/components/schemas/Resource'
      properties:
        properties:
          $ref: '#/components/schemas/ChannelProperties'
          description: Properties of the Channel.
          x-ms-client-flatten: true
        systemData:
          $ref: '#/components/schemas/systemData'
          description: The system metadata relating to the Event Grid resource.
          type: object
          readOnly: true
  parameters:
    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
    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
    ApiVersionParameter:
      name: api-version
      in: query
      description: Version of the API to be used with the client request.
      required: true
      schema:
        type: string
    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
  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