Microsoft Azure PartnerNamespaces API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Partner Namespaces API
tags:
- name: PartnerNamespaces
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}
  : get:
      tags:
      - PartnerNamespaces
      summary: Microsoft Azure Get A Partner Namespace
      description: Get properties of a partner namespace.
      operationId: microsoftAzurePartnernamespacesGet
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        schema:
          type: string
      - name: partnerNamespaceName
        in: path
        description: Name of the partner namespace.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerNamespace'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerNamespaces_Get:
          $ref: ./examples/PartnerNamespaces_Get.json
    put:
      tags:
      - PartnerNamespaces
      summary: Microsoft Azure Create A Partner Namespace
      description: Asynchronously creates a new partner namespace with the specified parameters.
      operationId: microsoftAzurePartnernamespacesCreateorupdate
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        schema:
          type: string
      - name: partnerNamespaceName
        in: path
        description: Name of the partner namespace.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerNamespace'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerNamespaces_CreateOrUpdate:
          $ref: ./examples/PartnerNamespaces_CreateOrUpdate.json
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartnerNamespace'
        description: PartnerNamespace information.
        required: true
    delete:
      tags:
      - PartnerNamespaces
      summary: Microsoft Azure Delete A Partner Namespace
      description: Delete existing partner namespace.
      operationId: microsoftAzurePartnernamespacesDelete
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        schema:
          type: string
      - name: partnerNamespaceName
        in: path
        description: Name of the partner namespace.
        required: true
        schema:
          type: string
      - $ref: '#/components/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:
        PartnerNamespaces_Delete:
          $ref: ./examples/PartnerNamespaces_Delete.json
      x-ms-long-running-operation: true
    patch:
      tags:
      - PartnerNamespaces
      summary: Microsoft Azure Update A Partner Namespace
      description: Asynchronously updates a partner namespace with the specified parameters.
      operationId: microsoftAzurePartnernamespacesUpdate
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        schema:
          type: string
      - name: partnerNamespaceName
        in: path
        description: Name of the partner namespace.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        '201':
          description: Partner namespace update request accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerNamespace'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerNamespaces_Update:
          $ref: ./examples/PartnerNamespaces_Update.json
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartnerNamespaceUpdateParameters'
        description: Partner namespace update information.
        required: true
  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerNamespaces:
    get:
      tags:
      - PartnerNamespaces
      summary: Microsoft Azure List Partner Namespaces Under An Azure Subscription
      description: List all the partner namespaces under an Azure subscription.
      operationId: microsoftAzurePartnernamespacesListbysubscription
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/FilterParameter'
      - $ref: '#/components/parameters/TopParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerNamespacesListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerNamespaces_ListBySubscription:
          $ref: ./examples/PartnerNamespaces_ListBySubscription.json
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces:
    get:
      tags:
      - PartnerNamespaces
      summary: Microsoft Azure List Partner Namespaces Under A Resource Group
      description: List all the partner namespaces under a resource group.
      operationId: microsoftAzurePartnernamespacesListbyresourcegroup
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/FilterParameter'
      - $ref: '#/components/parameters/TopParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerNamespacesListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerNamespaces_ListByResourceGroup:
          $ref: ./examples/PartnerNamespaces_ListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/listKeys
  : post:
      tags:
      - PartnerNamespaces
      summary: Microsoft Azure List Keys For A Partner Namespace
      description: List the two keys used to publish to a partner namespace.
      operationId: microsoftAzurePartnernamespacesListsharedaccesskeys
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        schema:
          type: string
      - name: partnerNamespaceName
        in: path
        description: Name of the partner namespace.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerNamespaceSharedAccessKeys'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerNamespaces_ListSharedAccessKeys:
          $ref: ./examples/PartnerNamespaces_ListSharedAccessKeys.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/regenerateKey
  : post:
      tags:
      - PartnerNamespaces
      summary: Microsoft Azure Regenerate Key For A Partner Namespace
      description: Regenerate a shared access key for a partner namespace.
      operationId: microsoftAzurePartnernamespacesRegeneratekey
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        schema:
          type: string
      - name: partnerNamespaceName
        in: path
        description: Name of the partner namespace.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerNamespaceSharedAccessKeys'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        PartnerNamespaces_RegenerateKey:
          $ref: ./examples/PartnerNamespaces_RegenerateKey.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartnerNamespaceRegenerateKeyRequest'
        description: Request body to regenerate key.
        required: true
