Microsoft Azure Channels API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Channels API
schemes:
- https
tags:
- name: Channels
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/Channels/{channelName}
  : get:
      tags:
      - Channels
      summary: Microsoft Azure Get The Engagementfabric Channel
      operationId: microsoftAzureChannelsGet
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/ChannelNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Channel'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        ChannelsGetExample:
          $ref: ./examples/ChannelsGetExample.json
      description: Needs a more full description created.
    put:
      tags:
      - Channels
      summary: Microsoft Azure Create Or Update The Engagementfabric Channel
      operationId: microsoftAzureChannelsCreateorupdate
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/ChannelNameParameter'
      - name: channel
        in: body
        description: The EngagementFabric channel description
        required: true
        schema:
          $ref: '#/definitions/Channel'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Channel'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        ChannelsCreateOrUpdateExample:
          $ref: ./examples/ChannelsCreateOrUpdateExample.json
      description: Needs a more full description created.
    delete:
      tags:
      - Channels
      summary: Microsoft Azure Delete The Engagementfabric Channel
      operationId: microsoftAzureChannelsDelete
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - name: channelName
        in: path
        description: The EngagementFabric channel name
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        '204':
          description: NoContent
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        ChannelsDeleteExample:
          $ref: ./examples/ChannelsDeleteExample.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/Channels
  : get:
      tags:
      - Channels
      summary: Microsoft Azure List The Engagementfabric Channels
      operationId: microsoftAzureChannelsListbyaccount
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ChannelList'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        ChannelsListExample:
          $ref: ./examples/ChannelsListExample.json
      x-ms-pageable:
        nextLinkName: null
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}
  : get:
      tags:
      - Channels
      summary: Microsoft Azure Get A Channel
      description: Get properties of a channel.
      operationId: microsoftAzureChannelsGet
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter_2'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the partners subscription.
        required: true
        type: string
      - name: partnerNamespaceName
        in: path
        description: Name of the partner namespace.
        required: true
        type: string
      - name: channelName
        in: path
        description: Name of the channel.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter_2'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Channel_2'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Channels_Get:
          $ref: ./examples/Channels_Get.json
    put:
      tags:
      - Channels
      summary: Microsoft Azure Create Or Update A Channel
      description: Synchronously creates or updates a new channel with the specified parameters.
      operationId: microsoftAzureChannelsCreateorupdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter_2'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the partners subscription.
        required: true
        type: string
      - name: partnerNamespaceName
        in: path
        description: Name of the partner namespace.
        required: true
        type: string
      - name: channelName
        in: path
        description: Name of the channel.
        required: true
        type: string
      - name: channelInfo
        in: body
        description: Channel information.
        required: true
        schema:
          $ref: '#/definitions/Channel_2'
      - $ref: '#/parameters/ApiVersionParameter_2'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Channel_2'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Channel_2'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Channels_CreateOrUpdate:
          $ref: ./examples/Channels_CreateOrUpdate.json
    delete:
      tags:
      - Channels
      summary: Microsoft Azure Delete A Channel
      description: Delete an existing channel.
      operationId: microsoftAzureChannelsDelete
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter_2'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the partners subscription.
        required: true
        type: string
      - name: partnerNamespaceName
        in: path
        description: Name of the partner namespace.
        required: true
        type: string
      - name: channelName
        in: path
        description: Name of the channel.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter_2'
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        '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-examples:
        Channels_Delete:
          $ref: ./examples/Channels_Delete.json
      x-ms-long-running-operation: true
    patch:
      tags:
      - Channels
      summary: Microsoft Azure Update A Channel
      description: Synchronously updates a channel with the specified parameters.
      operationId: microsoftAzureChannelsUpdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter_2'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the partners subscription.
        required: true
        type: string
      - name: partnerNamespaceName
        in: path
        description: Name of the partner namespace.
        required: true
        type: string
      - name: channelName
        in: path
        description: Name of the channel.
        required: true
        type: string
      - name: channelUpdateParameters
        in: body
        description: Channel update information.
        required: true
        schema:
          $ref: '#/definitions/ChannelUpdateParameters'
      - $ref: '#/parameters/ApiVersionParameter_2'
      responses:
        '200':
          description: OK
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Channels_Update:
          $ref: ./examples/Channels_Update.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels
  : get:
      tags:
      - Channels
      summary: Microsoft Azure List Channels
      description: List all the channels in a partner namespace.
      operationId: microsoftAzureChannelsListbypartnernamespace
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter_2'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the partners subscription.
        required: true
        type: string
      - name: partnerNamespaceName
        in: path
        description: Name of the partner namespace.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter_2'
      - $ref: '#/parameters/FilterParameter'
      - $ref: '#/parameters/TopParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ChannelsListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Channels_ListByPartnerNamespace:
          $ref: ./examples/Channels_ListByPartnerNamespace.json
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}/getFullUrl
  : post:
      tags:
      - Channels
      summary: Microsoft Azure Get Full Url Of Partner Destination Channel
      description: Get the full endpoint URL of a partner destination channel.
      operationId: microsoftAzureChannelsGetfullurl
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter_2'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the partners subscription.
        required: true
        type: string
      - name: partnerNamespaceName
        in: path
        description: Name of the partner namespace.
        required: true
        type: string
      - name: channelName
        in: path
        description: Name of the Channel.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter_2'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/EventSubscriptionFullUrl'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Channels_GetFullUrl:
          $ref: ./examples/Channels_GetFullUrl.json
