swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector PartnerDestinations API
schemes:
- https
tags:
- name: PartnerDestinations
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations/{partnerDestinationName}
  : get:
      tags:
      - PartnerDestinations
      summary: Microsoft Azure Get A Partner Destination
      description: Get properties of a partner destination.
      operationId: microsoftAzurePartnerdestinationsGet
      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: partnerDestinationName
        in: path
        description: Name of the partner destination.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerDestination'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerDestinations_Get:
          $ref: ./examples/PartnerDestinations_Get.json
    put:
      tags:
      - PartnerDestinations
      summary: Microsoft Azure Create A Partner Destination
      description: Asynchronously creates a new partner destination with the specified parameters.
      operationId: microsoftAzurePartnerdestinationsCreateorupdate
      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: partnerDestinationName
        in: path
        description: Name of the partner destination.
        required: true
        type: string
      - name: partnerDestination
        in: body
        description: Partner destination create information.
        required: true
        schema:
          $ref: '#/definitions/PartnerDestination'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerDestination'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/PartnerDestination'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerDestinations_CreateOrUpdate:
          $ref: ./examples/PartnerDestinations_CreateOrUpdate.json
    delete:
      tags:
      - PartnerDestinations
      summary: Microsoft Azure Delete A Partner Destination
      description: Delete existing partner destination.
      operationId: microsoftAzurePartnerdestinationsDelete
      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: partnerDestinationName
        in: path
        description: Name of the partner destination.
        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:
        PartnerDestinations_Delete:
          $ref: ./examples/PartnerDestinations_Delete.json
      x-ms-long-running-operation: true
    patch:
      tags:
      - PartnerDestinations
      summary: Microsoft Azure Update A Partner Destination
      description: Asynchronously updates a partner destination with the specified parameters.
      operationId: microsoftAzurePartnerdestinationsUpdate
      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: partnerDestinationName
        in: path
        description: Name of the partner destination.
        required: true
        type: string
      - name: partnerDestinationUpdateParameters
        in: body
        description: Partner destination update information.
        required: true
        schema:
          $ref: '#/definitions/PartnerDestinationUpdateParameters'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        '201':
          description: Partner Destination update request accepted.
          schema:
            $ref: '#/definitions/PartnerDestination'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerDestinations_Update:
          $ref: ./examples/PartnerDestinations_Update.json
  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerDestinations:
    get:
      tags:
      - PartnerDestinations
      summary: Microsoft Azure List Partner Destinations Under An Azure Subscription
      description: List all the partner destinations under an Azure subscription.
      operationId: microsoftAzurePartnerdestinationsListbysubscription
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/FilterParameter'
      - $ref: '#/parameters/TopParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerDestinationsListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerDestinations_ListBySubscription:
          $ref: ./examples/PartnerDestinations_ListBySubscription.json
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations:
    get:
      tags:
      - PartnerDestinations
      summary: Microsoft Azure List Partner Destinations Under A Resource Group
      description: List all the partner destinations under a resource group.
      operationId: microsoftAzurePartnerdestinationsListbyresourcegroup
      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/PartnerDestinationsListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerDestinations_ListByResourceGroup:
          $ref: ./examples/PartnerDestinations_ListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations/{partnerDestinationName}/activate
  : post:
      tags:
      - PartnerDestinations
      summary: Microsoft Azure Activate A Partner Destination
      description: Activate a newly created partner destination.
      operationId: microsoftAzurePartnerdestinationsActivate
      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: partnerDestinationName
        in: path
        description: Name of the partner destination.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerDestination'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerDestinations_Activate:
          $ref: ./examples/PartnerDestinations_Activate.json
definitions:
  PartnerDestinationUpdateParameters:
    description: Properties of the Partner Destination that can be updated.
    type: object
    properties:
      tags:
        description: Tags of the Partner Destination resource.
        type: object
        additionalProperties:
          type: string
  PartnerDestinationsListResult:
    description: Result of the List Partner Destinations operation.
    type: object
    properties:
      value:
        description: A collection of partner destinations.
        type: array
        items:
          $ref: '#/definitions/PartnerDestination'
      nextLink:
        description: A link for the next page of partner destinations.
        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
  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
  PartnerDestination:
    description: Event Grid Partner Destination.
    type: object
    allOf:
    - $ref: '#/definitions/TrackedResource'
    properties:
      properties:
        $ref: '#/definitions/PartnerDestinationProperties'
        description: Properties of the Partner Destination.
        x-ms-client-flatten: true
      systemData:
        description: The system metadata relating to Partner Destination resource.
        type: object
        readOnly: true
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
  PartnerDestinationProperties:
    description: Properties of the Partner Destination.
    type: object
    properties:
      partnerRegistrationImmutableId:
        format: uuid
        description: The immutable Id of the corresponding partner registration.
        type: string
      endpointServiceContext:
        description: Endpoint context associated with this partner destination.
        type: string
      expirationTimeIfNotActivatedUtc:
        format: date-time
        description: "Expiration time of the partner destination. If this timer expires and the partner destination was never activated,\r\nthe partner destination and corresponding channel are deleted."
        type: string
      provisioningState:
        description: Provisioning state of the partner destination.
        enum:
        - Creating
        - Updating
        - Deleting
        - Succeeded
        - Canceled
        - Failed
        type: string
        x-ms-enum:
          name: PartnerDestinationProvisioningState
          modelAsString: true
      activationState:
        description: Activation state of the partner destination.
        enum:
        - NeverActivated
        - Activated
        type: string
        x-ms-enum:
          name: PartnerDestinationActivationState
          modelAsString: true
      endpointBaseUrl:
        description: Endpoint Base URL of the partner destination
        type: string
      messageForActivation:
        description: Context or helpful message that can be used during the approval process.
        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'