swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Topics API
schemes:
- https
tags:
- name: Topics
paths:
  /topics/{topicName}:publish:
    post:
      operationId: microsoftAzurePublishcloudevent
      description: 'Publish Single Cloud Event to namespace topic. In case of success, the server responds with an HTTP 200 status code with an empty JSON object in response. Otherwise, the server can return various error codes. For example, 401: which indicates authorization failure, 403: which indicates quota exceeded or message is too large, 410: which indicates that specific topic is not found, 400: for bad request, and 500: for internal server error. '
      consumes:
      - application/cloudevents+json; charset=utf-8
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: topicName
        in: path
        description: Topic Name.
        required: true
        type: string
      - name: event
        in: body
        description: Single Cloud Event being published.
        required: true
        schema:
          $ref: '#/definitions/CloudEvent'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PublishResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      summary: Microsoft Azure Post Topics Topicname:publish
      tags:
      - Topics
  /topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:receive:
    post:
      operationId: microsoftAzureReceivecloudevents
      description: Receive Batch of Cloud Events from the Event Subscription.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: topicName
        in: path
        description: Topic Name.
        required: true
        type: string
      - name: eventSubscriptionName
        in: path
        description: Event Subscription Name.
        required: true
        type: string
      - name: maxEvents
        in: query
        description: Max Events count to be received. Minimum value is 1, while maximum value is 100 events. If not specified, the default value is 1.
        required: false
        type: integer
        format: int32
        default: 1
        minimum: 1
        maximum: 100
      - name: maxWaitTime
        in: query
        description: Max wait time value for receive operation in Seconds. It is the time in seconds that the server approximately waits for the availability of an event and responds to the request. If an event is available, the broker responds immediately to the client. Minimum value is 10 seconds, while maximum value is 120 seconds. If not specified, the default value is 60 seconds.
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/ReceiveResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Receive Cloud Event:
          $ref: ./examples/receive.json
      summary: Microsoft Azure Post Topics Topicname Eventsubscriptions Eventsubscriptionname:receive
      tags:
      - Topics
  /topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:acknowledge:
    post:
      operationId: microsoftAzureAcknowledgecloudevents
      description: Acknowledge batch of Cloud Events. The server responds with an HTTP 200 status code if the request is successfully accepted. The response body will include the set of successfully acknowledged lockTokens, along with other failed lockTokens with their corresponding error information. Successfully acknowledged events will no longer be available to any consumer.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: topicName
        in: path
        description: Topic Name.
        required: true
        type: string
      - name: eventSubscriptionName
        in: path
        description: Event Subscription Name.
        required: true
        type: string
      - name: acknowledgeOptions
        in: body
        description: AcknowledgeOptions.
        required: true
        schema:
          $ref: '#/definitions/AcknowledgeOptions'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/AcknowledgeResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Acknowledge Cloud Event:
          $ref: ./examples/ack.json
      summary: Microsoft Azure Post Topics Topicname Eventsubscriptions Eventsubscriptionname:acknowledge
      tags:
      - Topics
  /topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:release:
    post:
      operationId: microsoftAzureReleasecloudevents
      description: Release batch of Cloud Events. The server responds with an HTTP 200 status code if the request is successfully accepted. The response body will include the set of successfully released lockTokens, along with other failed lockTokens with their corresponding error information.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: topicName
        in: path
        description: Topic Name.
        required: true
        type: string
      - name: eventSubscriptionName
        in: path
        description: Event Subscription Name.
        required: true
        type: string
      - name: releaseDelayInSeconds
        in: query
        description: Release cloud events with the specified delay in seconds.
        required: false
        type: number
        enum:
        - 0
        - 10
        - 60
        - 600
        - 3600
        x-ms-enum:
          name: ReleaseDelay
          modelAsString: true
          values:
          - name: By0Seconds
            value: 0
            description: Release the event after 0 seconds.
          - name: By10Seconds
            value: 10
            description: Release the event after 10 seconds.
          - name: By60Seconds
            value: 60
            description: Release the event after 60 seconds.
          - name: By600Seconds
            value: 600
            description: Release the event after 600 seconds.
          - name: By3600Seconds
            value: 3600
            description: Release the event after 3600 seconds.
      - name: releaseOptions
        in: body
        description: ReleaseOptions
        required: true
        schema:
          $ref: '#/definitions/ReleaseOptions'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/ReleaseResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Release Cloud Event with an optional delay.:
          $ref: ./examples/release.json
      summary: Microsoft Azure Post Topics Topicname Eventsubscriptions Eventsubscriptionname:release
      tags:
      - Topics
  /topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:reject:
    post:
      operationId: microsoftAzureRejectcloudevents
      description: Reject batch of Cloud Events. The server responds with an HTTP 200 status code if the request is successfully accepted. The response body will include the set of successfully rejected lockTokens, along with other failed lockTokens with their corresponding error information.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: topicName
        in: path
        description: Topic Name.
        required: true
        type: string
      - name: eventSubscriptionName
        in: path
        description: Event Subscription Name.
        required: true
        type: string
      - name: rejectOptions
        in: body
        description: RejectOptions
        required: true
        schema:
          $ref: '#/definitions/RejectOptions'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/RejectResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Reject Cloud Event:
          $ref: ./examples/reject.json
      summary: Microsoft Azure Post Topics Topicname Eventsubscriptions Eventsubscriptionname:reject
      tags:
      - Topics
  /topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:renewLock:
    post:
      operationId: microsoftAzureRenewcloudeventlocks
      description: Renew lock for batch of Cloud Events. The server responds with an HTTP 200 status code if the request is successfully accepted. The response body will include the set of successfully renewed lockTokens, along with other failed lockTokens with their corresponding error information.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: topicName
        in: path
        description: Topic Name.
        required: true
        type: string
      - name: eventSubscriptionName
        in: path
        description: Event Subscription Name.
        required: true
        type: string
      - name: renewLockOptions
        in: body
        description: RenewLockOptions
        required: true
        schema:
          $ref: '#/definitions/RenewLockOptions'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/RenewCloudEventLocksResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Renew lock for batch of Cloud Events:
          $ref: ./examples/renewlock.json
      summary: Microsoft Azure Post Topics Topicname Eventsubscriptions Eventsubscriptionname:renewlock
      tags:
      - Topics
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}:
    get:
      tags:
      - Topics
      summary: Microsoft Azure Get A Topic
      description: Get properties of a topic.
      operationId: microsoftAzureTopicsGet
      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: topicName
        in: path
        description: Name of the topic.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Topic'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Topics_Get:
          $ref: ./examples/Topics_Get.json
    put:
      tags:
      - Topics
      summary: Microsoft Azure Create A Topic
      description: Asynchronously creates a new topic with the specified parameters.
      operationId: microsoftAzureTopicsCreateorupdate
      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: topicName
        in: path
        description: Name of the topic.
        required: true
        type: string
      - name: topicInfo
        in: body
        description: Topic information.
        required: true
        schema:
          $ref: '#/definitions/Topic'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Topic'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Topics_CreateOrUpdate:
          $ref: ./examples/Topics_CreateOrUpdate.json
        Topics_CreateOrUpdateForAzureArc:
          $ref: ./examples/Topics_CreateOrUpdateForAzureArc.json
      x-ms-long-running-operation: true
    delete:
      tags:
      - Topics
      summary: Microsoft Azure Delete A Topic
      description: Delete existing topic.
      operationId: microsoftAzureTopicsDelete
      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: topicName
        in: path
        description: Name of the topic.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '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:
        Topics_Delete:
          $ref: ./examples/Topics_Delete.json
      x-ms-long-running-operation: true
    patch:
      tags:
      - Topics
      summary: Microsoft Azure Update A Topic
      description: Asynchronously updates a topic with the specified parameters.
      operationId: microsoftAzureTopicsUpdate
      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: topicName
        in: path
        description: Name of the topic.
        required: true
        type: string
      - name: topicUpdateParameters
        in: body
        description: Topic update information.
        required: true
        schema:
          $ref: '#/definitions/TopicUpdateParameters'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        '201':
          description: Topic update request accepted.
          schema:
            $ref: '#/definitions/Topic'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Topics_Update:
          $ref: ./examples/Topics_Update.json
      x-ms-long-running-operation: true
  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topics:
    get:
      tags:
      - Topics
      summary: Microsoft Azure List Topics Under An Azure Subscription
      description: List all the topics under an Azure subscription.
      operationId: microsoftAzureTopicsListbysubscription
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/FilterParameter'
      - $ref: '#/parameters/TopParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/TopicsListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Topics_ListBySubscription:
          $ref: ./examples/Topics_ListBySubscription.json
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics:
    get:
      tags:
      - Topics
      summary: Microsoft Azure List Topics Under A Resource Group
      description: List all the topics under a resource group.
      operationId: microsoftAzureTopicsListbyresourcegroup
      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/TopicsListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Topics_ListByResourceGroup:
          $ref: ./examples/Topics_ListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/listKeys
  : post:
      tags:
      - Topics
      summary: Microsoft Azure List Keys For A Topic
      description: List the two keys used to publish to a topic.
      operationId: microsoftAzureTopicsListsharedaccesskeys
      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: topicName
        in: path
        description: Name of the topic.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/TopicSharedAccessKeys'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Topics_ListSharedAccessKeys:
          $ref: ./examples/Topics_ListSharedAccessKeys.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/regenerateKey
  : post:
      tags:
      - Topics
      summary: Microsoft Azure Regenerate Key For A Topic
      description: Regenerate a shared access key for a topic.
      operationId: microsoftAzureTopicsRegeneratekey
      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: topicName
        in: path
        description: Name of the topic.
        required: true
        type: string
      - name: regenerateKeyRequest
        in: body
        description: Request body to regenerate key.
        required: true
        schema:
          $ref: '#/definitions/TopicRegenerateKeyRequest'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/TopicSharedAccessKeys'
        '202':
          description: Accepted
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Topics_RegenerateKey:
          $ref: ./examples/Topics_RegenerateKey.json
      x-ms-long-running-operation: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventTypes
  : get:
      tags:
      - Topics
      summary: Microsoft Azure List Topic Event Types
      description: List event types for a topic.
      operationId: microsoftAzureTopicsListeventtypes
      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: providerNamespace
        in: path
        description: Namespace of the provider of the topic.
        required: true
        type: string
      - name: resourceTypeName
        in: path
        description: Name of the topic type.
        required: true
        type: string
      - name: resourceName
        in: path
        description: Name of the topic.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/EventTypesListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Topics_ListEventTypes:
          $ref: ./examples/Topics_ListEventTypes.json
      x-ms-pageable:
        nextLinkName: null
  /{scope}/providers/Microsoft.EventGrid/extensionTopics/default:
    get:
      tags:
      - Topics
      summary: Microsoft Azure Get Properties Of An Extension Topic
      description: Get the properties of an extension topic.
      operationId: microsoftAzureExtensiontopicsGet
      consumes: []
      produces:
      - application/json
      parameters:
      - name: scope
        in: path
        description: The identifier of the resource to which extension topic is queried. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for Azure resource.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ExtensionTopic'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        ExtensionTopics_Get:
          $ref: ./examples/ExtensionTopics_Get.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics
  : get:
      tags:
      - Topics
      operationId: microsoftAzureTopicsListbynamespace
      x-ms-examples:
        TopicGet:
          $ref: ./examples/Topics/SBTopicListByNameSpace.json
      description: Gets all the topics in a namespace.
      externalDocs:
        url: https://msdn.microsoft.com/en-us/library/azure/mt639388.aspx
      parameters:
      - $ref: ../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../common/v1/definitions.json#/parameters/NamespaceNameParameter
      - $ref: ../../../common/v1/definitions.json#/parameters/ApiVersionParameter
      - $ref: ../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../common/v1/definitions.json#/parameters/SkipParameter
      - $ref: ../../../common/v1/definitions.json#/parameters/TopParameter
      responses:
        '200':
          description: Successfully retrieved list of topics.
          schema:
            $ref: '#/definitions/SBTopicListResult'
        default:
          description: ServiceBus error response describing why the operation failed.
          schema:
            $ref: ../../../common/v1/definitions.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicebus Namespaces Namespacename Topics
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}
  : put:
      tags:
      - Topics
      operationId: microsoftAzureTopicsCreateorupdate
      x-ms-examples:
        TopicCreate:
          $ref: ./examples/Topics/SBTopicCreate.json
      description: Creates a topic in the specified namespace.
      externalDocs:
        url: https://msdn.microsoft.com/en-us/library/azure/mt639409.aspx
      parameters:
      - $ref: ../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../common/v1/definitions.json#/parameters/NamespaceNameParameter
      - $ref: ../../../common/v1/definitions.json#/parameters/TopicNameParameter
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/SBTopic'
        description: Parameters supplied to create a topic resource.
      - $ref: ../../../common/v1/definitions.json#/parameters/ApiVersionParameter
      - $ref: ../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Topic successfully created.
          schema:
            $ref: '#/definitions/SBTopic'
        default:
          description: ServiceBus error response describing why the operation failed.
          schema:
            $ref: ../../../common/v1/definitions.json#/definitions/ErrorResponse
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicebus Namespaces Namespacename Topics Topicname
    delete:
      tags:
      - Topics
      operationId: microsoftAzureTopicsDelete
      x-ms-examples:
        TopicDelete:
          $ref: ./examples/Topics/SBTopicDelete.json
      description: Deletes a topic from the specified namespace and resource group.
      externalDocs:
        url: https://msdn.microsoft.com/en-us/library/azure/mt639404.aspx
      parameters:
      - $ref: ../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../common/v1/definitions.json#/parameters/NamespaceNameParameter
      - $ref: ../../../common/v1/definitions.json#/parameters/TopicNameParameter
      - $ref: ../../../common/v1/definitions.json#/parameters/ApiVersionParameter
      - $ref: ../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Topic successfully deleted.
        '204':
          description: No Content
        default:
          description: ServiceBus error response describing why the operation failed.
          schema:
            $ref: ../../../common/v1/definitions.json#/definitions/ErrorResponse
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicebus Namespaces Namespacename Topics Topicname
    get:
      tags:
      - Topics
      operationId: microsoftAzureTopicsGet
      x-ms-examples:
        TopicGet:
          $ref: ./examples/Topics/SBTopicGet.json
      description: Returns a description for the specified topic.
      externalDocs:
        url: https://msdn.microsoft.com/en-us/library/azure/mt639399.aspx
      parameters:
      - $ref: ../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../common/v1/definitions.json#/parameters/NamespaceNameParameter
      - $ref: ../../../common/v1/definitions.json#/parameters/TopicNameParameter
      - $ref: ../../../common/v1/definitions.json#/parameters/ApiVersionParameter
      - $ref: ../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Topic description successfully retrieved.
          schema:
            $ref: '#/definitions/SBTopic'
        default:
          description: ServiceBus error response describing why the operation failed.
          schema:
            $ref: ../../../common/v1/definitions.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicebus Namespaces Namespacename Topics Topicname
