Microsoft.EventHub (preview:2024-05-01)

2025/02/12 • 1 updated methods

Namespaces_Failover (updated)
Description :  GeoDR Failover
Reference :  Link ¶

⚶ Changes

{
  "#id": "Namespaces_Failover",
  "$responses": {
    "default": {
      "Description": {
        "new": "Error response indicates Event Hub service is not able to process the incoming request. The reason is provided in the error message.",
        "old": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)."
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/failover
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for updating a namespace resource. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
primaryLocation:
{
Description: Query parameter for the new primary location after failover. ,
Required: False ,
}
string ,
force:
{
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. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}