Microsoft Azure Topics API

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.
 

# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-topics-api-openapi.yml