Microsoft Azure PartnerConfigurations API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector PartnerConfigurations API
schemes:
- https
tags:
- name: PartnerConfigurations
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default
  : get:
      tags:
      - PartnerConfigurations
      summary: Microsoft Azure Get A Partner Configuration
      description: Get properties of a partner configuration.
      operationId: microsoftAzurePartnerconfigurationsGet
      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'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerConfiguration'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerConfigurations_Get:
          $ref: ./examples/PartnerConfigurations_Get.json
    put:
      tags:
      - PartnerConfigurations
      summary: Microsoft Azure Create Or Update A Partner Configuration
      description: Synchronously creates or updates a partner configuration with the specified parameters.
      operationId: microsoftAzurePartnerconfigurationsCreateorupdate
      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: partnerConfigurationInfo
        in: body
        description: Partner configuration information.
        required: true
        schema:
          $ref: '#/definitions/PartnerConfiguration'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerConfiguration'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/PartnerConfiguration'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerConfigurations_CreateOrUpdate:
          $ref: ./examples/PartnerConfigurations_CreateOrUpdate.json
      x-ms-long-running-operation: true
    delete:
      tags:
      - PartnerConfigurations
      summary: Microsoft Azure Delete A Partner Configuration
      description: Delete existing partner configuration.
      operationId: microsoftAzurePartnerconfigurationsDelete
      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'
      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:
        PartnerConfigurations_Delete:
          $ref: ./examples/PartnerConfigurations_Delete.json
      x-ms-long-running-operation: true
    patch:
      tags:
      - PartnerConfigurations
      summary: Microsoft Azure Update A Partner Configuration
      description: Synchronously updates a partner configuration with the specified parameters.
      operationId: microsoftAzurePartnerconfigurationsUpdate
      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: partnerConfigurationUpdateParameters
        in: body
        description: Partner configuration update information.
        required: true
        schema:
          $ref: '#/definitions/PartnerConfigurationUpdateParameters'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerConfiguration'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/PartnerConfiguration'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerConfigurations_Update:
          $ref: ./examples/PartnerConfigurations_Update.json
      x-ms-long-running-operation: true
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations:
    get:
      tags:
      - PartnerConfigurations
      summary: Microsoft Azure List Partner Configurations Under A Resource Group
      description: List all the partner configurations under a resource group.
      operationId: microsoftAzurePartnerconfigurationsListbyresourcegroup
      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'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerConfigurationsListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerConfigurations_ListByResourceGroup:
          $ref: ./examples/PartnerConfigurations_ListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: null
  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerConfigurations:
    get:
      tags:
      - PartnerConfigurations
      summary: Microsoft Azure List Partner Configurations Under An Azure Subscription
      description: List all the partner configurations under an Azure subscription.
      operationId: microsoftAzurePartnerconfigurationsListbysubscription
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/FilterParameter'
      - $ref: '#/parameters/TopParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerConfigurationsListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerConfigurations_ListBySubscription:
          $ref: ./examples/PartnerConfigurations_ListBySubscription.json
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default/authorizePartner
  : post:
      tags:
      - PartnerConfigurations
      summary: Microsoft Azure Authorize A Partner
      description: Authorize a single partner either by partner registration immutable Id or by partner name.
      operationId: microsoftAzurePartnerconfigurationsAuthorizepartner
      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: partnerInfo
        in: body
        description: The information of the partner to be authorized.
        required: true
        schema:
          $ref: '#/definitions/Partner'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerConfiguration'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerConfigurations_AuthorizePartner:
          $ref: ./examples/PartnerConfigurations_AuthorizePartner.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default/unauthorizePartner
  : post:
      tags:
      - PartnerConfigurations
      summary: Microsoft Azure Unauthorize A Partner
      description: Unauthorize a single partner either by partner registration immutable Id or by partner name.
      operationId: microsoftAzurePartnerconfigurationsUnauthorizepartner
      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: partnerInfo
        in: body
        description: The information of the partner to be unauthorized.
        required: true
        schema:
          $ref: '#/definitions/Partner'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerConfiguration'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerConfigurations_UnauthorizePartner:
          $ref: ./examples/PartnerConfigurations_UnauthorizePartner.json
definitions:
  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
  PartnerConfigurationProperties:
    description: Properties of the partner configuration.
    type: object
    properties:
      partnerAuthorization:
        $ref: '#/definitions/PartnerAuthorization'
        description: The details of authorized partners.
      provisioningState:
        description: Provisioning state of the partner configuration.
        enum:
        - Creating
        - Updating
        - Deleting
        - Succeeded
        - Canceled
        - Failed
        type: string
        x-ms-enum:
          name: PartnerConfigurationProvisioningState
          modelAsString: true
  PartnerConfiguration:
    description: Partner configuration information
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/PartnerConfigurationProperties'
        description: Properties of the partner configuration.
        x-ms-client-flatten: true
      systemData:
        description: The system metadata relating to partner configuration resource.
        type: object
        readOnly: true
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
      location:
        description: Location of the resource.
        type: string
      tags:
        description: Tags of the resource.
        type: object
        additionalProperties:
          type: string
  PartnerConfigurationUpdateParameterProperties:
    description: Information of partner configuration update parameter properties.
    type: object
    properties:
      defaultMaximumExpirationTimeInDays:
        format: int32
        description: The default time used to validate the maximum expiration time for each authorized partners in days. Allowed values ar between 1 and 365 days.
        type: integer
  PartnerAuthorization:
    description: The partner authorization details.
    type: object
    properties:
      defaultMaximumExpirationTimeInDays:
        format: int32
        description: "Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is\r\nnot specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days."
        type: integer
      authorizedPartnersList:
        description: The list of authorized partners.
        type: array
        items:
          $ref: '#/definitions/Partner'
        x-ms-identifiers: []
  PartnerConfigurationsListResult:
    description: Result of the List partner configurations operation
    type: object
    properties:
      value:
        description: A collection of partner configurations.
        type: array
        items:
          $ref: '#/definitions/PartnerConfiguration'
      nextLink:
        description: A link for the next page of partner configurations.
        type: string
  PartnerConfigurationUpdateParameters:
    description: Properties of the partner configuration update.
    type: object
    properties:
      tags:
        description: Tags of the partner configuration resource.
        type: object
        additionalProperties:
          type: string
      properties:
        $ref: '#/definitions/PartnerConfigurationUpdateParameterProperties'
        description: Properties of the Topic resource.
        x-ms-client-flatten: true
  Partner:
    description: Information about the partner.
    type: object
    properties:
      partnerRegistrationImmutableId:
        format: uuid
        description: The immutableId of the corresponding partner registration.
        type: string
      partnerName:
        description: The partner name.
        type: string
      authorizationExpirationTimeInUtc:
        format: date-time
        description: "Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's\r\ncontext will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration.\r\nIf not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified."
        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'