components:
  schemas:
    PartnerNamespaceSharedAccessKeys:
      description: Shared access keys of the partner namespace.
      type: object
      properties:
        key1:
          description: Shared access key1 for the partner namespace.
          type: string
        key2:
          description: Shared access key2 for the partner namespace.
          type: string
    PrivateEndpointConnectionProperties:
      description: Properties of the private endpoint connection resource.
      type: object
      properties:
        privateEndpoint:
          $ref: '#/components/schemas/PrivateEndpoint'
          description: The Private Endpoint resource for this Connection.
        groupIds:
          description: GroupIds from the private link service resource.
          type: array
          items:
            type: string
        privateLinkServiceConnectionState:
          $ref: '#/components/schemas/ConnectionState'
          description: Details about the state of the connection.
        provisioningState:
          description: Provisioning state of the Private Endpoint Connection.
          enum:
          - Creating
          - Updating
          - Deleting
          - Succeeded
          - Canceled
          - Failed
          type: string
          x-ms-enum:
            name: ResourceProvisioningState
            modelAsString: true
    PartnerNamespace:
      description: EventGrid Partner Namespace.
      type: object
      allOf:
      - $ref: '#/components/schemas/TrackedResource'
      properties:
        properties:
          $ref: '#/components/schemas/PartnerNamespaceProperties'
          description: Properties of the Partner Namespace.
          x-ms-client-flatten: true
        systemData:
          description: The system metadata relating to Partner Namespace resource.
          type: object
          readOnly: true
          $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
    PartnerNamespaceProperties:
      description: Properties of the partner namespace.
      type: object
      properties:
        privateEndpointConnections:
          type: array
          items:
            $ref: '#/components/schemas/PrivateEndpointConnection'
          readOnly: true
        provisioningState:
          description: Provisioning state of the partner namespace.
          enum:
          - Creating
          - Updating
          - Deleting
          - Succeeded
          - Canceled
          - Failed
          type: string
          readOnly: true
          x-ms-enum:
            name: PartnerNamespaceProvisioningState
            modelAsString: true
        partnerRegistrationFullyQualifiedId:
          description: 'The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format:

            /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.'
          type: string
        endpoint:
          description: Endpoint for the partner namespace.
          type: string
          readOnly: true
        publicNetworkAccess:
          description: 'This determines if traffic is allowed over public network. By default it is enabled.

            You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PartnerNamespaceProperties.InboundIpRules" />'
          enum:
          - Enabled
          - Disabled
          type: string
          x-ms-enum:
            name: PublicNetworkAccess
            modelAsString: true
          default: Enabled
        inboundIpRules:
          description: 'This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.'
          type: array
          items:
            $ref: '#/components/schemas/InboundIpRule'
          x-ms-identifiers: []
        disableLocalAuth:
          description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace.
          default: false
          type: boolean
        partnerTopicRoutingMode:
          description: 'This determines if events published to this partner namespace should use the source attribute in the event payload

            or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic.'
          default: SourceEventAttribute
          enum:
          - SourceEventAttribute
          - ChannelNameHeader
          type: string
          x-ms-enum:
            name: PartnerTopicRoutingMode
            modelAsString: true
    PrivateEndpoint:
      description: PrivateEndpoint information.
      type: object
      properties:
        id:
          description: The ARM identifier for Private Endpoint.
          type: string
    PartnerNamespaceRegenerateKeyRequest:
      description: PartnerNamespace regenerate shared access key request.
      required:
      - keyName
      type: object
      properties:
        keyName:
          description: Key name to regenerate (key1 or key2).
          type: string
    PartnerNamespacesListResult:
      description: Result of the List Partner Namespaces operation
      type: object
      properties:
        value:
          description: A collection of partner namespaces.
          type: array
          items:
            $ref: '#/components/schemas/PartnerNamespace'
        nextLink:
          description: A link for the next page of partner namespaces.
          type: string
    InboundIpRule:
      type: object
      properties:
        ipMask:
          description: IP Address in CIDR notation e.g., 10.0.0.0/8.
          type: string
        action:
          description: Action to perform based on the match or no match of the IpMask.
          enum:
          - Allow
          type: string
          x-ms-enum:
            name: IpActionType
            modelAsString: true
    TrackedResource:
      description: Definition of a Tracked Resource.
      required:
      - location
      type: object
      allOf:
      - $ref: '#/components/schemas/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
    PartnerNamespaceUpdateParameterProperties:
      description: Information of Partner Namespace update parameter properties.
      type: object
      properties:
        publicNetworkAccess:
          description: "This determines if traffic is allowed over public network. By default it is enabled. \nYou can further restrict to specific IPs by configuring <seealso cref=\"P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PartnerNamespaceUpdateParameterProperties.InboundIpRules\" />"
          enum:
          - Enabled
          - Disabled
          type: string
          x-ms-enum:
            name: PublicNetworkAccess
            modelAsString: true
          default: Enabled
        inboundIpRules:
          description: 'This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.'
          type: array
          items:
            $ref: '#/components/schemas/InboundIpRule'
          x-ms-identifiers: []
        disableLocalAuth:
          description: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace.
          type: boolean
    ConnectionState:
      description: ConnectionState information.
      type: object
      properties:
        status:
          description: Status of the connection.
          enum:
          - Pending
          - Approved
          - Rejected
          - Disconnected
          type: string
          x-ms-enum:
            name: PersistedConnectionStatus
            modelAsString: true
        description:
          description: Description of the connection state.
          type: string
        actionsRequired:
          description: Actions required (if any).
          type: string
    PartnerNamespaceUpdateParameters:
      description: Properties of the Partner Namespace update.
      type: object
      properties:
        tags:
          description: Tags of the Partner Namespace.
          type: object
          additionalProperties:
            type: string
        properties:
          $ref: '#/components/schemas/PartnerNamespaceUpdateParameterProperties'
          description: Properties of the Partner Namespace.
          x-ms-client-flatten: true
    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
    PrivateEndpointConnection:
      type: object
      allOf:
      - $ref: '#/components/schemas/Resource'
      properties:
        properties:
          $ref: '#/components/schemas/PrivateEndpointConnectionProperties'
          description: Properties of the PrivateEndpointConnection.
          x-ms-client-flatten: true
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      description: Version of the API to be used with the client request.
      required: true
      schema:
        type: string
    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
      schema:
        type: string
    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
      x-ms-parameter-location: method
      schema:
        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
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'