{ "swagger": "2.0", "info": { "title": "ServiceBusManagementClient", "description": "Azure Service Bus client", "version": "2024-01-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs": { "get": { "tags": [ "DisasterRecoveryConfigs" ], "operationId": "DisasterRecoveryConfigs_List", "x-ms-examples": { "SBAliasList": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasList.json" } }, "description": "Gets all Alias(Disaster Recovery configurations)", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successfully retrieved the list of Alias(Disaster Recovery configurations) for servicebus namespace", "schema": { "$ref": "#/definitions/ArmDisasterRecoveryListResult" } }, "default": { "description": "ServiceBus error response describing why the operation failed.", "schema": { "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}": { "put": { "tags": [ "DisasterRecoveryConfigs" ], "operationId": "DisasterRecoveryConfigs_CreateOrUpdate", "x-ms-examples": { "SBAliasCreate": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasCreate.json" } }, "description": "Creates or updates a new Alias(Disaster Recovery configuration)", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ArmDisasterRecovery" }, "description": "Parameters required to create an Alias(Disaster Recovery configuration)" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Alias(Disaster Recovery configuration) successfully created", "schema": { "$ref": "#/definitions/ArmDisasterRecovery" } }, "201": { "description": "Alias(Disaster Recovery configuration) creation request received", "schema": { "$ref": "#/definitions/ArmDisasterRecovery" } }, "default": { "description": "ServiceBus error response describing why the operation failed.", "schema": { "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "DisasterRecoveryConfigs" ], "operationId": "DisasterRecoveryConfigs_Delete", "x-ms-examples": { "SBAliasDelete": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasDelete.json" } }, "description": "Deletes an Alias(Disaster Recovery configuration)", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Delete Alias(Disaster Recovery configuration) request accepted" }, "204": { "description": "No content." }, "default": { "description": "ServiceBus error response describing why the operation failed.", "schema": { "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } }, "get": { "tags": [ "DisasterRecoveryConfigs" ], "operationId": "DisasterRecoveryConfigs_Get", "x-ms-examples": { "SBAliasGet": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasGet.json" } }, "description": "Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successfully retrieved the Alias(Disaster Recovery configurations)", "schema": { "$ref": "#/definitions/ArmDisasterRecovery" } }, "default": { "description": "ServiceBus error response describing why the operation failed.", "schema": { "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/breakPairing": { "post": { "tags": [ "DisasterRecoveryConfigs" ], "operationId": "DisasterRecoveryConfigs_BreakPairing", "x-ms-examples": { "SBEHAliasBreakPairing": { "$ref": "./examples/disasterRecoveryConfigs/SBEHAliasBreakPairing.json" } }, "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/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Break-Pairing operation is successful." }, "default": { "description": "ServiceBus error response describing why the operation failed.", "schema": { "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/failover": { "post": { "tags": [ "DisasterRecoveryConfigs" ], "operationId": "DisasterRecoveryConfigs_FailOver", "x-ms-examples": { "SBAliasFailOver": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasFailOver.json" } }, "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/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { "name": "parameters", "in": "body", "required": false, "schema": { "$ref": "#/definitions/FailoverProperties" }, "description": "Parameters required to create an Alias(Disaster Recovery configuration)" } ], "responses": { "200": { "description": "Failover operation is successful." }, "default": { "description": "ServiceBus error response describing why the operation failed.", "schema": { "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } } } }, "definitions": { "ArmDisasterRecovery": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "properties": { "provisioningState": { "readOnly": true, "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 } }, "pendingReplicationOperationsCount": { "readOnly": true, "format": "int64", "type": "integer", "description": "Number of entities pending to be replicated." }, "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": { "readOnly": true, "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 } } }, "description": "Properties required to the Create Or Update Alias(Disaster Recovery configurations)" }, "systemData": { "readOnly": true, "description": "The system meta data relating to this resource.", "$ref": "../../common/v1/definitions.json#/definitions/systemData" } }, "allOf": [ { "$ref": "../../common/v2/definitions.json#/definitions/ProxyResource" } ], "description": "Single item in List or Get Alias(Disaster Recovery configuration) operation" }, "FailoverProperties": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "properties": { "IsSafeFailover": { "type": "boolean", "description": "Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary." } }, "description": "Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary." } }, "description": "Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary." }, "ArmDisasterRecoveryListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ArmDisasterRecovery" }, "description": "List of Alias(Disaster Recovery configurations)" }, "nextLink": { "type": "string", "readOnly": true, "description": "Link to the next set of results. Not empty if Value contains incomplete list of Alias(Disaster Recovery configuration)" } }, "description": "The result of the List Alias(Disaster Recovery configuration) operation." } }, "parameters": {} }