Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. eventhub
  5. getDisasterRecoveryConfig
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.eventhub.getDisasterRecoveryConfig

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace Azure REST API version: 2022-10-01-preview.

Other available API versions: 2023-01-01-preview, 2024-01-01, 2024-05-01-preview.

Using getDisasterRecoveryConfig

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDisasterRecoveryConfig(args: GetDisasterRecoveryConfigArgs, opts?: InvokeOptions): Promise<GetDisasterRecoveryConfigResult>
function getDisasterRecoveryConfigOutput(args: GetDisasterRecoveryConfigOutputArgs, opts?: InvokeOptions): Output<GetDisasterRecoveryConfigResult>
Copy
def get_disaster_recovery_config(alias: Optional[str] = None,
                                 namespace_name: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetDisasterRecoveryConfigResult
def get_disaster_recovery_config_output(alias: Optional[pulumi.Input[str]] = None,
                                 namespace_name: Optional[pulumi.Input[str]] = None,
                                 resource_group_name: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetDisasterRecoveryConfigResult]
Copy
func LookupDisasterRecoveryConfig(ctx *Context, args *LookupDisasterRecoveryConfigArgs, opts ...InvokeOption) (*LookupDisasterRecoveryConfigResult, error)
func LookupDisasterRecoveryConfigOutput(ctx *Context, args *LookupDisasterRecoveryConfigOutputArgs, opts ...InvokeOption) LookupDisasterRecoveryConfigResultOutput
Copy

> Note: This function is named LookupDisasterRecoveryConfig in the Go SDK.

public static class GetDisasterRecoveryConfig 
{
    public static Task<GetDisasterRecoveryConfigResult> InvokeAsync(GetDisasterRecoveryConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetDisasterRecoveryConfigResult> Invoke(GetDisasterRecoveryConfigInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDisasterRecoveryConfigResult> getDisasterRecoveryConfig(GetDisasterRecoveryConfigArgs args, InvokeOptions options)
public static Output<GetDisasterRecoveryConfigResult> getDisasterRecoveryConfig(GetDisasterRecoveryConfigArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:eventhub:getDisasterRecoveryConfig
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Alias
This property is required.
Changes to this property will trigger replacement.
string
The Disaster Recovery configuration name
NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The Namespace name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group within the azure subscription.
Alias
This property is required.
Changes to this property will trigger replacement.
string
The Disaster Recovery configuration name
NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The Namespace name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group within the azure subscription.
alias
This property is required.
Changes to this property will trigger replacement.
String
The Disaster Recovery configuration name
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
The Namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group within the azure subscription.
alias
This property is required.
Changes to this property will trigger replacement.
string
The Disaster Recovery configuration name
namespaceName
This property is required.
Changes to this property will trigger replacement.
string
The Namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group within the azure subscription.
alias
This property is required.
Changes to this property will trigger replacement.
str
The Disaster Recovery configuration name
namespace_name
This property is required.
Changes to this property will trigger replacement.
str
The Namespace name
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group within the azure subscription.
alias
This property is required.
Changes to this property will trigger replacement.
String
The Disaster Recovery configuration name
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
The Namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group within the azure subscription.

getDisasterRecoveryConfig Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
PendingReplicationOperationsCount double
Number of entities pending to be replicated.
ProvisioningState string
Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'
Role string
role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'
SystemData Pulumi.AzureNative.EventHub.Outputs.SystemDataResponse
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"
AlternateName string
Alternate name specified when alias and namespace names are same.
PartnerNamespace string
ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
PendingReplicationOperationsCount float64
Number of entities pending to be replicated.
ProvisioningState string
Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'
Role string
role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'
SystemData SystemDataResponse
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"
AlternateName string
Alternate name specified when alias and namespace names are same.
PartnerNamespace string
ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
pendingReplicationOperationsCount Double
Number of entities pending to be replicated.
provisioningState String
Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'
role String
role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'
systemData SystemDataResponse
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"
alternateName String
Alternate name specified when alias and namespace names are same.
partnerNamespace String
ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string
The geo-location where the resource lives
name string
The name of the resource
pendingReplicationOperationsCount number
Number of entities pending to be replicated.
provisioningState string
Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'
role string
role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'
systemData SystemDataResponse
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"
alternateName string
Alternate name specified when alias and namespace names are same.
partnerNamespace string
ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str
The geo-location where the resource lives
name str
The name of the resource
pending_replication_operations_count float
Number of entities pending to be replicated.
provisioning_state str
Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'
role str
role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'
system_data SystemDataResponse
The system meta data relating to this resource.
type str
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
alternate_name str
Alternate name specified when alias and namespace names are same.
partner_namespace str
ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
pendingReplicationOperationsCount Number
Number of entities pending to be replicated.
provisioningState String
Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'
role String
role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'
systemData Property Map
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"
alternateName String
Alternate name specified when alias and namespace names are same.
partnerNamespace String
ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing

Supporting Types

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The type of identity that last modified the resource.
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The type of identity that last modified the resource.
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The type of identity that last modified the resource.
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The type of identity that last modified the resource.
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The type of identity that last modified the resource.
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The type of identity that last modified the resource.
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native