Microsoft Azure PartnerRegistrations API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector PartnerRegistrations API
schemes:
- https
tags:
- name: PartnerRegistrations
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}
  : get:
      tags:
      - PartnerRegistrations
      summary: Microsoft Azure Get A Partner Registration
      description: Gets a partner registration with the specified parameters.
      operationId: microsoftAzurePartnerregistrationsGet
      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: partnerRegistrationName
        in: path
        description: Name of the partner registration.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerRegistration'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerRegistrations_Get:
          $ref: ./examples/PartnerRegistrations_Get.json
    put:
      tags:
      - PartnerRegistrations
      summary: Microsoft Azure Create A Partner Registration
      description: Creates a new partner registration with the specified parameters.
      operationId: microsoftAzurePartnerregistrationsCreateorupdate
      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: partnerRegistrationName
        in: path
        description: Name of the partner registration.
        required: true
        type: string
      - name: partnerRegistrationInfo
        in: body
        description: PartnerRegistration information.
        required: true
        schema:
          $ref: '#/definitions/PartnerRegistration'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerRegistration'
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/PartnerRegistration'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerRegistrations_CreateOrUpdate:
          $ref: ./examples/PartnerRegistrations_CreateOrUpdate.json
      x-ms-long-running-operation: true
    delete:
      tags:
      - PartnerRegistrations
      summary: Microsoft Azure Delete A Partner Registration
      description: Deletes a partner registration with the specified parameters.
      operationId: microsoftAzurePartnerregistrationsDelete
      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: partnerRegistrationName
        in: path
        description: Name of the partner registration.
        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:
        PartnerRegistrations_Delete:
          $ref: ./examples/PartnerRegistrations_Delete.json
      x-ms-long-running-operation: true
    patch:
      tags:
      - PartnerRegistrations
      summary: Microsoft Azure Update A Partner Registration
      description: Updates a partner registration with the specified parameters.
      operationId: microsoftAzurePartnerregistrationsUpdate
      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: partnerRegistrationName
        in: path
        description: Name of the partner registration.
        required: true
        type: string
      - name: partnerRegistrationUpdateParameters
        in: body
        description: Partner registration update information.
        required: true
        schema:
          $ref: '#/definitions/PartnerRegistrationUpdateParameters'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        '201':
          description: Partner registration update request accepted.
          schema:
            $ref: '#/definitions/PartnerRegistration'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerRegistrations_Update:
          $ref: ./examples/PartnerRegistrations_Update.json
      x-ms-long-running-operation: true
  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerRegistrations:
    get:
      tags:
      - PartnerRegistrations
      summary: Microsoft Azure List Partner Registrations Under An Azure Subscription
      description: List all the partner registrations under an Azure subscription.
      operationId: microsoftAzurePartnerregistrationsListbysubscription
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/FilterParameter'
      - $ref: '#/parameters/TopParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PartnerRegistrationsListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerRegistrations_ListBySubscription:
          $ref: ./examples/PartnerRegistrations_ListBySubscription.json
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations:
    get:
      tags:
      - PartnerRegistrations
      summary: Microsoft Azure List Partner Registrations Under A Resource Group
      description: List all the partner registrations under a resource group.
      operationId: microsoftAzurePartnerregistrationsListbyresourcegroup
      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/PartnerRegistrationsListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerRegistrations_ListByResourceGroup:
          $ref: ./examples/PartnerRegistrations_ListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
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
  PartnerRegistrationUpdateParameters:
    description: Properties of the Partner Registration update.
    type: object
    properties:
      tags:
        description: Tags of the partner registration resource.
        type: object
        additionalProperties:
          type: string
      partnerTopicTypeName:
        description: Name of the partner topic type.
        type: string
      partnerTopicTypeDisplayName:
        description: Display name of the partner topic type.
        type: string
      partnerTopicTypeDescription:
        description: Description of the partner topic type.
        type: string
      setupUri:
        description: "URI of the partner website that can be used by Azure customers to setup Event Grid\r\nintegration on an event source."
        type: string
      logoUri:
        description: URI of the partner logo.
        type: string
      authorizedAzureSubscriptionIds:
        description: "List of IDs of Azure AD applications that are authorized to create a partner namespace\r\nassociated with this partner registration. This is an optional property. Creating\r\npartner namespaces is always permitted under the same Azure subscription as the one used\r\nfor creating the partner registration."
        type: array
        items:
          type: string
  PartnerRegistrationProperties:
    description: Properties of the partner registration.
    type: object
    properties:
      provisioningState:
        description: Provisioning state of the partner registration.
        enum:
        - Creating
        - Updating
        - Deleting
        - Succeeded
        - Canceled
        - Failed
        type: string
        readOnly: true
        x-ms-enum:
          name: PartnerRegistrationProvisioningState
          modelAsString: true
      partnerRegistrationImmutableId:
        format: uuid
        description: The immutableId of the corresponding partner registration.
        type: string
      partnerName:
        description: 'Official name of the partner name. For example: "Contoso".'
        type: string
      partnerResourceTypeName:
        description: Name of the partner resource type.
        type: string
      partnerResourceTypeDisplayName:
        description: Display name of the partner resource type.
        type: string
      partnerResourceTypeDescription:
        description: Short description of the partner resource type. The length of this description should not exceed 256 characters.
        type: string
      longDescription:
        description: "Long description for the custom scenarios and integration to be displayed in the portal if needed.\r\nLength of this description should not exceed 2048 characters."
        type: string
      partnerCustomerServiceNumber:
        description: "The customer service number of the publisher. The expected phone format should start with a '+' sign \r\nfollowed by the country code. The remaining digits are then followed. Only digits and spaces are allowed and its\r\nlength cannot exceed 16 digits including country code. Examples of valid phone numbers are: +1 515 123 4567 and\r\n+966 7 5115 2471. Examples of invalid phone numbers are: +1 (515) 123-4567, 1 515 123 4567 and +966 121 5115 24 7 551 1234 43"
        type: string
      partnerCustomerServiceExtension:
        description: The extension of the customer service number of the publisher. Only digits are allowed and number of digits should not exceed 10.
        type: string
      customerServiceUri:
        description: The extension of the customer service URI of the publisher.
        type: string
      setupUri:
        description: "URI of the partner website that can be used by Azure customers to setup Event Grid\r\nintegration on an event source."
        type: string
      logoUri:
        description: URI of the logo.
        type: string
      visibilityState:
        description: Visibility state of the partner registration.
        enum:
        - Hidden
        - PublicPreview
        - GenerallyAvailable
        type: string
        x-ms-enum:
          name: PartnerRegistrationVisibilityState
          modelAsString: true
      authorizedAzureSubscriptionIds:
        description: "List of Azure subscription Ids that are authorized to create a partner namespace\r\nassociated with this partner registration. This is an optional property. Creating\r\npartner namespaces is always permitted under the same Azure subscription as the one used\r\nfor creating the partner registration."
        type: array
        items:
          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
  PartnerRegistrationsListResult:
    description: Result of the List Partner Registrations operation.
    type: object
    properties:
      value:
        description: A collection of partner registrations.
        type: array
        items:
          $ref: '#/definitions/PartnerRegistration'
      nextLink:
        description: A link for the next page of partner registrations.
        type: string
  PartnerRegistration:
    description: Information about a partner registration.
    type: object
    allOf:
    - $ref: '#/definitions/TrackedResource'
    properties:
      properties:
        $ref: '#/definitions/PartnerRegistrationProperties'
        description: Properties of the partner registration.
        x-ms-client-flatten: true
      systemData:
        description: The system metadata relating to Partner Registration resource.
        type: object
        readOnly: true
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
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'