definitions:
  PartnerUpdateDestinationInfo:
    description: Properties of the corresponding partner destination of a Channel.
    required:
    - endpointType
    type: object
    properties:
      endpointType:
        description: Type of the endpoint for the partner destination
        default: WebHook
        enum:
        - WebHook
        type: string
        x-ms-enum:
          name: PartnerEndpointType
          modelAsString: true
    discriminator: endpointType
  ChannelsListResult:
    description: Result of the List Channels operation
    type: object
    properties:
      value:
        description: A collection of Channels.
        type: array
        items:
          $ref: '#/definitions/Channel_2'
      nextLink:
        description: A link for the next page of channels.
        type: string
  ChannelUpdateParametersProperties:
    description: Properties of the channel update parameters.
    type: object
    properties:
      expirationTimeIfNotActivatedUtc:
        format: date-time
        description: "Expiration time of the event channel. If this timer expires while the corresponding partner topic or partner destination is never activated,\r\nthe channel and corresponding partner topic or partner destination are deleted."
        type: string
      partnerDestinationInfo:
        $ref: '#/definitions/PartnerUpdateDestinationInfo'
        description: Partner destination properties which can be updated if the channel is of type PartnerDestination.
      partnerTopicInfo:
        $ref: '#/definitions/PartnerUpdateTopicInfo'
        description: Partner topic properties which can be updated if the channel is of type PartnerTopic.
  ResourceMoveChangeHistory:
    description: The change history of the resource move.
    type: object
    properties:
      azureSubscriptionId:
        description: Azure subscription ID of the resource.
        type: string
      resourceGroupName:
        description: Azure Resource Group of the resource.
        type: string
      changedTimeUtc:
        format: date-time
        description: UTC timestamp of when the resource was changed.
        type: string
  CloudErrorBody:
    description: Content of the default error response
    type: object
    properties:
      code:
        description: The error code
        type: string
      message:
        description: The error message
        type: string
      target:
        description: The target of the particular error
        type: string
      details:
        description: The list of additional details
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
    x-ms-external: true
  PartnerUpdateTopicInfo:
    description: Update properties for the corresponding partner topic of a channel.
    type: object
    properties:
      eventTypeInfo:
        $ref: '#/definitions/EventTypeInfo'
        description: Event type info for the partner topic
  Resource:
    description: The base model for Azure resource
    type: object
    properties:
      id:
        description: The ID of the resource
        type: string
        readOnly: true
      name:
        description: The name of the resource
        type: string
        readOnly: true
      type:
        description: The fully qualified type of the resource
        type: string
        readOnly: true
    x-ms-azure-resource: true
  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
  ChannelList:
    description: The list of the EngagementFabric channels
    type: object
    properties:
      value:
        description: EngagementFabric channels
        type: array
        items:
          $ref: '#/definitions/Channel'
  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\r\ncreated under this Azure subscription."
        type: string
      resourceGroupName:
        description: "Azure Resource Group of the subscriber. The partner topic associated with the channel will be\r\ncreated under this resource group."
        type: string
      name:
        description: Name of the partner topic associated with the channel.
        type: string
      eventTypeInfo:
        $ref: '#/definitions/EventTypeInfo'
        description: "Event Type Information for the partner topic. This information is provided by the publisher and can be used by the \r\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\r\nare originating. This information can be used by the subscriber during the approval process of the\r\ncreated partner topic."
        type: string
  InlineEventProperties:
    description: Additional information about every inline event.
    type: object
    properties:
      description:
        description: The description 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
  Channel_2:
    description: Channel info.
    type: object
    allOf:
    - $ref: '#/definitions/Resource_2'
    properties:
      properties:
        $ref: '#/definitions/ChannelProperties_2'
        description: Properties of the Channel.
        x-ms-client-flatten: true
      systemData:
        description: The system metadata relating to Channel resource.
        type: object
        readOnly: true
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
  ChannelProperties:
    description: The EngagementFabric channel properties
    required:
    - channelType
    type: object
    properties:
      channelType:
        description: The channel type
        type: string
      channelFunctions:
        description: The functions to be enabled for the channel
        type: array
        items:
          type: string
      credentials:
        description: The channel credentials
        type: object
        additionalProperties:
          type: string
  ProxyOnlyResource:
    description: The base model for the proxy-only Azure resource
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
  Channel:
    description: The EngagementFabric channel
    type: object
    allOf:
    - $ref: '#/definitions/ProxyOnlyResource'
    properties:
      properties:
        $ref: '#/definitions/ChannelProperties'
        description: The properties of the channel
        x-ms-client-flatten: true
  Resource_2:
    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
  CloudError:
    description: The default error response
    type: object
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: Content of the error
    x-ms-external: 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.\r\nAn example of a valid inline event name is \"Contoso.OrderCreated\".\r\nThe inline event type values are of type InlineEventProperties and will contain additional information for every inline event type."
        type: object
        additionalProperties:
          $ref: '#/definitions/InlineEventProperties'
  ChannelUpdateParameters:
    description: Properties of the Channel update.
    type: object
    properties:
      properties:
        $ref: '#/definitions/ChannelUpdateParametersProperties'
        x-ms-client-flatten: true
  ChannelProperties_2:
    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
        - PartnerDestination
        type: string
        x-ms-enum:
          name: ChannelType
          modelAsString: true
      partnerTopicInfo:
        $ref: '#/definitions/PartnerTopicInfo'
        description: This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.
      partnerDestinationInfo:
        $ref: '#/definitions/PartnerDestinationInfo'
        description: This property should be populated when channelType is PartnerDestination and represents information about the partner destination 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
        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,\r\nthe channel and corresponding partner topic are deleted."
        type: string
  PartnerDestinationInfo:
    description: Properties of the corresponding partner destination of a Channel.
    required:
    - endpointType
    type: object
    properties:
      azureSubscriptionId:
        description: "Azure subscription ID of the subscriber. The partner destination associated with the channel will be\r\ncreated under this Azure subscription."
        type: string
      resourceGroupName:
        description: "Azure Resource Group of the subscriber. The partner destination associated with the channel will be\r\ncreated under this resource group."
        type: string
      name:
        description: Name of the partner destination associated with the channel.
        type: string
      endpointType:
        description: Type of the endpoint for the partner destination
        default: WebHook
        enum:
        - WebHook
        type: string
        x-ms-enum:
          name: PartnerEndpointType
          modelAsString: true
      endpointServiceContext:
        description: Additional context of the partner destination endpoint.
        type: string
      resourceMoveChangeHistory:
        description: Change history of the resource move.
        type: array
        items:
          $ref: '#/definitions/ResourceMoveChangeHistory'
        x-ms-identifiers: []
    discriminator: endpointType
parameters:
  SubscriptionIdParameter_2:
    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
    type: string
  ApiVersionParameter:
    name: api-version
    in: query
    description: API version
    required: true
    type: string
  ChannelNameParameter:
    name: channelName
    in: path
    description: Channel Name
    required: true
    type: string
    x-ms-parameter-location: method
  ApiVersionParameter_2:
    name: api-version
    in: query
    description: Version of the API to be used with the client request.
    required: true
    type: string
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: Resource Group Name
    required: true
    type: string
    x-ms-parameter-location: method
  AccountNameParameter:
    name: accountName
    in: path
    description: Account Name
    required: true
    type: string
    x-ms-parameter-location: method
  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
    type: string
    x-ms-parameter-location: method
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Subscription ID
    required: true
    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
    type: integer
    format: int32
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'