disaster_recovery_configs

Creates, updates, deletes, gets or lists a disaster_recovery_configs resource.

Overview

Name	disaster_recovery_configs
Type	Resource
Id	azure.event_hubs.disaster_recovery_configs

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the Alias(Disaster Recovery configurations)

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
location	string	The geo-location where the resource lives
properties		Properties required to the Create Or Update Alias(Disaster Recovery configurations)
systemData	object	The system meta data relating to this resource.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

list

Successfully retrieved the list of Alias(Disaster Recovery configurations) for eventhub namespace

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
location	string	The geo-location where the resource lives
properties		Properties required to the Create Or Update Alias(Disaster Recovery configurations)
systemData	object	The system meta data relating to this resource.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, namespaceName, alias, subscriptionId		Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace
list	select	resourceGroupName, namespaceName, subscriptionId		Gets all Alias(Disaster Recovery configurations)
create_or_update	insert	resourceGroupName, namespaceName, alias, subscriptionId		Creates or updates a new Alias(Disaster Recovery configuration)
delete	delete	resourceGroupName, namespaceName, alias, subscriptionId		Deletes an Alias(Disaster Recovery configuration)
check_name_availability	exec	subscriptionId, resourceGroupName, namespaceName, name		Check the give Namespace name availability.
break_pairing	exec	resourceGroupName, namespaceName, alias, subscriptionId		This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces
fail_over	exec	resourceGroupName, namespaceName, alias, subscriptionId		Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
alias	string	The Disaster Recovery configuration name
namespaceName	string	The Namespace name
resourceGroupName	string	Name of the resource group within the azure subscription.
subscriptionId	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace

SELECT
id,
name,
location,
properties,
systemData,
type
FROM azure.event_hubs.disaster_recovery_configs
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND alias = '{{ alias }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets all Alias(Disaster Recovery configurations)

SELECT
id,
name,
location,
properties,
systemData,
type
FROM azure.event_hubs.disaster_recovery_configs
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a new Alias(Disaster Recovery configuration)

INSERT INTO azure.event_hubs.disaster_recovery_configs (
data__properties,
resourceGroupName,
namespaceName,
alias,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ namespaceName }}',
'{{ alias }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: disaster_recovery_configs
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the disaster_recovery_configs resource.
    - name: namespaceName
      value: string
      description: Required parameter for the disaster_recovery_configs resource.
    - name: alias
      value: string
      description: Required parameter for the disaster_recovery_configs resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the disaster_recovery_configs resource.
    - name: properties
      value: string
      description: |
        Properties required to the Create Or Update Alias(Disaster Recovery configurations)

DELETE examples

delete

Deletes an Alias(Disaster Recovery configuration)

DELETE FROM azure.event_hubs.disaster_recovery_configs
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND namespaceName = '{{ namespaceName }}' --required
AND alias = '{{ alias }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

check_name_availability

Check the give Namespace name availability.

EXEC azure.event_hubs.disaster_recovery_configs.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@namespaceName='{{ namespaceName }}' --required 
@@json=
'{
"name": "{{ name }}"
}'
;

break_pairing

This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces

EXEC azure.event_hubs.disaster_recovery_configs.break_pairing 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@namespaceName='{{ namespaceName }}' --required, 
@alias='{{ alias }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

fail_over

Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace

EXEC azure.event_hubs.disaster_recovery_configs.fail_over 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@namespaceName='{{ namespaceName }}' --required, 
@alias='{{ alias }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;