definitions:
  TopicsListResult:
    description: Result of the List Topics operation
    type: object
    properties:
      value:
        description: A collection of Topics
        type: array
        items:
          $ref: '#/definitions/Topic'
      nextLink:
        description: A link for the next page of topics
        type: string
  SBTopicProperties:
    type: object
    properties:
      sizeInBytes:
        readOnly: true
        format: int64
        type: integer
        description: Size of the topic, in bytes.
      createdAt:
        readOnly: true
        format: date-time
        type: string
        description: Exact time the message was created.
      updatedAt:
        readOnly: true
        format: date-time
        type: string
        description: The exact time the message was updated.
      accessedAt:
        readOnly: true
        format: date-time
        type: string
        description: Last time the message was sent, or a request was received, for this topic.
      subscriptionCount:
        readOnly: true
        format: int32
        type: integer
        description: Number of subscriptions.
      countDetails:
        readOnly: true
        $ref: ../../../common/v1/definitions.json#/definitions/MessageCountDetails
        description: Message count details
      defaultMessageTimeToLive:
        format: duration
        type: string
        description: ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.
      maxSizeInMegabytes:
        format: int32
        type: integer
        description: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
      maxMessageSizeInKilobytes:
        format: int64
        type: integer
        description: Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024.
      requiresDuplicateDetection:
        type: boolean
        description: Value indicating if this topic requires duplicate detection.
      duplicateDetectionHistoryTimeWindow:
        format: duration
        type: string
        description: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
      enableBatchedOperations:
        type: boolean
        description: Value that indicates whether server-side batched operations are enabled.
      status:
        $ref: ../../../common/v1/definitions.json#/definitions/EntityStatus
        description: Enumerates the possible values for the status of a messaging entity.
      supportOrdering:
        type: boolean
        description: Value that indicates whether the topic supports ordering.
      autoDeleteOnIdle:
        format: duration
        type: string
        description: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
      enablePartitioning:
        type: boolean
        description: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
      enableExpress:
        type: boolean
        description: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
    description: The Topic Properties definition.
  RejectOptions:
    type: object
    description: Array of lock tokens for the corresponding received Cloud Events to be rejected.
    properties:
      lockTokens:
        type: array
        description: Array of lock tokens.
        items:
          type: string
    required:
    - lockTokens
  PrivateEndpoint:
    description: PrivateEndpoint information.
    type: object
    properties:
      id:
        description: The ARM identifier for Private Endpoint.
        type: string
  TopicRegenerateKeyRequest:
    description: Topic regenerate share access key request
    required:
    - keyName
    type: object
    properties:
      keyName:
        description: Key name to regenerate key1 or key2
        type: string
  ExtendedLocation:
    description: Definition of an Extended Location
    type: object
    properties:
      name:
        description: Fully qualified name of the extended location.
        type: string
      type:
        description: Type of the extended location.
        type: string
  Azure.Core.Foundations.Error:
    type: object
    description: The error object.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      message:
        type: string
        description: A human-readable representation of the error.
      target:
        type: string
        description: The target of the error.
      details:
        type: array
        description: An array of details about specific errors that led to this reported error.
        items:
          $ref: '#/definitions/Azure.Core.Foundations.Error'
        x-ms-identifiers: []
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: An object containing more specific information than the current object about the error.
    required:
    - code
    - message
  EventTypeProperties:
    description: Properties of the event type
    type: object
    properties:
      displayName:
        description: Display name of the event type.
        type: string
      description:
        description: Description of the event type.
        type: string
      schemaUrl:
        description: Url of the schema for this event type.
        type: string
      isInDefaultSet:
        description: IsInDefaultSet flag of the event type.
        type: boolean
  RenewLockOptions:
    type: object
    description: Array of lock tokens for the corresponding received Cloud Events to be renewed.
    properties:
      lockTokens:
        type: array
        description: Array of lock tokens.
        items:
          type: string
    required:
    - lockTokens
  InputSchemaMapping:
    description: By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only supported type of InputSchemaMapping is 'JsonInputSchemaMapping'.
    required:
    - inputSchemaMappingType
    type: object
    properties:
      inputSchemaMappingType:
        description: Type of the custom mapping
        enum:
        - Json
        type: string
        x-ms-enum:
          name: InputSchemaMappingType
          modelAsString: true
    discriminator: inputSchemaMappingType
  ResourceSku:
    description: Describes an EventGrid Resource Sku.
    type: object
    properties:
      name:
        description: 'The Sku name of the resource. The possible values are: Basic or Premium.'
        default: Basic
        enum:
        - Basic
        - Premium
        type: string
        x-ms-enum:
          name: Sku
          modelAsString: true
  Azure.Core.Foundations.ErrorResponse:
    type: object
    description: A response containing error details.
    properties:
      error:
        $ref: '#/definitions/Azure.Core.Foundations.Error'
        description: The error object.
    required:
    - error
  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
  PrivateEndpointConnectionProperties:
    description: Properties of the private endpoint connection resource.
    type: object
    properties:
      privateEndpoint:
        $ref: '#/definitions/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: '#/definitions/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
  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
  TopicSharedAccessKeys:
    description: Shared access keys of the Topic
    type: object
    properties:
      key1:
        description: Shared access key1 for the topic.
        type: string
      key2:
        description: Shared access key2 for the topic.
        type: string
  ReceiveDetails:
    type: object
    description: Receive operation details per Cloud Event.
    properties:
      brokerProperties:
        $ref: '#/definitions/BrokerProperties'
        description: The Event Broker details.
      event:
        $ref: '#/definitions/CloudEvent'
        description: Cloud Event details.
    required:
    - brokerProperties
    - event
  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
  ReceiveResult:
    type: object
    description: Details of the Receive operation response.
    properties:
      value:
        type: array
        description: Array of receive responses, one per cloud event.
        items:
          $ref: '#/definitions/ReceiveDetails'
        x-ms-identifiers: []
    required:
    - value
  TopicUpdateParameters:
    description: Properties of the Topic update
    type: object
    properties:
      tags:
        description: Tags of the Topic resource.
        type: object
        additionalProperties:
          type: string
      identity:
        $ref: '#/definitions/IdentityInfo'
        description: Topic resource identity information.
      properties:
        $ref: '#/definitions/TopicUpdateParameterProperties'
        description: Properties of the Topic resource.
        x-ms-client-flatten: true
      sku:
        $ref: '#/definitions/ResourceSku'
        description: The Sku pricing tier for the topic.
  PublishResult:
    type: object
    description: The result of the Publish operation.
  EventType:
    description: Event Type for a subject under a topic
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/EventTypeProperties'
        description: Properties of the event type.
        x-ms-client-flatten: true
  AcknowledgeOptions:
    type: object
    description: Array of lock tokens for the corresponding received Cloud Events to be acknowledged.
    properties:
      lockTokens:
        type: array
        description: Array of lock tokens.
        items:
          type: string
    required:
    - lockTokens
  AcknowledgeResult:
    type: object
    description: The result of the Acknowledge operation.
    properties:
      failedLockTokens:
        type: array
        description: Array of FailedLockToken for failed cloud events. Each FailedLockToken includes the lock token along with the related error information (namely, the error code and description).
        items:
          $ref: '#/definitions/FailedLockToken'
        x-ms-identifiers: []
      succeededLockTokens:
        type: array
        description: Array of lock tokens for the successfully acknowledged cloud events.
        items:
          type: string
    required:
    - failedLockTokens
    - succeededLockTokens
  BrokerProperties:
    type: object
    description: Properties of the Event Broker operation.
    properties:
      lockToken:
        type: string
        description: The token of the lock on the event.
      deliveryCount:
        type: integer
        format: int32
        description: The attempt count for delivering the event.
    required:
    - lockToken
    - deliveryCount
  SBTopicListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/SBTopic'
        description: Result of the List Topics operation.
      nextLink:
        type: string
        description: Link to the next set of results. Not empty if Value contains incomplete list of topics.
    description: The response to the List Topics operation.
  ExtensionTopicProperties:
    description: Properties of the Extension Topic
    type: object
    properties:
      description:
        description: Description of the extension topic.
        type: string
      systemTopic:
        description: System topic resource id which is mapped to the source.
        type: string
  CloudEvent:
    type: object
    description: Properties of an event published to an Azure Messaging EventGrid Namespace topic using the CloudEvent 1.0 Schema.
    properties:
      id:
        type: string
        description: An identifier for the event. The combination of id and source must be unique for each distinct event.
      source:
        type: string
        description: Identifies the context in which an event happened. The combination of id and source must be unique for each distinct event.
      data:
        description: Event data specific to the event type.
      data_base64:
        type: string
        format: byte
        description: Event data specific to the event type, encoded as a base64 string.
      type:
        type: string
        description: Type of event related to the originating occurrence.
      time:
        type: string
        format: date-time
        description: The time (in UTC) the event was generated, in RFC3339 format.
      specversion:
        type: string
        description: The version of the CloudEvents specification which the event uses.
      dataschema:
        type: string
        description: Identifies the schema that data adheres to.
      datacontenttype:
        type: string
        description: Content type of data value.
      subject:
        type: string
        description: This describes the subject of the event in the context of the event producer (identified by source).
    required:
    - id
    - source
    - type
    - specversion
  PrivateEndpointConnection:
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/PrivateEndpointConnectionProperties'
        description: Properties of the PrivateEndpointConnection.
        x-ms-client-flatten: true
  Azure.Core.Foundations.InnerError:
    type: object
    description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: Inner error.
  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
  ReleaseOptions:
    type: object
    description: Array of lock tokens for the corresponding received Cloud Events to be released.
    properties:
      lockTokens:
        type: array
        description: Array of lock tokens.
        items:
          type: string
    required:
    - lockTokens
  RenewCloudEventLocksResult:
    type: object
    description: The result of the RenewLock operation.
    properties:
      failedLockTokens:
        type: array
        description: Array of FailedLockToken for failed cloud events. Each FailedLockToken includes the lock token along with the related error information (namely, the error code and description).
        items:
          $ref: '#/definitions/FailedLockToken'
        x-ms-identifiers: []
      succeededLockTokens:
        type: array
        description: Array of lock tokens for the successfully renewed locks.
        items:
          type: string
    required:
    - failedLockTokens
    - succeededLockTokens
  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'
  EventTypesListResult:
    description: Result of the List Event Types operation
    type: object
    properties:
      value:
        description: A collection of event types
        type: array
        items:
          $ref: '#/definitions/EventType'
  ReleaseResult:
    type: object
    description: The result of the Release operation.
    properties:
      failedLockTokens:
        type: array
        description: Array of FailedLockToken for failed cloud events. Each FailedLockToken includes the lock token along with the related error information (namely, the error code and description).
        items:
          $ref: '#/definitions/FailedLockToken'
        x-ms-identifiers: []
      succeededLockTokens:
        type: array
        description: Array of lock tokens for the successfully released cloud events.
        items:
          type: string
    required:
    - failedLockTokens
    - succeededLockTokens
  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
  TopicProperties:
    description: Properties of the Topic.
    type: object
    properties:
      privateEndpointConnections:
        type: array
        items:
          $ref: '#/definitions/PrivateEndpointConnection'
        readOnly: true
      provisioningState:
        description: Provisioning state of the topic.
        enum:
        - Creating
        - Updating
        - Deleting
        - Succeeded
        - Canceled
        - Failed
        type: string
        readOnly: true
        x-ms-enum:
          name: TopicProvisioningState
          modelAsString: true
      endpoint:
        description: Endpoint for the topic.
        type: string
        readOnly: true
      inputSchema:
        description: This determines the format that Event Grid should expect for incoming events published to the topic.
        enum:
        - EventGridSchema
        - CustomEventSchema
        - CloudEventSchemaV1_0
        type: string
        x-ms-enum:
          name: InputSchema
          modelAsString: true
        default: EventGridSchema
      inputSchemaMapping:
        $ref: '#/definitions/InputSchemaMapping'
        description: This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema.
      metricResourceId:
        description: Metric resource id for the topic.
        type: string
        readOnly: true
      publicNetworkAccess:
        description: "This determines if traffic is allowed over public network. By default it is enabled. \r\nYou can further restrict to specific IPs by configuring <seealso cref=\"P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.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: '#/definitions/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 topic.
        default: false
        type: boolean
      dataResidencyBoundary:
        description: Data Residency Boundary of the resource.
        enum:
        - WithinGeopair
        - WithinRegion
        type: string
        x-ms-enum:
          name: DataResidencyBoundary
          modelAsString: true
  FailedLockToken:
    type: object
    description: Failed LockToken information.
    properties:
      lockToken:
        type: string
        description: The lock token of an entry in the request.
      error:
        $ref: '#/definitions/Azure.Core.Foundations.Error'
        description: Error information of the failed operation result for the lock token in the request.
    required:
    - lockToken
    - error
  SBTopic:
    type: object
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/SBTopicProperties'
        description: Properties of topic resource.
      systemData:
        readOnly: true
        description: The system meta data relating to this resource.
        $ref: ../../../common/v1/definitions.json#/definitions/systemData
    allOf:
    - $ref: ../../../common/v2/definitions.json#/definitions/ProxyResource
    description: Description of topic resource.
  RejectResult:
    type: object
    description: The result of the Reject operation.
    properties:
      failedLockTokens:
        type: array
        description: Array of FailedLockToken for failed cloud events. Each FailedLockToken includes the lock token along with the related error information (namely, the error code and description).
        items:
          $ref: '#/definitions/FailedLockToken'
        x-ms-identifiers: []
      succeededLockTokens:
        type: array
        description: Array of lock tokens for the successfully rejected cloud events.
        items:
          type: string
    required:
    - failedLockTokens
    - succeededLockTokens
  TopicUpdateParameterProperties:
    description: Information of topic update parameter properties.
    type: object
    properties:
      publicNetworkAccess:
        description: "This determines if traffic is allowed over public network. By default it is enabled. \r\nYou can further restrict to specific IPs by configuring <seealso cref=\"P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicUpdateParameterProperties.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: '#/definitions/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 topic.
        type: boolean
      dataResidencyBoundary:
        description: The data residency boundary for the topic.
        enum:
        - WithinGeopair
        - WithinRegion
        type: string
        x-ms-enum:
          name: DataResidencyBoundary
          modelAsString: true
  ExtensionTopic:
    description: Event grid Extension Topic. This is used for getting Event Grid related metrics for Azure resources.
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/ExtensionTopicProperties'
        description: Properties of the extension topic
        x-ms-client-flatten: true
      systemData:
        description: The system metadata relating to Extension Topic resource.
        type: object
        readOnly: true
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
  Topic:
    description: EventGrid Topic
    type: object
    allOf:
    - $ref: '#/definitions/TrackedResource'
    properties:
      properties:
        $ref: '#/definitions/TopicProperties'
        description: Properties of the topic.
        x-ms-client-flatten: true
      sku:
        $ref: '#/definitions/ResourceSku'
        description: The Sku pricing tier for the topic.
      identity:
        $ref: '#/definitions/IdentityInfo'
        description: Identity information for the resource.
      kind:
        description: Kind of the resource.
        enum:
        - Azure
        - AzureArc
        type: string
        x-ms-enum:
          name: ResourceKind
          modelAsString: true
        default: Azure
      extendedLocation:
        $ref: '#/definitions/ExtendedLocation'
        description: Extended location of the resource.
      systemData:
        description: The system metadata relating to Topic resource.
        type: object
        readOnly: true
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    description: Version of the API to be used with the client request.
    required: true
    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
    type: string
    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
  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
  Azure.Core.Foundations.ApiVersionParameter:
    name: api-version
    in: query
    description: The API version to use for this operation.
    required: true
    type: string
    minLength: 1
    x-ms-parameter-location: method
    x-ms-client-name: apiVersion
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'