{ "swagger": "2.0", "info": { "title": "ServiceBusManagementClient", "version": "2026-01-01", "description": "Azure Service Bus client", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "Operations" }, { "name": "DisasterRecoveryConfigs" }, { "name": "Namespaces" }, { "name": "Namespaces AuthorizationRule" }, { "name": "Queues" }, { "name": "Topics" }, { "name": "PrivateEndpointConnections" }, { "name": "NetworkSecurityPerimeterConfigurations" }, { "name": "ArmDisasterRecoveries" }, { "name": "MigrationConfigs" }, { "name": "Rules" }, { "name": "Subscriptions" } ], "paths": { "/providers/Microsoft.ServiceBus/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "description": "List the operations for the provider", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "OperationsList": { "$ref": "./examples/SBOperations_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/checkNameAvailability": { "post": { "operationId": "Namespaces_CheckNameAvailability", "description": "Check the give namespace name availability.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "name": "parameters", "in": "body", "description": "The request body", "required": true, "schema": { "$ref": "#/definitions/CheckNameAvailability" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/CheckNameAvailabilityResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpaceCheckNameAvailability": { "$ref": "./examples/NameSpaces/SBNameSpaceCheckNameAvailability.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/namespaces": { "get": { "operationId": "Namespaces_List", "tags": [ "Namespaces" ], "description": "Gets all the available namespaces within the subscription, irrespective of the resource groups.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SBNamespaceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpaceList": { "$ref": "./examples/NameSpaces/SBNameSpaceList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces": { "get": { "operationId": "Namespaces_ListByResourceGroup", "tags": [ "Namespaces" ], "description": "Gets the available namespaces within a resource group.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SBNamespaceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpaceListByResourceGroup": { "$ref": "./examples/NameSpaces/SBNameSpaceListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}": { "get": { "operationId": "Namespaces_Get", "tags": [ "Namespaces" ], "description": "Gets a description for the specified namespace.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SBNamespace" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpaceGet": { "$ref": "./examples/NameSpaces/SBNameSpaceGet.json" } } }, "put": { "operationId": "Namespaces_CreateOrUpdate", "tags": [ "Namespaces" ], "description": "Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "parameters", "in": "body", "description": "Parameters supplied to create a namespace resource.", "required": true, "schema": { "$ref": "#/definitions/SBNamespace" } } ], "responses": { "200": { "description": "Resource 'SBNamespace' update operation succeeded", "schema": { "$ref": "#/definitions/SBNamespace" } }, "201": { "description": "Resource 'SBNamespace' create operation succeeded", "schema": { "$ref": "#/definitions/SBNamespace" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpaceCreate": { "$ref": "./examples/NameSpaces/SBNameSpaceCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/SBNamespace" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Namespaces_Update", "tags": [ "Namespaces" ], "description": "Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "parameters", "in": "body", "description": "Parameters supplied to update a namespace resource.", "required": true, "schema": { "$ref": "#/definitions/SBNamespaceUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SBNamespace" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpaceUpdate": { "$ref": "./examples/NameSpaces/SBNameSpaceUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/SBNamespace" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Namespaces_Delete", "tags": [ "Namespaces" ], "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpaceDelete": { "$ref": "./examples/NameSpaces/SBNameSpaceDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules": { "get": { "operationId": "Namespaces_ListAuthorizationRules", "tags": [ "Namespaces AuthorizationRule" ], "description": "Gets the authorization rules for a namespace.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639376.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SBAuthorizationRuleListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpaceAuthorizationRuleListAll": { "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}": { "get": { "operationId": "Namespaces_GetAuthorizationRule", "tags": [ "Namespaces AuthorizationRule" ], "description": "Gets an authorization rule for a namespace by rule name.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639392.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "authorizationRuleName", "in": "path", "description": "The authorization rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SBAuthorizationRule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpaceAuthorizationRuleGet": { "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleGet.json" } } }, "put": { "operationId": "Namespaces_CreateOrUpdateAuthorizationRule", "tags": [ "Namespaces AuthorizationRule" ], "description": "Creates or updates an authorization rule for a namespace.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639410.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "authorizationRuleName", "in": "path", "description": "The authorization rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 }, { "name": "parameters", "in": "body", "description": "The shared access authorization rule.", "required": true, "schema": { "$ref": "#/definitions/SBAuthorizationRule" } } ], "responses": { "200": { "description": "Resource 'SBAuthorizationRule' update operation succeeded", "schema": { "$ref": "#/definitions/SBAuthorizationRule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpaceAuthorizationRuleCreate": { "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleCreate.json" } } }, "delete": { "operationId": "Namespaces_DeleteAuthorizationRule", "tags": [ "Namespaces AuthorizationRule" ], "description": "Deletes a namespace authorization rule.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639417.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "authorizationRuleName", "in": "path", "description": "The authorization rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpaceAuthorizationRuleDelete": { "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys": { "post": { "operationId": "Namespaces_ListKeys", "tags": [ "Namespaces AuthorizationRule" ], "description": "Gets the primary and secondary connection strings for the namespace.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639398.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "authorizationRuleName", "in": "path", "description": "The authorization rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AccessKeys" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpaceAuthorizationRuleListKey": { "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleListKey.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys": { "post": { "operationId": "Namespaces_RegenerateKeys", "tags": [ "Namespaces AuthorizationRule" ], "description": "Regenerates the primary or secondary connection strings for the namespace.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt718977.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "authorizationRuleName", "in": "path", "description": "The authorization rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 }, { "name": "parameters", "in": "body", "description": "Parameters supplied to regenerate the authorization rule.", "required": true, "schema": { "$ref": "#/definitions/RegenerateAccessKeyParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AccessKeys" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpaceAuthorizationRuleRegenerateKey": { "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenerateKey.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs": { "get": { "operationId": "DisasterRecoveryConfigs_List", "tags": [ "ArmDisasterRecoveries" ], "description": "Gets all Alias(Disaster Recovery configurations)", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ArmDisasterRecoveryListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SBAliasList": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}": { "get": { "operationId": "DisasterRecoveryConfigs_Get", "tags": [ "ArmDisasterRecoveries" ], "description": "Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "alias", "in": "path", "description": "The Disaster Recovery configuration name", "required": true, "type": "string", "minLength": 1, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ArmDisasterRecovery" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SBAliasGet": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasGet.json" } } }, "put": { "operationId": "DisasterRecoveryConfigs_CreateOrUpdate", "tags": [ "ArmDisasterRecoveries" ], "description": "Creates or updates a new Alias(Disaster Recovery configuration)", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "alias", "in": "path", "description": "The Disaster Recovery configuration name", "required": true, "type": "string", "minLength": 1, "maxLength": 50 }, { "name": "parameters", "in": "body", "description": "Parameters required to create an Alias(Disaster Recovery configuration)", "required": true, "schema": { "$ref": "#/definitions/ArmDisasterRecovery" } } ], "responses": { "200": { "description": "Resource 'ArmDisasterRecovery' update operation succeeded", "schema": { "$ref": "#/definitions/ArmDisasterRecovery" } }, "201": { "description": "Resource 'ArmDisasterRecovery' create operation succeeded", "schema": { "$ref": "#/definitions/ArmDisasterRecovery" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SBAliasCreate": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasCreate.json" } } }, "delete": { "operationId": "DisasterRecoveryConfigs_Delete", "tags": [ "ArmDisasterRecoveries" ], "description": "Deletes an Alias(Disaster Recovery configuration)", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "alias", "in": "path", "description": "The Disaster Recovery configuration name", "required": true, "type": "string", "minLength": 1, "maxLength": 50 } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SBAliasDelete": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules": { "get": { "operationId": "DisasterRecoveryConfigs_ListAuthorizationRules", "tags": [ "DisasterRecoveryConfigs" ], "description": "Gets the authorization rules for a namespace.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639376.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "alias", "in": "path", "description": "The Disaster Recovery configuration name", "required": true, "type": "string", "minLength": 1, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SBAuthorizationRuleListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpaceAuthorizationRuleListAll": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}": { "get": { "operationId": "DisasterRecoveryConfigs_GetAuthorizationRule", "tags": [ "DisasterRecoveryConfigs" ], "description": "Gets an authorization rule for a namespace by rule name.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639392.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "alias", "in": "path", "description": "The Disaster Recovery configuration name", "required": true, "type": "string", "minLength": 1, "maxLength": 50 }, { "name": "authorizationRuleName", "in": "path", "description": "The authorization rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SBAuthorizationRule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DisasterRecoveryConfigsAuthorizationRuleGet": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleGet.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}/listKeys": { "post": { "operationId": "DisasterRecoveryConfigs_ListKeys", "tags": [ "DisasterRecoveryConfigs" ], "description": "Gets the primary and secondary connection strings for the namespace.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639398.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "alias", "in": "path", "description": "The Disaster Recovery configuration name", "required": true, "type": "string", "minLength": 1, "maxLength": 50 }, { "name": "authorizationRuleName", "in": "path", "description": "The authorization rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AccessKeys" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DisasterRecoveryConfigsAuthorizationRuleListKey": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListKey.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/breakPairing": { "post": { "operationId": "DisasterRecoveryConfigs_BreakPairing", "tags": [ "ArmDisasterRecoveries" ], "description": "This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "alias", "in": "path", "description": "The Disaster Recovery configuration name", "required": true, "type": "string", "minLength": 1, "maxLength": 50 } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SBEHAliasBreakPairing": { "$ref": "./examples/disasterRecoveryConfigs/SBEHAliasBreakPairing.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/failover": { "post": { "operationId": "DisasterRecoveryConfigs_FailOver", "tags": [ "ArmDisasterRecoveries" ], "description": "Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "alias", "in": "path", "description": "The Disaster Recovery configuration name", "required": true, "type": "string", "minLength": 1, "maxLength": 50 }, { "name": "parameters", "in": "body", "description": "Parameters required to create an Alias(Disaster Recovery configuration)", "required": false, "schema": { "$ref": "#/definitions/NamespaceFailoverProperties" } } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SBAliasFailOver": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasFailOver.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/CheckNameAvailability": { "post": { "operationId": "DisasterRecoveryConfigs_CheckNameAvailability", "tags": [ "Namespaces" ], "description": "Check the give namespace name availability.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "parameters", "in": "body", "description": "Parameters to check availability of the given namespace name", "required": true, "schema": { "$ref": "#/definitions/CheckNameAvailability" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CheckNameAvailabilityResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AliasNameAvailability": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasCheckNameAvailability.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/failover": { "post": { "operationId": "Namespaces_Failover", "tags": [ "Namespaces" ], "description": "GeoDR Failover", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "parameters", "in": "body", "description": "Parameters for updating a namespace resource.", "required": true, "schema": { "$ref": "#/definitions/FailOver" } } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpaceCreate": { "$ref": "./examples/NameSpaces/SBNamespaceFailover.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/FailOver" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations": { "get": { "operationId": "MigrationConfigs_List", "tags": [ "MigrationConfigs" ], "description": "Gets all migrationConfigurations", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrationConfigListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MigrationConfigurationsList": { "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}": { "get": { "operationId": "MigrationConfigs_Get", "tags": [ "MigrationConfigs" ], "description": "Retrieves Migration Config", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "configName", "in": "path", "description": "The configuration name. Should always be $default.", "required": true, "type": "string", "enum": [ "$default" ], "x-ms-enum": { "name": "MigrationConfigurationName", "modelAsString": true, "values": [ { "name": "$default", "value": "$default" } ] } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrationConfigProperties" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MigrationConfigurationsGet": { "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationGet.json" } } }, "put": { "operationId": "MigrationConfigs_CreateAndStartMigration", "tags": [ "MigrationConfigs" ], "description": "Creates Migration configuration and starts migration of entities from Standard to Premium namespace", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "configName", "in": "path", "description": "The configuration name. Should always be $default.", "required": true, "type": "string", "enum": [ "$default" ], "x-ms-enum": { "name": "MigrationConfigurationName", "modelAsString": true, "values": [ { "name": "$default", "value": "$default" } ] } }, { "name": "parameters", "in": "body", "description": "Parameters required to create Migration Configuration", "required": true, "schema": { "$ref": "#/definitions/MigrationConfigProperties" } } ], "responses": { "200": { "description": "Resource 'MigrationConfigProperties' update operation succeeded", "schema": { "$ref": "#/definitions/MigrationConfigProperties" } }, "201": { "description": "Resource 'MigrationConfigProperties' create operation succeeded", "schema": { "$ref": "#/definitions/MigrationConfigProperties" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MigrationConfigurationsStartMigration": { "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MigrationConfigProperties" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "MigrationConfigs_Delete", "tags": [ "MigrationConfigs" ], "description": "Deletes a MigrationConfiguration", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "configName", "in": "path", "description": "The configuration name. Should always be $default.", "required": true, "type": "string", "enum": [ "$default" ], "x-ms-enum": { "name": "MigrationConfigurationName", "modelAsString": true, "values": [ { "name": "$default", "value": "$default" } ] } } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MigrationConfigurationsDelete": { "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}/revert": { "post": { "operationId": "MigrationConfigs_Revert", "tags": [ "MigrationConfigs" ], "description": "This operation reverts Migration", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "configName", "in": "path", "description": "The configuration name. Should always be $default.", "required": true, "type": "string", "enum": [ "$default" ], "x-ms-enum": { "name": "MigrationConfigurationName", "modelAsString": true, "values": [ { "name": "$default", "value": "$default" } ] } } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MigrationConfigurationsRevert": { "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationRevert.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}/upgrade": { "post": { "operationId": "MigrationConfigs_CompleteMigration", "tags": [ "MigrationConfigs" ], "description": "This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any entities created after the operation will be under Premium Namespace. CompleteMigration operation will fail when entity migration is in-progress.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "configName", "in": "path", "description": "The configuration name. Should always be $default.", "required": true, "type": "string", "enum": [ "$default" ], "x-ms-enum": { "name": "MigrationConfigurationName", "modelAsString": true, "values": [ { "name": "$default", "value": "$default" } ] } } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MigrationConfigurationsCompleteMigration": { "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkRuleSets": { "get": { "operationId": "Namespaces_ListNetworkRuleSets", "tags": [ "Namespaces" ], "description": "Gets list of NetworkRuleSet for a Namespace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkRuleSetListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpaceNetworkRuleSetList": { "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkRuleSets/default": { "get": { "operationId": "Namespaces_GetNetworkRuleSet", "tags": [ "Namespaces" ], "description": "Gets NetworkRuleSet for a Namespace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkRuleSet" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpaceNetworkRuleSetGet": { "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json" } } }, "put": { "operationId": "Namespaces_CreateOrUpdateNetworkRuleSet", "tags": [ "Namespaces" ], "description": "Create or update NetworkRuleSet for a Namespace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "parameters", "in": "body", "description": "The Namespace IpFilterRule.", "required": true, "schema": { "$ref": "#/definitions/NetworkRuleSet" } } ], "responses": { "200": { "description": "Resource 'NetworkRuleSet' update operation succeeded", "schema": { "$ref": "#/definitions/NetworkRuleSet" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpaceNetworkRuleSetCreate": { "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkSecurityPerimeterConfigurations": { "get": { "operationId": "NetworkSecurityPerimeterConfiguration_List", "tags": [ "NetworkSecurityPerimeterConfigurations" ], "description": "Gets list of current NetworkSecurityPerimeterConfiguration for Namespace", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NamspaceNetworkSecurityPerimeterConfigurationList": { "$ref": "./examples/NameSpaces/NetworkSecurityPerimeterConfigurationList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkSecurityPerimeterConfigurations/{resourceAssociationName}": { "get": { "operationId": "NetworkSecurityPerimeterConfigurations_GetResourceAssociationName", "tags": [ "NetworkSecurityPerimeterConfigurations" ], "description": "Return a NetworkSecurityPerimeterConfigurations resourceAssociationName", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "resourceAssociationName", "in": "path", "description": "The ResourceAssociation Name", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NetworkSecurityPerimeterConfigurationassociationProxyName": { "$ref": "./examples/NameSpaces/NetworkSecurityPerimeterConfigurationAssociationproxy.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkSecurityPerimeterConfigurations/{resourceAssociationName}/reconcile": { "post": { "operationId": "NetworkSecurityPerimeterConfigurations_Reconcile", "tags": [ "NetworkSecurityPerimeterConfigurations" ], "description": "Refreshes any information about the association.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "resourceAssociationName", "in": "path", "description": "The ResourceAssociation Name", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NetworkSecurityPerimeterConfigurationList": { "$ref": "./examples/NameSpaces/NetworkSecurityPerimeterConfigurationReconcile.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections": { "get": { "operationId": "PrivateEndpointConnections_List", "tags": [ "PrivateEndpointConnections" ], "description": "Gets the available PrivateEndpointConnections within a namespace.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpaceCreate": { "$ref": "./examples/NameSpaces/PrivateEndPointConnectionList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { "get": { "operationId": "PrivateEndpointConnections_Get", "tags": [ "PrivateEndpointConnections" ], "description": "Gets a description for the specified Private Endpoint Connection.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The PrivateEndpointConnection name", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpacePrivateEndPointConnectionGet": { "$ref": "./examples/NameSpaces/PrivateEndPointConnectionGet.json" } } }, "put": { "operationId": "PrivateEndpointConnections_CreateOrUpdate", "tags": [ "PrivateEndpointConnections" ], "description": "Creates or updates PrivateEndpointConnections of service namespace.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The PrivateEndpointConnection name", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to update Status of PrivateEndPoint Connection to namespace resource.", "required": true, "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } } ], "responses": { "200": { "description": "Resource 'PrivateEndpointConnection' update operation succeeded", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "201": { "description": "Resource 'PrivateEndpointConnection' create operation succeeded", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpacePrivateEndPointConnectionCreate": { "$ref": "./examples/NameSpaces/PrivateEndPointConnectionCreate.json" } } }, "delete": { "operationId": "PrivateEndpointConnections_Delete", "tags": [ "PrivateEndpointConnections" ], "description": "Deletes an existing Private Endpoint Connection.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The PrivateEndpointConnection name", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpacePrivateEndPointConnectionDelete": { "$ref": "./examples/NameSpaces/PrivateEndPointConnectionDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateLinkResources": { "get": { "operationId": "PrivateLinkResources_Get", "tags": [ "Namespaces" ], "description": "Gets lists of resources that supports Privatelinks.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateLinkResourcesListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NameSpacePrivateLinkResourcesGet": { "$ref": "./examples/NameSpaces/PrivateLinkResourcesGet.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues": { "get": { "operationId": "Queues_ListByNamespace", "tags": [ "Queues" ], "description": "Gets the queues within a namespace.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639415.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "$skip", "in": "query", "description": "Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.", "required": false, "type": "integer", "format": "int32", "maximum": 1000 }, { "name": "$top", "in": "query", "description": "May be used to limit the number of results to the most recent N usageDetails.", "required": false, "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SBQueueListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueueListByNameSpace": { "$ref": "./examples/Queues/SBQueueListByNameSpace.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}": { "get": { "operationId": "Queues_Get", "tags": [ "Queues" ], "description": "Returns a description for the specified queue.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639380.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "queueName", "in": "path", "description": "The queue name.", "required": true, "type": "string", "minLength": 1 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SBQueue" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueueGet": { "$ref": "./examples/Queues/SBQueueGet.json" } } }, "put": { "operationId": "Queues_CreateOrUpdate", "tags": [ "Queues" ], "description": "Creates or updates a Service Bus queue. This operation is idempotent.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639395.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "queueName", "in": "path", "description": "The queue name.", "required": true, "type": "string", "minLength": 1 }, { "name": "parameters", "in": "body", "description": "Parameters supplied to create or update a queue resource.", "required": true, "schema": { "$ref": "#/definitions/SBQueue" } } ], "responses": { "200": { "description": "Resource 'SBQueue' update operation succeeded", "schema": { "$ref": "#/definitions/SBQueue" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueueCreate": { "$ref": "./examples/Queues/SBQueueCreate.json" } } }, "delete": { "operationId": "Queues_Delete", "tags": [ "Queues" ], "description": "Deletes a queue from the specified namespace in a resource group.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639411.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "queueName", "in": "path", "description": "The queue name.", "required": true, "type": "string", "minLength": 1 } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueueDelete": { "$ref": "./examples/Queues/SBQueueDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules": { "get": { "operationId": "Queues_ListAuthorizationRules", "tags": [ "Queues" ], "description": "Gets all authorization rules for a queue.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt705607.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "queueName", "in": "path", "description": "The queue name.", "required": true, "type": "string", "minLength": 1 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SBAuthorizationRuleListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueueAuthorizationRuleListAll": { "$ref": "./examples/Queues/SBQueueAuthorizationRuleListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}": { "get": { "operationId": "Queues_GetAuthorizationRule", "tags": [ "Queues" ], "description": "Gets an authorization rule for a queue by rule name.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt705611.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "queueName", "in": "path", "description": "The queue name.", "required": true, "type": "string", "minLength": 1 }, { "name": "authorizationRuleName", "in": "path", "description": "The authorization rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SBAuthorizationRule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueueAuthorizationRuleGet": { "$ref": "./examples/Queues/SBQueueAuthorizationRuleGet.json" } } }, "put": { "operationId": "Queues_CreateOrUpdateAuthorizationRule", "tags": [ "Queues" ], "description": "Creates an authorization rule for a queue.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "queueName", "in": "path", "description": "The queue name.", "required": true, "type": "string", "minLength": 1 }, { "name": "authorizationRuleName", "in": "path", "description": "The authorization rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 }, { "name": "parameters", "in": "body", "description": "The shared access authorization rule.", "required": true, "schema": { "$ref": "#/definitions/SBAuthorizationRule" } } ], "responses": { "200": { "description": "Resource 'SBAuthorizationRule' update operation succeeded", "schema": { "$ref": "#/definitions/SBAuthorizationRule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueueAuthorizationRuleCreate": { "$ref": "./examples/Queues/SBQueueAuthorizationRuleCreate.json" } } }, "delete": { "operationId": "Queues_DeleteAuthorizationRule", "tags": [ "Queues" ], "description": "Deletes a queue authorization rule.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt705609.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "queueName", "in": "path", "description": "The queue name.", "required": true, "type": "string", "minLength": 1 }, { "name": "authorizationRuleName", "in": "path", "description": "The authorization rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueueAuthorizationRuleDelete": { "$ref": "./examples/Queues/SBQueueAuthorizationRuleDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/listKeys": { "post": { "operationId": "Queues_ListKeys", "tags": [ "Queues" ], "description": "Primary and secondary connection strings to the queue.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt705608.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "queueName", "in": "path", "description": "The queue name.", "required": true, "type": "string", "minLength": 1 }, { "name": "authorizationRuleName", "in": "path", "description": "The authorization rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AccessKeys" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueueAuthorizationRuleListKey": { "$ref": "./examples/Queues/SBQueueAuthorizationRuleListKey.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { "post": { "operationId": "Queues_RegenerateKeys", "tags": [ "Queues" ], "description": "Regenerates the primary or secondary connection strings to the queue.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt705606.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "queueName", "in": "path", "description": "The queue name.", "required": true, "type": "string", "minLength": 1 }, { "name": "authorizationRuleName", "in": "path", "description": "The authorization rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 }, { "name": "parameters", "in": "body", "description": "Parameters supplied to regenerate the authorization rule.", "required": true, "schema": { "$ref": "#/definitions/RegenerateAccessKeyParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AccessKeys" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "QueueAuthorizationRuleRegenerateKey": { "$ref": "./examples/Queues/SBQueueAuthorizationRuleRegenerateKey.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics": { "get": { "operationId": "Topics_ListByNamespace", "tags": [ "Topics" ], "description": "Gets all the topics in a namespace.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639388.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "$skip", "in": "query", "description": "Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.", "required": false, "type": "integer", "format": "int32", "maximum": 1000 }, { "name": "$top", "in": "query", "description": "May be used to limit the number of results to the most recent N usageDetails.", "required": false, "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SBTopicListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TopicGet": { "$ref": "./examples/Topics/SBTopicListByNameSpace.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}": { "get": { "operationId": "Topics_Get", "tags": [ "Topics" ], "description": "Returns a description for the specified topic.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639399.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "topicName", "in": "path", "description": "The topic name.", "required": true, "type": "string", "minLength": 1 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SBTopic" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TopicGet": { "$ref": "./examples/Topics/SBTopicGet.json" } } }, "put": { "operationId": "Topics_CreateOrUpdate", "tags": [ "Topics" ], "description": "Creates a topic in the specified namespace.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639409.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "topicName", "in": "path", "description": "The topic name.", "required": true, "type": "string", "minLength": 1 }, { "name": "parameters", "in": "body", "description": "Parameters supplied to create a topic resource.", "required": true, "schema": { "$ref": "#/definitions/SBTopic" } } ], "responses": { "200": { "description": "Resource 'SBTopic' update operation succeeded", "schema": { "$ref": "#/definitions/SBTopic" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TopicCreate": { "$ref": "./examples/Topics/SBTopicCreate.json" } } }, "delete": { "operationId": "Topics_Delete", "tags": [ "Topics" ], "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-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "topicName", "in": "path", "description": "The topic name.", "required": true, "type": "string", "minLength": 1 } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TopicDelete": { "$ref": "./examples/Topics/SBTopicDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules": { "get": { "operationId": "Topics_ListAuthorizationRules", "tags": [ "Topics" ], "description": "Gets authorization rules for a topic.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "topicName", "in": "path", "description": "The topic name.", "required": true, "type": "string", "minLength": 1 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SBAuthorizationRuleListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TopicAuthorizationRuleListAll": { "$ref": "./examples/Topics/SBTopicAuthorizationRuleListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}": { "get": { "operationId": "Topics_GetAuthorizationRule", "tags": [ "Topics" ], "description": "Returns the specified authorization rule.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt720676.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "topicName", "in": "path", "description": "The topic name.", "required": true, "type": "string", "minLength": 1 }, { "name": "authorizationRuleName", "in": "path", "description": "The authorization rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SBAuthorizationRule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TopicAuthorizationRuleGet": { "$ref": "./examples/Topics/SBTopicAuthorizationRuleGet.json" } } }, "put": { "operationId": "Topics_CreateOrUpdateAuthorizationRule", "tags": [ "Topics" ], "description": "Creates an authorization rule for the specified topic.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt720678.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "topicName", "in": "path", "description": "The topic name.", "required": true, "type": "string", "minLength": 1 }, { "name": "authorizationRuleName", "in": "path", "description": "The authorization rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 }, { "name": "parameters", "in": "body", "description": "The shared access authorization rule.", "required": true, "schema": { "$ref": "#/definitions/SBAuthorizationRule" } } ], "responses": { "200": { "description": "Resource 'SBAuthorizationRule' update operation succeeded", "schema": { "$ref": "#/definitions/SBAuthorizationRule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TopicAuthorizationRuleCreate": { "$ref": "./examples/Topics/SBTopicAuthorizationRuleCreate.json" } } }, "delete": { "operationId": "Topics_DeleteAuthorizationRule", "tags": [ "Topics" ], "description": "Deletes a topic authorization rule.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "topicName", "in": "path", "description": "The topic name.", "required": true, "type": "string", "minLength": 1 }, { "name": "authorizationRuleName", "in": "path", "description": "The authorization rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TopicAuthorizationRuleDelete": { "$ref": "./examples/Topics/SBTopicAuthorizationRuleDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/listKeys": { "post": { "operationId": "Topics_ListKeys", "tags": [ "Topics" ], "description": "Gets the primary and secondary connection strings for the topic.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt720677.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "topicName", "in": "path", "description": "The topic name.", "required": true, "type": "string", "minLength": 1 }, { "name": "authorizationRuleName", "in": "path", "description": "The authorization rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AccessKeys" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TopicAuthorizationRuleListKey": { "$ref": "./examples/Topics/SBTopicAuthorizationRuleListKey.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { "post": { "operationId": "Topics_RegenerateKeys", "tags": [ "Topics" ], "description": "Regenerates primary or secondary connection strings for the topic.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt720679.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "topicName", "in": "path", "description": "The topic name.", "required": true, "type": "string", "minLength": 1 }, { "name": "authorizationRuleName", "in": "path", "description": "The authorization rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 }, { "name": "parameters", "in": "body", "description": "Parameters supplied to regenerate the authorization rule.", "required": true, "schema": { "$ref": "#/definitions/RegenerateAccessKeyParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AccessKeys" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TopicAuthorizationRuleRegenerateKey": { "$ref": "./examples/Topics/SBTopicAuthorizationRuleRegenerateKey.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions": { "get": { "operationId": "Subscriptions_ListByTopic", "tags": [ "Subscriptions" ], "description": "List all the subscriptions under a specified topic.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639400.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "topicName", "in": "path", "description": "The topic name.", "required": true, "type": "string", "minLength": 1 }, { "name": "$skip", "in": "query", "description": "Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.", "required": false, "type": "integer", "format": "int32", "maximum": 1000 }, { "name": "$top", "in": "query", "description": "May be used to limit the number of results to the most recent N usageDetails.", "required": false, "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SBSubscriptionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SubscriptionListByTopic": { "$ref": "./examples/Subscriptions/SBSubscriptionListByTopic.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}": { "get": { "operationId": "Subscriptions_Get", "tags": [ "Subscriptions" ], "description": "Returns a subscription description for the specified topic.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639402.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "topicName", "in": "path", "description": "The topic name.", "required": true, "type": "string", "minLength": 1 }, { "name": "subscriptionName", "in": "path", "description": "The subscription name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SBSubscription" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SubscriptionGet": { "$ref": "./examples/Subscriptions/SBSubscriptionGet.json" } } }, "put": { "operationId": "Subscriptions_CreateOrUpdate", "tags": [ "Subscriptions" ], "description": "Creates a topic subscription.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639385.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "topicName", "in": "path", "description": "The topic name.", "required": true, "type": "string", "minLength": 1 }, { "name": "subscriptionName", "in": "path", "description": "The subscription name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 }, { "name": "parameters", "in": "body", "description": "Parameters supplied to create a subscription resource.", "required": true, "schema": { "$ref": "#/definitions/SBSubscription" } } ], "responses": { "200": { "description": "Resource 'SBSubscription' update operation succeeded", "schema": { "$ref": "#/definitions/SBSubscription" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SubscriptionCreate": { "$ref": "./examples/Subscriptions/SBSubscriptionCreate.json" } } }, "delete": { "operationId": "Subscriptions_Delete", "tags": [ "Subscriptions" ], "description": "Deletes a subscription from the specified topic.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639381.aspx" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "topicName", "in": "path", "description": "The topic name.", "required": true, "type": "string", "minLength": 1 }, { "name": "subscriptionName", "in": "path", "description": "The subscription name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SubscriptionDelete": { "$ref": "./examples/Subscriptions/SBSubscriptionDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules": { "get": { "operationId": "Rules_ListBySubscriptions", "tags": [ "Rules" ], "description": "List all the rules within given topic-subscription", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "topicName", "in": "path", "description": "The topic name.", "required": true, "type": "string", "minLength": 1 }, { "name": "subscriptionName", "in": "path", "description": "The subscription name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 }, { "name": "$skip", "in": "query", "description": "Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.", "required": false, "type": "integer", "format": "int32", "maximum": 1000 }, { "name": "$top", "in": "query", "description": "May be used to limit the number of results to the most recent N usageDetails.", "required": false, "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RuleListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RulesListBySubscriptions": { "$ref": "./examples/Rules/RuleListBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}": { "get": { "operationId": "Rules_Get", "tags": [ "Rules" ], "description": "Retrieves the description for the specified rule.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "topicName", "in": "path", "description": "The topic name.", "required": true, "type": "string", "minLength": 1 }, { "name": "subscriptionName", "in": "path", "description": "The subscription name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 }, { "name": "ruleName", "in": "path", "description": "The rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Rule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RulesGet": { "$ref": "./examples/Rules/RuleGet.json" } } }, "put": { "operationId": "Rules_CreateOrUpdate", "tags": [ "Rules" ], "description": "Creates a new rule and updates an existing rule", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "topicName", "in": "path", "description": "The topic name.", "required": true, "type": "string", "minLength": 1 }, { "name": "subscriptionName", "in": "path", "description": "The subscription name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 }, { "name": "ruleName", "in": "path", "description": "The rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 }, { "name": "parameters", "in": "body", "description": "Parameters supplied to create a rule.", "required": true, "schema": { "$ref": "#/definitions/Rule" } } ], "responses": { "200": { "description": "Resource 'Rule' update operation succeeded", "schema": { "$ref": "#/definitions/Rule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RulesCreateCorrelationFilter": { "$ref": "./examples/Rules/RuleCreate_CorrelationFilter.json" }, "RulesCreateOrUpdate": { "$ref": "./examples/Rules/RuleCreate.json" }, "RulesCreateSqlFilter": { "$ref": "./examples/Rules/RuleCreate_SqlFilter.json" } } }, "delete": { "operationId": "Rules_Delete", "tags": [ "Rules" ], "description": "Deletes an existing rule.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "description": "The namespace name", "required": true, "type": "string", "minLength": 6, "maxLength": 50 }, { "name": "topicName", "in": "path", "description": "The topic name.", "required": true, "type": "string", "minLength": 1 }, { "name": "subscriptionName", "in": "path", "description": "The subscription name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 }, { "name": "ruleName", "in": "path", "description": "The rule name.", "required": true, "type": "string", "minLength": 1, "maxLength": 50 } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RulesDelete": { "$ref": "./examples/Rules/RuleDelete.json" } } } } }, "definitions": { "AccessKeys": { "type": "object", "description": "Namespace/ServiceBus Connection String", "properties": { "primaryConnectionString": { "type": "string", "description": "Primary connection string of the created namespace authorization rule.", "readOnly": true }, "secondaryConnectionString": { "type": "string", "description": "Secondary connection string of the created namespace authorization rule.", "readOnly": true }, "aliasPrimaryConnectionString": { "type": "string", "description": "Primary connection string of the alias if GEO DR is enabled", "readOnly": true }, "aliasSecondaryConnectionString": { "type": "string", "description": "Secondary connection string of the alias if GEO DR is enabled", "readOnly": true }, "primaryKey": { "type": "string", "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token.", "readOnly": true }, "secondaryKey": { "type": "string", "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token.", "readOnly": true }, "keyName": { "type": "string", "description": "A string that describes the authorization rule.", "readOnly": true } } }, "AccessRights": { "type": "string", "enum": [ "Manage", "Send", "Listen" ], "x-ms-enum": { "name": "AccessRights", "modelAsString": false } }, "Action": { "type": "object", "description": "Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.", "properties": { "sqlExpression": { "type": "string", "description": "SQL expression. e.g. MyProperty='ABC'" }, "compatibilityLevel": { "type": "integer", "format": "int32", "description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." }, "requiresPreprocessing": { "type": "boolean", "description": "Value that indicates whether the rule action requires preprocessing.", "default": true } } }, "ArmDisasterRecovery": { "type": "object", "description": "Single item in List or Get Alias(Disaster Recovery configuration) operation", "properties": { "properties": { "$ref": "#/definitions/ArmDisasterRecoveryProperties", "description": "Properties required to the Create Or Update Alias(Disaster Recovery configurations)", "x-ms-client-flatten": true }, "location": { "type": "string", "description": "The geo-location where the resource lives", "readOnly": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ArmDisasterRecoveryListResult": { "type": "object", "description": "The response of a ArmDisasterRecovery list operation.", "properties": { "value": { "type": "array", "description": "The ArmDisasterRecovery items on this page", "items": { "$ref": "#/definitions/ArmDisasterRecovery" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ArmDisasterRecoveryProperties": { "type": "object", "description": "Properties required to the Create Or Update Alias(Disaster Recovery configurations)", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningStateDR", "description": "Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'", "readOnly": true }, "pendingReplicationOperationsCount": { "type": "integer", "format": "int64", "description": "Number of entities pending to be replicated.", "readOnly": true }, "partnerNamespace": { "type": "string", "description": "ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" }, "alternateName": { "type": "string", "description": "Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" }, "role": { "$ref": "#/definitions/RoleDisasterRecovery", "description": "role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'", "readOnly": true } } }, "CheckNameAvailability": { "type": "object", "description": "Description of a Check Name availability request properties.", "properties": { "name": { "type": "string", "description": "The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number." } }, "required": [ "name" ] }, "CheckNameAvailabilityResult": { "type": "object", "description": "Description of a Check Name availability request properties.", "properties": { "message": { "type": "string", "description": "The detailed info regarding the reason associated with the namespace.", "readOnly": true }, "nameAvailable": { "type": "boolean", "description": "Value indicating namespace is availability, true if the namespace is available; otherwise, false." }, "reason": { "$ref": "#/definitions/UnavailableReason", "description": "The reason for unavailability of a namespace." } } }, "ConfidentialCompute": { "type": "object", "properties": { "mode": { "$ref": "#/definitions/Mode", "description": "Setting to Enable or Disable Confidential Compute" } } }, "ConnectionState": { "type": "object", "description": "ConnectionState information.", "properties": { "status": { "$ref": "#/definitions/PrivateLinkConnectionStatus", "description": "Status of the connection." }, "description": { "type": "string", "description": "Description of the connection state." } } }, "CorrelationFilter": { "type": "object", "description": "Represents the correlation filter expression.", "properties": { "properties": { "type": "object", "description": "dictionary object for custom filters", "additionalProperties": { "type": "string" } }, "correlationId": { "type": "string", "description": "Identifier of the correlation." }, "messageId": { "type": "string", "description": "Identifier of the message." }, "to": { "type": "string", "description": "Address to send to." }, "replyTo": { "type": "string", "description": "Address of the queue to reply to." }, "label": { "type": "string", "description": "Application specific label." }, "sessionId": { "type": "string", "description": "Session identifier." }, "replyToSessionId": { "type": "string", "description": "Session identifier to reply to." }, "contentType": { "type": "string", "description": "Content type of the message." }, "requiresPreprocessing": { "type": "boolean", "description": "Value that indicates whether the rule action requires preprocessing.", "default": true } } }, "DefaultAction": { "type": "string", "description": "Default Action for Network Rule Set", "enum": [ "Allow", "Deny" ], "x-ms-enum": { "name": "DefaultAction", "modelAsString": true, "values": [ { "name": "Allow", "value": "Allow" }, { "name": "Deny", "value": "Deny" } ] } }, "Encryption": { "type": "object", "description": "Properties to configure Encryption", "properties": { "keyVaultProperties": { "type": "array", "description": "Properties of KeyVault", "items": { "$ref": "#/definitions/KeyVaultProperties" }, "x-ms-client-name": "KeyVaultProperties" }, "keySource": { "type": "string", "description": "Enumerates the possible value of keySource for Encryption", "default": "Microsoft.KeyVault", "enum": [ "Microsoft.KeyVault" ], "x-ms-enum": { "modelAsString": false } }, "requireInfrastructureEncryption": { "type": "boolean", "description": "Enable Infrastructure Encryption (Double Encryption)" } } }, "EndPointProvisioningState": { "type": "string", "description": "Provisioning state of the Private Endpoint Connection.", "enum": [ "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed" ], "x-ms-enum": { "name": "EndPointProvisioningState", "modelAsString": true, "values": [ { "name": "Creating", "value": "Creating" }, { "name": "Updating", "value": "Updating" }, { "name": "Deleting", "value": "Deleting" }, { "name": "Succeeded", "value": "Succeeded" }, { "name": "Canceled", "value": "Canceled" }, { "name": "Failed", "value": "Failed" } ] } }, "EntityStatus": { "type": "string", "description": "Entity status.", "enum": [ "Active", "Disabled", "Restoring", "SendDisabled", "ReceiveDisabled", "Creating", "Deleting", "Renaming", "Unknown" ], "x-ms-enum": { "name": "EntityStatus", "modelAsString": false } }, "ErrorAdditionalInfo": { "type": "object", "description": "The resource management error additional info.", "properties": { "type": { "type": "string", "description": "The additional info type.", "readOnly": true }, "info": { "description": "The additional info.", "readOnly": true } } }, "ErrorResponse": { "type": "object", "description": "The resource management error response.", "properties": { "error": { "$ref": "#/definitions/ErrorResponseError", "description": "The error object." } } }, "ErrorResponseError": { "type": "object", "description": "The error object.", "properties": { "code": { "type": "string", "description": "The error code.", "readOnly": true }, "message": { "type": "string", "description": "The error message.", "readOnly": true }, "target": { "type": "string", "description": "The error target.", "readOnly": true }, "details": { "type": "array", "description": "The error details.", "items": { "$ref": "#/definitions/ErrorResponse" }, "readOnly": true }, "additionalInfo": { "type": "array", "description": "The error additional info.", "items": { "$ref": "#/definitions/ErrorAdditionalInfo" }, "readOnly": true } } }, "FailOver": { "type": "object", "properties": { "properties": { "$ref": "#/definitions/FailOverProperties", "x-ms-client-flatten": true } } }, "FailOverProperties": { "type": "object", "properties": { "primaryLocation": { "type": "string", "description": "Query parameter for the new primary location after failover." }, "force": { "type": "boolean", "description": "If Force is false then graceful failover is attempted after ensuring no data loss. If Force flag is set to true, Forced failover is attempted with possible data loss." } } }, "FailoverPropertiesProperties": { "type": "object", "description": "Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary.", "properties": { "IsSafeFailover": { "type": "boolean", "description": "Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary." } } }, "FilterType": { "type": "string", "description": "Rule filter types", "enum": [ "SqlFilter", "CorrelationFilter" ], "x-ms-enum": { "name": "FilterType", "modelAsString": false } }, "GeoDRRoleType": { "type": "string", "description": "GeoDR Role Types", "enum": [ "Primary", "Secondary" ], "x-ms-enum": { "name": "GeoDRRoleType", "modelAsString": true, "values": [ { "name": "Primary", "value": "Primary" }, { "name": "Secondary", "value": "Secondary" } ] } }, "GeoDataReplicationProperties": { "type": "object", "description": "GeoDR Replication properties", "properties": { "maxReplicationLagDurationInSeconds": { "type": "integer", "format": "int32", "description": "The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day." }, "locations": { "type": "array", "description": "A list of regions where replicas of the namespace are maintained.", "items": { "$ref": "#/definitions/NamespaceReplicaLocation" }, "x-ms-identifiers": [] } } }, "Identity": { "type": "object", "description": "Properties to configure User Assigned Identities for Bring your Own Keys", "properties": { "principalId": { "type": "string", "description": "ObjectId from the KeyVault", "readOnly": true }, "tenantId": { "type": "string", "description": "TenantId from the KeyVault", "readOnly": true }, "type": { "$ref": "#/definitions/ManagedServiceIdentityType", "description": "Type of managed service identity." }, "userAssignedIdentities": { "type": "object", "description": "Properties for User Assigned Identities", "additionalProperties": { "$ref": "#/definitions/UserAssignedIdentity" } } } }, "KeyType": { "type": "string", "description": "The access key to regenerate.", "enum": [ "PrimaryKey", "SecondaryKey" ], "x-ms-enum": { "name": "KeyType", "modelAsString": false } }, "KeyVaultProperties": { "type": "object", "description": "Properties to configure keyVault Properties", "properties": { "keyName": { "type": "string", "description": "Name of the Key from KeyVault" }, "keyVaultUri": { "type": "string", "description": "Uri of KeyVault" }, "keyVersion": { "type": "string", "description": "Version of KeyVault" }, "identity": { "$ref": "#/definitions/UserAssignedIdentityProperties" } } }, "ManagedServiceIdentityType": { "type": "string", "description": "Type of managed service identity.", "enum": [ "SystemAssigned", "UserAssigned", "SystemAssigned, UserAssigned", "None" ], "x-ms-enum": { "name": "ManagedServiceIdentityType", "modelAsString": false } }, "MessageCountDetails": { "type": "object", "description": "Message Count Details.", "properties": { "activeMessageCount": { "type": "integer", "format": "int64", "description": "Number of active messages in the queue, topic, or subscription.", "readOnly": true }, "deadLetterMessageCount": { "type": "integer", "format": "int64", "description": "Number of messages that are dead lettered.", "readOnly": true }, "scheduledMessageCount": { "type": "integer", "format": "int64", "description": "Number of scheduled messages.", "readOnly": true }, "transferMessageCount": { "type": "integer", "format": "int64", "description": "Number of messages transferred to another queue, topic, or subscription.", "readOnly": true }, "transferDeadLetterMessageCount": { "type": "integer", "format": "int64", "description": "Number of messages transferred into dead letters.", "readOnly": true } } }, "MigrationConfigListResult": { "type": "object", "description": "The response of a MigrationConfigProperties list operation.", "properties": { "value": { "type": "array", "description": "The MigrationConfigProperties items on this page", "items": { "$ref": "#/definitions/MigrationConfigProperties" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "MigrationConfigProperties": { "type": "object", "description": "Single item in List or Get Migration Config operation", "properties": { "properties": { "$ref": "#/definitions/MigrationConfigPropertiesProperties", "description": "Properties required to the Create Migration Configuration", "x-ms-client-flatten": true }, "location": { "type": "string", "description": "The geo-location where the resource lives", "readOnly": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "MigrationConfigPropertiesProperties": { "type": "object", "description": "Properties required to the Create Migration Configuration", "properties": { "provisioningState": { "type": "string", "description": "Provisioning state of Migration ConfigurationProvisioning state of Migration Configuration", "readOnly": true }, "pendingReplicationOperationsCount": { "type": "integer", "format": "int64", "description": "Number of entities pending to be replicated.", "readOnly": true }, "targetNamespace": { "type": "string", "description": "Existing premium Namespace ARM Id name which has no entities, will be used for migration" }, "postMigrationName": { "type": "string", "description": "Name to access Standard Namespace after migration" }, "migrationState": { "type": "string", "description": "State in which Standard to Premium Migration is, possible values : Unknown, Reverting, Completing, Initiating, Syncing, Active", "readOnly": true } }, "required": [ "targetNamespace", "postMigrationName" ] }, "Mode": { "type": "string", "description": "Setting to Enable or Disable Confidential Compute", "enum": [ "Disabled", "Enabled" ], "x-ms-enum": { "name": "Mode", "modelAsString": true, "values": [ { "name": "Disabled", "value": "Disabled" }, { "name": "Enabled", "value": "Enabled" } ] } }, "NWRuleSetIpRules": { "type": "object", "description": "Description of NetWorkRuleSet - IpRules resource.", "properties": { "ipMask": { "type": "string", "description": "IP Mask" }, "action": { "type": "string", "description": "The IP Filter Action", "default": "Allow", "enum": [ "Allow" ], "x-ms-enum": { "name": "NetworkRuleIPAction", "modelAsString": true, "values": [ { "name": "Allow", "value": "Allow" } ] } } } }, "NWRuleSetVirtualNetworkRules": { "type": "object", "description": "Description of VirtualNetworkRules - NetworkRules resource.", "properties": { "subnet": { "$ref": "#/definitions/Subnet", "description": "Subnet properties" }, "ignoreMissingVnetServiceEndpoint": { "type": "boolean", "description": "Value that indicates whether to ignore missing VNet Service Endpoint" } } }, "NamespaceFailoverProperties": { "type": "object", "description": "Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary.", "properties": { "properties": { "$ref": "#/definitions/FailoverPropertiesProperties", "description": "Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary.", "x-ms-client-flatten": true } } }, "NamespaceReplicaLocation": { "type": "object", "description": "Namespace replication properties", "properties": { "locationName": { "type": "string", "description": "Azure regions where a replica of the namespace is maintained" }, "roleType": { "$ref": "#/definitions/GeoDRRoleType", "description": "GeoDR Role Types" }, "clusterArmId": { "type": "string", "description": "Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster" } } }, "NetworkRuleSet": { "type": "object", "description": "Description of NetworkRuleSet resource.", "properties": { "properties": { "$ref": "#/definitions/NetworkRuleSetProperties", "description": "NetworkRuleSet properties", "x-ms-client-flatten": true }, "location": { "type": "string", "description": "The geo-location where the resource lives", "readOnly": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "NetworkRuleSetListResult": { "type": "object", "description": "The response of a NetworkRuleSet list operation.", "properties": { "value": { "type": "array", "description": "The NetworkRuleSet items on this page", "items": { "$ref": "#/definitions/NetworkRuleSet" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "NetworkRuleSetProperties": { "type": "object", "description": "NetworkRuleSet properties", "properties": { "trustedServiceAccessEnabled": { "type": "boolean", "description": "Value that indicates whether Trusted Service Access is Enabled or not." }, "defaultAction": { "$ref": "#/definitions/DefaultAction", "description": "Default Action for Network Rule Set" }, "virtualNetworkRules": { "type": "array", "description": "List VirtualNetwork Rules", "items": { "$ref": "#/definitions/NWRuleSetVirtualNetworkRules" } }, "ipRules": { "type": "array", "description": "List of IpRules", "items": { "$ref": "#/definitions/NWRuleSetIpRules" } }, "publicNetworkAccess": { "type": "string", "description": "This determines if traffic is allowed over public network. By default it is enabled.", "default": "Enabled", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "PublicNetworkAccessFlag", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled" }, { "name": "Disabled", "value": "Disabled" } ] } } } }, "NetworkSecurityPerimeter": { "type": "object", "description": "NetworkSecurityPerimeter related information", "properties": { "id": { "type": "string", "format": "arm-id", "description": "Fully qualified identifier of the resource", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Network/networkSecurityPerimeters" } ] } }, "perimeterGuid": { "type": "string", "description": "Guid of the resource" }, "location": { "type": "string", "description": "Location of the resource" } } }, "NetworkSecurityPerimeterConfiguration": { "type": "object", "description": "Network Security Perimeter related configurations of a given namespace", "properties": { "properties": { "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationProperties", "description": "Properties of the Network Security Perimeter Configuration", "x-ms-client-flatten": true }, "location": { "type": "string", "description": "The geo-location where the resource lives", "readOnly": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "NetworkSecurityPerimeterConfigurationList": { "type": "object", "description": "Result of the List NetworkSecurityPerimeterConfiguration operation.", "properties": { "value": { "type": "array", "description": "The NetworkSecurityPerimeterConfiguration items on this page", "items": { "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "NetworkSecurityPerimeterConfigurationProperties": { "type": "object", "description": "Properties of NetworkSecurityPerimeterConfiguration", "properties": { "provisioningState": { "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationProvisioningState", "description": "Provisioning state of NetworkSecurityPerimeter configuration propagation", "readOnly": true }, "provisioningIssues": { "type": "array", "description": "List of Provisioning Issues if any", "items": { "$ref": "#/definitions/ProvisioningIssue" }, "x-ms-identifiers": [ "name" ] }, "networkSecurityPerimeter": { "$ref": "#/definitions/NetworkSecurityPerimeter", "description": "NetworkSecurityPerimeter related information" }, "resourceAssociation": { "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation", "description": "Information about resource association", "readOnly": true }, "profile": { "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationPropertiesProfile", "description": "Information about current network profile", "readOnly": true }, "isBackingResource": { "type": "boolean", "description": "True if the ServiceBus namespace is backed by another Azure resource and not visible to end users.", "readOnly": true }, "applicableFeatures": { "type": "array", "description": "Indicates that the NSP controls related to backing association are only applicable to a specific feature in backing resource's data plane.", "items": { "type": "string" }, "readOnly": true }, "parentAssociationName": { "type": "string", "description": "Source Resource Association name", "readOnly": true }, "sourceResourceId": { "type": "string", "format": "arm-id", "description": "ARM Id of source resource", "readOnly": true } } }, "NetworkSecurityPerimeterConfigurationPropertiesProfile": { "type": "object", "description": "Information about current network profile", "properties": { "name": { "type": "string", "description": "Name of the resource" }, "accessRulesVersion": { "type": "string", "description": "Current access rules version" }, "accessRules": { "type": "array", "description": "List of Access Rules", "items": { "$ref": "#/definitions/NspAccessRule" } } } }, "NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation": { "type": "object", "description": "Information about resource association", "properties": { "name": { "type": "string", "description": "Name of the resource association" }, "accessMode": { "$ref": "#/definitions/ResourceAssociationAccessMode", "description": "Access Mode of the resource association" } } }, "NetworkSecurityPerimeterConfigurationProvisioningState": { "type": "string", "description": "Provisioning state of NetworkSecurityPerimeter configuration propagation", "enum": [ "Unknown", "Creating", "Updating", "Accepted", "InvalidResponse", "Succeeded", "SucceededWithIssues", "Failed", "Deleting", "Deleted", "Canceled" ], "x-ms-enum": { "name": "NetworkSecurityPerimeterConfigurationProvisioningState", "modelAsString": true, "values": [ { "name": "Unknown", "value": "Unknown" }, { "name": "Creating", "value": "Creating" }, { "name": "Updating", "value": "Updating" }, { "name": "Accepted", "value": "Accepted" }, { "name": "InvalidResponse", "value": "InvalidResponse" }, { "name": "Succeeded", "value": "Succeeded" }, { "name": "SucceededWithIssues", "value": "SucceededWithIssues" }, { "name": "Failed", "value": "Failed" }, { "name": "Deleting", "value": "Deleting" }, { "name": "Deleted", "value": "Deleted" }, { "name": "Canceled", "value": "Canceled" } ] } }, "NspAccessRule": { "type": "object", "description": "Information of Access Rule in Network Profile", "properties": { "id": { "type": "string", "format": "arm-id", "description": "Fully qualified identifier of the resource", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Network/networkSecurityPerimeters/profiles/accessRules" } ] } }, "name": { "type": "string", "description": "Name of the resource" }, "type": { "type": "string", "description": "Type of the resource" }, "properties": { "$ref": "#/definitions/NspAccessRuleProperties", "description": "Properties of Access Rule", "readOnly": true } } }, "NspAccessRuleDirection": { "type": "string", "description": "Direction of Access Rule", "enum": [ "Inbound", "Outbound" ], "x-ms-enum": { "name": "NspAccessRuleDirection", "modelAsString": true, "values": [ { "name": "Inbound", "value": "Inbound" }, { "name": "Outbound", "value": "Outbound" } ] } }, "NspAccessRuleProperties": { "type": "object", "description": "Properties of Access Rule", "properties": { "direction": { "$ref": "#/definitions/NspAccessRuleDirection", "description": "Direction of Access Rule" }, "addressPrefixes": { "type": "array", "description": "Address prefixes in the CIDR format for inbound rules", "items": { "type": "string" } }, "subscriptions": { "type": "array", "description": "Subscriptions for inbound rules", "items": { "$ref": "#/definitions/NspAccessRulePropertiesSubscriptionsItem" } }, "networkSecurityPerimeters": { "type": "array", "description": "NetworkSecurityPerimeters for inbound rules", "items": { "$ref": "#/definitions/NetworkSecurityPerimeter" }, "readOnly": true }, "fullyQualifiedDomainNames": { "type": "array", "description": "FQDN for outbound rules", "items": { "type": "string" }, "readOnly": true } } }, "NspAccessRulePropertiesSubscriptionsItem": { "type": "object", "description": "Subscription for inbound rule", "properties": { "id": { "type": "string", "description": "Fully qualified identifier of subscription" } } }, "Operation": { "type": "object", "description": "A Service Bus REST API operation", "properties": { "name": { "type": "string", "description": "Operation name: {provider}/{resource}/{operation}", "readOnly": true }, "isDataAction": { "type": "boolean", "description": "Indicates whether the operation is a data action" }, "display": { "$ref": "#/definitions/OperationDisplay", "description": "Display of the operation" }, "origin": { "type": "string", "description": "Origin of the operation" }, "properties": { "description": "Properties of the operation", "x-ms-client-flatten": true } } }, "OperationDisplay": { "type": "object", "description": "Operation display payload", "properties": { "provider": { "type": "string", "description": "Resource provider of the operation", "readOnly": true }, "resource": { "type": "string", "description": "Resource of the operation", "readOnly": true }, "operation": { "type": "string", "description": "Localized friendly name for the operation", "readOnly": true }, "description": { "type": "string", "description": "Localized friendly description for the operation", "readOnly": true } } }, "OperationListResult": { "type": "object", "description": "The list of available operations.", "properties": { "value": { "type": "array", "description": "The list of operations.", "items": { "$ref": "#/definitions/Operation" } }, "nextLink": { "type": "string", "description": "The URL to get the next set of results, if any." } }, "required": [ "value" ] }, "PlatformCapabilities": { "type": "object", "properties": { "confidentialCompute": { "$ref": "#/definitions/ConfidentialCompute" } } }, "PrivateEndpoint": { "type": "object", "description": "PrivateEndpoint information.", "properties": { "id": { "type": "string", "description": "The ARM identifier for Private Endpoint." } } }, "PrivateEndpointConnection": { "type": "object", "description": "Properties of the PrivateEndpointConnection.", "properties": { "properties": { "$ref": "#/definitions/PrivateEndpointConnectionProperties", "description": "Properties of the PrivateEndpointConnection.", "x-ms-client-flatten": true }, "location": { "type": "string", "description": "The geo-location where the resource lives", "readOnly": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "PrivateEndpointConnectionListResult": { "type": "object", "description": "The response of a PrivateEndpointConnection list operation.", "properties": { "value": { "type": "array", "description": "The PrivateEndpointConnection items on this page", "items": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PrivateEndpointConnectionProperties": { "type": "object", "description": "Properties of the private endpoint connection resource.", "properties": { "privateEndpoint": { "$ref": "#/definitions/PrivateEndpoint", "description": "The Private Endpoint resource for this Connection." }, "privateLinkServiceConnectionState": { "$ref": "#/definitions/ConnectionState", "description": "Details about the state of the connection." }, "provisioningState": { "$ref": "#/definitions/EndPointProvisioningState", "description": "Provisioning state of the Private Endpoint Connection." } } }, "PrivateLinkConnectionStatus": { "type": "string", "description": "Status of the connection.", "enum": [ "Pending", "Approved", "Rejected", "Disconnected" ], "x-ms-enum": { "name": "PrivateLinkConnectionStatus", "modelAsString": true, "values": [ { "name": "Pending", "value": "Pending" }, { "name": "Approved", "value": "Approved" }, { "name": "Rejected", "value": "Rejected" }, { "name": "Disconnected", "value": "Disconnected" } ] } }, "PrivateLinkResource": { "type": "object", "description": "Information of the private link resource.", "properties": { "properties": { "$ref": "#/definitions/PrivateLinkResourceProperties", "description": "Properties of the private link resource.", "x-ms-client-flatten": true }, "id": { "type": "string", "description": "Fully qualified identifier of the resource." }, "name": { "type": "string", "description": "Name of the resource" }, "type": { "type": "string", "description": "Type of the resource" } } }, "PrivateLinkResourceProperties": { "type": "object", "description": "Properties of PrivateLinkResource", "properties": { "groupId": { "type": "string" }, "requiredMembers": { "type": "array", "description": "Required Members", "items": { "type": "string" } }, "requiredZoneNames": { "type": "array", "description": "Required Zone Names", "items": { "type": "string" } } } }, "PrivateLinkResourcesListResult": { "type": "object", "description": "The response of a PrivateLinkResource list operation.", "properties": { "value": { "type": "array", "description": "The PrivateLinkResource items on this page", "items": { "$ref": "#/definitions/PrivateLinkResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ProvisioningIssue": { "type": "object", "description": "Describes Provisioning issue for given NetworkSecurityPerimeterConfiguration", "properties": { "name": { "type": "string", "description": "Name of the issue" }, "properties": { "$ref": "#/definitions/ProvisioningIssueProperties", "description": "Properties of Provisioning Issue", "readOnly": true } } }, "ProvisioningIssueProperties": { "type": "object", "description": "Properties of Provisioning Issue", "properties": { "issueType": { "type": "string", "description": "Type of Issue" }, "description": { "type": "string", "description": "Description of the issue" } } }, "ProvisioningStateDR": { "type": "string", "description": "Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'", "enum": [ "Accepted", "Succeeded", "Failed" ], "x-ms-enum": { "name": "ProvisioningStateDR", "modelAsString": false } }, "RegenerateAccessKeyParameters": { "type": "object", "description": "Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset.", "properties": { "keyType": { "$ref": "#/definitions/KeyType", "description": "The access key to regenerate." }, "key": { "type": "string", "description": "Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType" } }, "required": [ "keyType" ] }, "ResourceAssociationAccessMode": { "type": "string", "description": "Access Mode of the resource association", "enum": [ "NoAssociationMode", "EnforcedMode", "LearningMode", "AuditMode", "UnspecifiedMode" ], "x-ms-enum": { "name": "ResourceAssociationAccessMode", "modelAsString": true, "values": [ { "name": "NoAssociationMode", "value": "NoAssociationMode" }, { "name": "EnforcedMode", "value": "EnforcedMode" }, { "name": "LearningMode", "value": "LearningMode" }, { "name": "AuditMode", "value": "AuditMode" }, { "name": "UnspecifiedMode", "value": "UnspecifiedMode" } ] } }, "ResourceNamespacePatch": { "type": "object", "description": "The Resource definition.", "properties": { "location": { "type": "string", "description": "Resource location" }, "tags": { "type": "object", "description": "Resource tags", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" } ] }, "RoleDisasterRecovery": { "type": "string", "description": "role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'", "enum": [ "Primary", "PrimaryNotReplicating", "Secondary" ], "x-ms-enum": { "name": "RoleDisasterRecovery", "modelAsString": false } }, "Rule": { "type": "object", "description": "Description of Rule Resource.", "properties": { "properties": { "$ref": "#/definitions/Ruleproperties", "description": "Properties of Rule resource", "x-ms-client-flatten": true }, "location": { "type": "string", "description": "The geo-location where the resource lives", "readOnly": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "RuleListResult": { "type": "object", "description": "The response of a Rule list operation.", "properties": { "value": { "type": "array", "description": "The Rule items on this page", "items": { "$ref": "#/definitions/Rule" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "Ruleproperties": { "type": "object", "description": "Description of Rule Resource.", "properties": { "action": { "$ref": "#/definitions/Action", "description": "Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression." }, "filterType": { "$ref": "#/definitions/FilterType", "description": "Filter type that is evaluated against a BrokeredMessage." }, "sqlFilter": { "$ref": "#/definitions/SqlFilter", "description": "Properties of sqlFilter" }, "correlationFilter": { "$ref": "#/definitions/CorrelationFilter", "description": "Properties of correlationFilter" } } }, "SBAuthorizationRule": { "type": "object", "description": "Description of a namespace authorization rule.", "properties": { "properties": { "$ref": "#/definitions/SBAuthorizationRuleProperties", "description": "AuthorizationRule properties.", "x-ms-client-flatten": true }, "location": { "type": "string", "description": "The geo-location where the resource lives", "readOnly": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "SBAuthorizationRuleListResult": { "type": "object", "description": "The response of a SBAuthorizationRule list operation.", "properties": { "value": { "type": "array", "description": "The SBAuthorizationRule items on this page", "items": { "$ref": "#/definitions/SBAuthorizationRule" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SBAuthorizationRuleProperties": { "type": "object", "description": "AuthorizationRule properties.", "properties": { "rights": { "type": "array", "description": "The rights associated with the rule.", "items": { "$ref": "#/definitions/AccessRights" } } }, "required": [ "rights" ] }, "SBClientAffineProperties": { "type": "object", "description": "Properties specific to client affine subscriptions.", "properties": { "clientId": { "type": "string", "description": "Indicates the Client ID of the application that created the client-affine subscription." }, "isDurable": { "type": "boolean", "description": "For client-affine subscriptions, this value indicates whether the subscription is durable or not." }, "isShared": { "type": "boolean", "description": "For client-affine subscriptions, this value indicates whether the subscription is shared or not." } } }, "SBNamespace": { "type": "object", "description": "Description of a namespace resource.", "properties": { "properties": { "$ref": "#/definitions/SBNamespaceProperties", "description": "Properties of the namespace.", "x-ms-client-flatten": true }, "sku": { "$ref": "#/definitions/SBSku", "description": "Properties of SKU" }, "identity": { "$ref": "#/definitions/Identity", "description": "Properties of BYOK Identity description" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "SBNamespaceListResult": { "type": "object", "description": "The response of a SBNamespace list operation.", "properties": { "value": { "type": "array", "description": "The SBNamespace items on this page", "items": { "$ref": "#/definitions/SBNamespace" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SBNamespaceProperties": { "type": "object", "description": "Properties of the namespace.", "properties": { "minimumTlsVersion": { "$ref": "#/definitions/TlsVersion", "description": "The minimum TLS version for the cluster to support, e.g. '1.2'" }, "provisioningState": { "type": "string", "description": "Provisioning state of the namespace.", "readOnly": true }, "status": { "type": "string", "description": "Status of the namespace.", "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "description": "The time the namespace was created", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "description": "The time the namespace was updated.", "readOnly": true }, "serviceBusEndpoint": { "type": "string", "description": "Endpoint you can use to perform Service Bus operations.", "readOnly": true }, "metricId": { "type": "string", "description": "Identifier for Azure Insights metrics", "readOnly": true }, "zoneRedundant": { "type": "boolean", "description": "Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones.", "x-ms-mutability": [ "read", "create" ] }, "encryption": { "$ref": "#/definitions/Encryption", "description": "Properties of BYOK Encryption description" }, "privateEndpointConnections": { "type": "array", "description": "List of private endpoint connections.", "items": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "disableLocalAuth": { "type": "boolean", "description": "This property disables SAS authentication for the Service Bus namespace." }, "alternateName": { "type": "string", "description": "Alternate name for namespace" }, "publicNetworkAccess": { "type": "string", "description": "This determines if traffic is allowed over public network. By default it is enabled.", "default": "Enabled", "enum": [ "Enabled", "Disabled", "SecuredByPerimeter" ], "x-ms-enum": { "name": "PublicNetworkAccess", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled" }, { "name": "Disabled", "value": "Disabled" }, { "name": "SecuredByPerimeter", "value": "SecuredByPerimeter" } ] } }, "premiumMessagingPartitions": { "type": "integer", "format": "int32", "description": "The number of partitions of a Service Bus namespace. This property is only applicable to Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4" }, "platformCapabilities": { "$ref": "#/definitions/PlatformCapabilities" }, "geoDataReplication": { "$ref": "#/definitions/GeoDataReplicationProperties", "description": "Geo Data Replication settings for the namespace" }, "ipV6Enabled": { "type": "boolean", "description": "Value that indicates whether IPv6 is enabled for public network access." } } }, "SBNamespaceUpdateParameters": { "type": "object", "description": "Description of a namespace resource.", "properties": { "sku": { "$ref": "#/definitions/SBSku", "description": "Properties of SKU" }, "properties": { "$ref": "#/definitions/SBNamespaceUpdateProperties", "description": "Properties of the namespace.", "x-ms-client-flatten": true }, "identity": { "$ref": "#/definitions/Identity", "description": "Properties of BYOK Identity description" } }, "allOf": [ { "$ref": "#/definitions/ResourceNamespacePatch" } ] }, "SBNamespaceUpdateProperties": { "type": "object", "description": "Properties of the namespace.", "properties": { "provisioningState": { "type": "string", "description": "Provisioning state of the namespace.", "readOnly": true }, "status": { "type": "string", "description": "Status of the namespace.", "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "description": "The time the namespace was created", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "description": "The time the namespace was updated.", "readOnly": true }, "serviceBusEndpoint": { "type": "string", "description": "Endpoint you can use to perform Service Bus operations.", "readOnly": true }, "metricId": { "type": "string", "description": "Identifier for Azure Insights metrics", "readOnly": true }, "encryption": { "$ref": "#/definitions/Encryption", "description": "Properties of BYOK Encryption description" }, "privateEndpointConnections": { "type": "array", "description": "List of private endpoint connections.", "items": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "disableLocalAuth": { "type": "boolean", "description": "This property disables SAS authentication for the Service Bus namespace." }, "alternateName": { "type": "string", "description": "Alternate name for namespace" } } }, "SBQueue": { "type": "object", "description": "Description of queue Resource.", "properties": { "properties": { "$ref": "#/definitions/SBQueueProperties", "description": "Queue Properties", "x-ms-client-flatten": true }, "location": { "type": "string", "description": "The geo-location where the resource lives", "readOnly": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "SBQueueListResult": { "type": "object", "description": "The response of a SBQueue list operation.", "properties": { "value": { "type": "array", "description": "The SBQueue items on this page", "items": { "$ref": "#/definitions/SBQueue" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SBQueueProperties": { "type": "object", "description": "The Queue Properties definition.", "properties": { "countDetails": { "$ref": "#/definitions/MessageCountDetails", "description": "Message Count Details.", "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "description": "The exact time the message was created.", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "description": "The exact time the message was updated.", "readOnly": true }, "accessedAt": { "type": "string", "format": "date-time", "description": "Last time a message was sent, or the last time there was a receive request to this queue.", "readOnly": true }, "sizeInBytes": { "type": "integer", "format": "int64", "description": "The size of the queue, in bytes.", "readOnly": true }, "messageCount": { "type": "integer", "format": "int64", "description": "The number of messages in the queue.", "readOnly": true }, "lockDuration": { "type": "string", "format": "duration", "description": "ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute." }, "maxSizeInMegabytes": { "type": "integer", "format": "int32", "description": "The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024." }, "maxMessageSizeInKilobytes": { "type": "integer", "format": "int64", "description": "Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024." }, "requiresDuplicateDetection": { "type": "boolean", "description": "A value indicating if this queue requires duplicate detection." }, "requiresSession": { "type": "boolean", "description": "A value that indicates whether the queue supports the concept of sessions." }, "defaultMessageTimeToLive": { "type": "string", "format": "duration", "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." }, "deadLetteringOnMessageExpiration": { "type": "boolean", "description": "A value that indicates whether this queue has dead letter support when a message expires." }, "duplicateDetectionHistoryTimeWindow": { "type": "string", "format": "duration", "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." }, "maxDeliveryCount": { "type": "integer", "format": "int32", "description": "The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10." }, "status": { "$ref": "#/definitions/EntityStatus", "description": "Enumerates the possible values for the status of a messaging entity." }, "enableBatchedOperations": { "type": "boolean", "description": "Value that indicates whether server-side batched operations are enabled." }, "autoDeleteOnIdle": { "type": "string", "format": "duration", "description": "ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes." }, "enablePartitioning": { "type": "boolean", "description": "A value that indicates whether the queue is to be partitioned across multiple message brokers." }, "enableExpress": { "type": "boolean", "description": "A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage." }, "forwardTo": { "type": "string", "description": "Queue/Topic name to forward the messages" }, "forwardDeadLetteredMessagesTo": { "type": "string", "description": "Queue/Topic name to forward the Dead Letter message" }, "userMetadata": { "type": "string", "description": "Gets and Sets Metadata of User." } } }, "SBSku": { "type": "object", "description": "SKU of the namespace.", "properties": { "name": { "$ref": "#/definitions/SkuName", "description": "Name of this SKU." }, "tier": { "$ref": "#/definitions/SkuTier", "description": "The billing tier of this particular SKU." }, "capacity": { "type": "integer", "format": "int32", "description": "Messaging units for your service bus premium namespace. Valid capacities are {1, 2, 4, 8, 16} multiples of your properties.premiumMessagingPartitions setting. For example, If properties.premiumMessagingPartitions is 1 then possible capacity values are 1, 2, 4, 8, and 16. If properties.premiumMessagingPartitions is 4 then possible capacity values are 4, 8, 16, 32 and 64" } }, "required": [ "name" ] }, "SBSubscription": { "type": "object", "description": "Description of subscription resource.", "properties": { "properties": { "$ref": "#/definitions/SBSubscriptionProperties", "description": "Properties of subscriptions resource.", "x-ms-client-flatten": true }, "location": { "type": "string", "description": "The geo-location where the resource lives", "readOnly": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "SBSubscriptionListResult": { "type": "object", "description": "The response of a SBSubscription list operation.", "properties": { "value": { "type": "array", "description": "The SBSubscription items on this page", "items": { "$ref": "#/definitions/SBSubscription" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SBSubscriptionProperties": { "type": "object", "description": "Description of Subscription Resource.", "properties": { "messageCount": { "type": "integer", "format": "int64", "description": "Number of messages.", "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "description": "Exact time the message was created.", "readOnly": true }, "accessedAt": { "type": "string", "format": "date-time", "description": "Last time there was a receive request to this subscription.", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "description": "The exact time the message was updated.", "readOnly": true }, "countDetails": { "$ref": "#/definitions/MessageCountDetails", "description": "Message count details", "readOnly": true }, "lockDuration": { "type": "string", "format": "duration", "description": "ISO 8061 lock duration timespan for the subscription. The default value is 1 minute." }, "requiresSession": { "type": "boolean", "description": "Value indicating if a subscription supports the concept of sessions." }, "defaultMessageTimeToLive": { "type": "string", "format": "duration", "description": "ISO 8061 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." }, "deadLetteringOnFilterEvaluationExceptions": { "type": "boolean", "description": "Value that indicates whether a subscription has dead letter support on filter evaluation exceptions." }, "deadLetteringOnMessageExpiration": { "type": "boolean", "description": "Value that indicates whether a subscription has dead letter support when a message expires." }, "duplicateDetectionHistoryTimeWindow": { "type": "string", "format": "duration", "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." }, "maxDeliveryCount": { "type": "integer", "format": "int32", "description": "Number of maximum deliveries." }, "status": { "$ref": "#/definitions/EntityStatus", "description": "Enumerates the possible values for the status of a messaging entity." }, "enableBatchedOperations": { "type": "boolean", "description": "Value that indicates whether server-side batched operations are enabled." }, "autoDeleteOnIdle": { "type": "string", "format": "duration", "description": "ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes." }, "forwardTo": { "type": "string", "description": "Queue/Topic name to forward the messages" }, "forwardDeadLetteredMessagesTo": { "type": "string", "description": "Queue/Topic name to forward the Dead Letter message" }, "isClientAffine": { "type": "boolean", "description": "Value that indicates whether the subscription has an affinity to the client id." }, "userMetadata": { "type": "string", "description": "Gets and Sets Metadata of User." }, "clientAffineProperties": { "$ref": "#/definitions/SBClientAffineProperties", "description": "Properties specific to client affine subscriptions." } } }, "SBTopic": { "type": "object", "description": "Description of topic resource.", "properties": { "properties": { "$ref": "#/definitions/SBTopicProperties", "description": "Properties of topic resource.", "x-ms-client-flatten": true }, "location": { "type": "string", "description": "The geo-location where the resource lives", "readOnly": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "SBTopicListResult": { "type": "object", "description": "The response of a SBTopic list operation.", "properties": { "value": { "type": "array", "description": "The SBTopic items on this page", "items": { "$ref": "#/definitions/SBTopic" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SBTopicProperties": { "type": "object", "description": "The Topic Properties definition.", "properties": { "sizeInBytes": { "type": "integer", "format": "int64", "description": "Size of the topic, in bytes.", "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "description": "Exact time the message was created.", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "description": "The exact time the message was updated.", "readOnly": true }, "accessedAt": { "type": "string", "format": "date-time", "description": "Last time the message was sent, or a request was received, for this topic.", "readOnly": true }, "subscriptionCount": { "type": "integer", "format": "int32", "description": "Number of subscriptions.", "readOnly": true }, "countDetails": { "$ref": "#/definitions/MessageCountDetails", "description": "Message count details", "readOnly": true }, "defaultMessageTimeToLive": { "type": "string", "format": "duration", "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": { "type": "integer", "format": "int32", "description": "Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024." }, "maxMessageSizeInKilobytes": { "type": "integer", "format": "int64", "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": { "type": "string", "format": "duration", "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": "#/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": { "type": "string", "format": "duration", "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." }, "userMetadata": { "type": "string", "description": "Gets and Sets Metadata of User." } } }, "SkuName": { "type": "string", "description": "Name of this SKU.", "enum": [ "Basic", "Standard", "Premium" ], "x-ms-enum": { "name": "SkuName", "modelAsString": false } }, "SkuTier": { "type": "string", "description": "The billing tier of this particular SKU.", "enum": [ "Basic", "Standard", "Premium" ], "x-ms-enum": { "name": "SkuTier", "modelAsString": false } }, "SqlFilter": { "type": "object", "description": "Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline.", "properties": { "sqlExpression": { "type": "string", "description": "The SQL expression. e.g. MyProperty='ABC'" }, "compatibilityLevel": { "type": "integer", "format": "int32", "description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." }, "requiresPreprocessing": { "type": "boolean", "description": "Value that indicates whether the rule action requires preprocessing.", "default": true } } }, "Subnet": { "type": "object", "description": "Properties supplied for Subnet", "properties": { "id": { "type": "string", "description": "Resource ID of Virtual Network Subnet" } }, "required": [ "id" ] }, "TlsVersion": { "type": "string", "description": "The minimum TLS version for the cluster to support, e.g. '1.3'", "enum": [ "1.0", "1.1", "1.2", "1.3" ], "x-ms-enum": { "name": "TlsVersion", "modelAsString": true, "values": [ { "name": "1.0", "value": "1.0" }, { "name": "1.1", "value": "1.1" }, { "name": "1.2", "value": "1.2" }, { "name": "1.3", "value": "1.3" } ] } }, "UnavailableReason": { "type": "string", "description": "Specifies the reason for the unavailability of the service.", "enum": [ "None", "InvalidName", "SubscriptionIsDisabled", "NameInUse", "NameInLockdown", "TooManyNamespaceInCurrentSubscription" ], "x-ms-enum": { "name": "UnavailableReason", "modelAsString": false } }, "UserAssignedIdentity": { "type": "object", "description": "Recognized Dictionary value.", "properties": { "principalId": { "type": "string", "description": "Principal Id of user assigned identity", "readOnly": true, "x-ms-client-name": "PrincipalId" }, "clientId": { "type": "string", "description": "Client Id of user assigned identity", "readOnly": true, "x-ms-client-name": "ClientId" } } }, "UserAssignedIdentityProperties": { "type": "object", "properties": { "userAssignedIdentity": { "type": "string", "description": "ARM ID of user Identity selected for encryption" } } } }, "parameters": {} }