swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector PartnerTopics API
schemes:
- https
tags:
- name: PartnerTopics
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}
  : get:
      tags:
      - PartnerTopics
      summary: Microsoft Azure Get A Partner Topic
      description: Get properties of a partner topic.
      operationId: microsoftAzurePartnertopicsGet
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        type: string
      - name: partnerTopicName
        in: path
        description: Name of the partner topic.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerTopic'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerTopics_Get:
          $ref: ./examples/PartnerTopics_Get.json
    put:
      tags:
      - PartnerTopics
      summary: Microsoft Azure Create A Partner Topic
      description: Asynchronously creates a new partner topic with the specified parameters.
      operationId: microsoftAzurePartnertopicsCreateorupdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        type: string
      - name: partnerTopicName
        in: path
        description: Name of the partner topic.
        required: true
        type: string
      - name: partnerTopicInfo
        in: body
        description: Partner Topic information.
        required: true
        schema:
          $ref: '#/definitions/PartnerTopic'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerTopic'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/PartnerTopic'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerTopics_CreateOrUpdate:
          $ref: ./examples/PartnerTopics_CreateOrUpdate.json
    delete:
      tags:
      - PartnerTopics
      summary: Microsoft Azure Delete A Partner Topic
      description: Delete existing partner topic.
      operationId: microsoftAzurePartnertopicsDelete
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        type: string
      - name: partnerTopicName
        in: path
        description: Name of the partner topic.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      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:
        PartnerTopics_Delete:
          $ref: ./examples/PartnerTopics_Delete.json
      x-ms-long-running-operation: true
    patch:
      tags:
      - PartnerTopics
      summary: Microsoft Azure Update A Partner Topic
      description: Asynchronously updates a partner topic with the specified parameters.
      operationId: microsoftAzurePartnertopicsUpdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        type: string
      - name: partnerTopicName
        in: path
        description: Name of the partner topic.
        required: true
        type: string
      - name: partnerTopicUpdateParameters
        in: body
        description: PartnerTopic update information.
        required: true
        schema:
          $ref: '#/definitions/PartnerTopicUpdateParameters'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        '201':
          description: Partner Topic update request accepted.
          schema:
            $ref: '#/definitions/PartnerTopic'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerTopics_Update:
          $ref: ./examples/PartnerTopics_Update.json
  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerTopics:
    get:
      tags:
      - PartnerTopics
      summary: Microsoft Azure List Partner Topics Under An Azure Subscription
      description: List all the partner topics under an Azure subscription.
      operationId: microsoftAzurePartnertopicsListbysubscription
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/FilterParameter'
      - $ref: '#/parameters/TopParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerTopicsListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerTopics_ListBySubscription:
          $ref: ./examples/PartnerTopics_ListBySubscription.json
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics:
    get:
      tags:
      - PartnerTopics
      summary: Microsoft Azure List Partner Topics Under A Resource Group
      description: List all the partner topics under a resource group.
      operationId: microsoftAzurePartnertopicsListbyresourcegroup
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/FilterParameter'
      - $ref: '#/parameters/TopParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerTopicsListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerTopics_ListByResourceGroup:
          $ref: ./examples/PartnerTopics_ListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/activate
  : post:
      tags:
      - PartnerTopics
      summary: Microsoft Azure Activate A Partner Topic
      description: Activate a newly created partner topic.
      operationId: microsoftAzurePartnertopicsActivate
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        type: string
      - name: partnerTopicName
        in: path
        description: Name of the partner topic.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerTopic'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerTopics_Activate:
          $ref: ./examples/PartnerTopics_Activate.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/deactivate
  : post:
      tags:
      - PartnerTopics
      summary: Microsoft Azure Deactivate A Partner Topic
      description: Deactivate specific partner topic.
      operationId: microsoftAzurePartnertopicsDeactivate
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        type: string
      - name: partnerTopicName
        in: path
        description: Name of the partner topic.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerTopic'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerTopics_Deactivate:
          $ref: ./examples/PartnerTopics_Deactivate.json
definitions:
  PartnerTopicUpdateParameters:
    description: Properties of the Partner Topic update.
    type: object
    properties:
      tags:
        description: Tags of the Partner Topic resource.
        type: object
        additionalProperties:
          type: string
      identity:
        $ref: '#/definitions/IdentityInfo'
        description: Identity information for the Partner Topic resource.
  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
  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
  TrackedResource:
    description: Definition of a Tracked Resource.
    required:
    - location
    type: object
    allOf:
    - $ref: '#/definitions/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
  PartnerTopicProperties:
    description: Properties of the Partner Topic.
    type: object
    properties:
      partnerRegistrationImmutableId:
        format: uuid
        description: The immutableId of the corresponding partner registration.
        type: string
      source:
        description: Source associated with this partner topic. This represents a unique partner resource.
        type: string
      eventTypeInfo:
        $ref: '#/definitions/EventTypeInfo'
        description: Event Type information from the corresponding event channel.
      expirationTimeIfNotActivatedUtc:
        format: date-time
        description: "Expiration time of the partner topic. If this timer expires while the partner topic is still never activated,\r\nthe partner topic and corresponding event channel are deleted."
        type: string
      provisioningState:
        description: Provisioning state of the partner topic.
        enum:
        - Creating
        - Updating
        - Deleting
        - Succeeded
        - Canceled
        - Failed
        type: string
        readOnly: true
        x-ms-enum:
          name: PartnerTopicProvisioningState
          modelAsString: true
      activationState:
        description: Activation state of the partner topic.
        enum:
        - NeverActivated
        - Activated
        - Deactivated
        type: string
        x-ms-enum:
          name: PartnerTopicActivationState
          modelAsString: true
      partnerTopicFriendlyDescription:
        description: "Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic.\r\nThis will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer."
        type: string
      messageForActivation:
        description: Context or helpful message that can be used during the approval process by the subscriber.
        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.\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'
  PartnerTopic:
    description: Event Grid Partner Topic.
    type: object
    allOf:
    - $ref: '#/definitions/TrackedResource'
    properties:
      properties:
        $ref: '#/definitions/PartnerTopicProperties'
        description: Properties of the Partner Topic.
        x-ms-client-flatten: true
      systemData:
        description: The system metadata relating to Partner Topic resource.
        type: object
        readOnly: true
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
      identity:
        $ref: '#/definitions/IdentityInfo'
        description: Identity information for the Partner Topic resource.
  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:\r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.\r\nThis property is currently not used and reserved for future usage."
        type: object
        additionalProperties:
          $ref: '#/definitions/UserIdentityProperties'
  PartnerTopicsListResult:
    description: Result of the List Partner Topics operation.
    type: object
    properties:
      value:
        description: A collection of partner topics.
        type: array
        items:
          $ref: '#/definitions/PartnerTopic'
      nextLink:
        description: A link for the next page of partner topics.
        type: string
  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
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
    type: string
    x-ms-parameter-location: method
  ApiVersionParameter:
    name: api-version
    in: query
    description: Version of the API to be used with the client request.
    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
  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
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'