Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. dataprotection
  5. getBackupVault
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.dataprotection.getBackupVault

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    Returns a resource belonging to a resource group. Azure REST API version: 2023-01-01.

    Other available API versions: 2023-04-01-preview, 2023-05-01, 2023-06-01-preview, 2023-08-01-preview, 2023-11-01, 2023-12-01, 2024-02-01-preview, 2024-03-01, 2024-04-01, 2025-01-01.

    Using getBackupVault

    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 getBackupVault(args: GetBackupVaultArgs, opts?: InvokeOptions): Promise<GetBackupVaultResult>
function getBackupVaultOutput(args: GetBackupVaultOutputArgs, opts?: InvokeOptions): Output<GetBackupVaultResult>
    def get_backup_vault(resource_group_name: Optional[str] = None,
                     vault_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetBackupVaultResult
def get_backup_vault_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                     vault_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetBackupVaultResult]
    func LookupBackupVault(ctx *Context, args *LookupBackupVaultArgs, opts ...InvokeOption) (*LookupBackupVaultResult, error)
func LookupBackupVaultOutput(ctx *Context, args *LookupBackupVaultOutputArgs, opts ...InvokeOption) LookupBackupVaultResultOutput

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

    public static class GetBackupVault 
{
    public static Task<GetBackupVaultResult> InvokeAsync(GetBackupVaultArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupVaultResult> Invoke(GetBackupVaultInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBackupVaultResult> getBackupVault(GetBackupVaultArgs args, InvokeOptions options)
public static Output<GetBackupVaultResult> getBackupVault(GetBackupVaultArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:dataprotection:getBackupVault
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VaultName string
    The name of the backup vault.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VaultName string
    The name of the backup vault.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    vaultName String
    The name of the backup vault.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    vaultName string
    The name of the backup vault.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    vault_name str
    The name of the backup vault.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    vaultName String
    The name of the backup vault.

    getBackupVault Result

    The following output properties are available:

    Id string
    Resource Id represents the complete path to the resource.
    Location string
    Resource location.
    Name string
    Resource name associated with the resource.
    Properties Pulumi.AzureNative.DataProtection.Outputs.BackupVaultResponse
    BackupVaultResource properties
    SystemData Pulumi.AzureNative.DataProtection.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
    ETag string
    Optional ETag.
    Identity Pulumi.AzureNative.DataProtection.Outputs.DppIdentityDetailsResponse
    Input Managed Identity Details
    Tags Dictionary<string, string>
    Resource tags.
    Id string
    Resource Id represents the complete path to the resource.
    Location string
    Resource location.
    Name string
    Resource name associated with the resource.
    Properties BackupVaultResponse
    BackupVaultResource properties
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
    ETag string
    Optional ETag.
    Identity DppIdentityDetailsResponse
    Input Managed Identity Details
    Tags map[string]string
    Resource tags.
    id String
    Resource Id represents the complete path to the resource.
    location String
    Resource location.
    name String
    Resource name associated with the resource.
    properties BackupVaultResponse
    BackupVaultResource properties
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type String
    Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
    eTag String
    Optional ETag.
    identity DppIdentityDetailsResponse
    Input Managed Identity Details
    tags Map<String,String>
    Resource tags.
    id string
    Resource Id represents the complete path to the resource.
    location string
    Resource location.
    name string
    Resource name associated with the resource.
    properties BackupVaultResponse
    BackupVaultResource properties
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type string
    Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
    eTag string
    Optional ETag.
    identity DppIdentityDetailsResponse
    Input Managed Identity Details
    tags {[key: string]: string}
    Resource tags.
    id str
    Resource Id represents the complete path to the resource.
    location str
    Resource location.
    name str
    Resource name associated with the resource.
    properties BackupVaultResponse
    BackupVaultResource properties
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type str
    Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
    e_tag str
    Optional ETag.
    identity DppIdentityDetailsResponse
    Input Managed Identity Details
    tags Mapping[str, str]
    Resource tags.
    id String
    Resource Id represents the complete path to the resource.
    location String
    Resource location.
    name String
    Resource name associated with the resource.
    properties Property Map
    BackupVaultResource properties
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource.
    type String
    Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
    eTag String
    Optional ETag.
    identity Property Map
    Input Managed Identity Details
    tags Map<String>
    Resource tags.

    Supporting Types

    AzureMonitorAlertSettingsResponse

    BackupVaultResponse

    IsVaultProtectedByResourceGuard bool
    Is vault protected by resource guard
    ProvisioningState string
    Provisioning state of the BackupVault resource
    ResourceMoveDetails ResourceMoveDetailsResponse
    Resource move details for backup vault
    ResourceMoveState string
    Resource move state for backup vault
    StorageSettings []StorageSettingResponse
    Storage Settings
    FeatureSettings FeatureSettingsResponse
    Feature Settings
    MonitoringSettings MonitoringSettingsResponse
    Monitoring Settings
    SecuritySettings SecuritySettingsResponse
    Security Settings
    isVaultProtectedByResourceGuard Boolean
    Is vault protected by resource guard
    provisioningState String
    Provisioning state of the BackupVault resource
    resourceMoveDetails ResourceMoveDetailsResponse
    Resource move details for backup vault
    resourceMoveState String
    Resource move state for backup vault
    storageSettings List<StorageSettingResponse>
    Storage Settings
    featureSettings FeatureSettingsResponse
    Feature Settings
    monitoringSettings MonitoringSettingsResponse
    Monitoring Settings
    securitySettings SecuritySettingsResponse
    Security Settings
    isVaultProtectedByResourceGuard boolean
    Is vault protected by resource guard
    provisioningState string
    Provisioning state of the BackupVault resource
    resourceMoveDetails ResourceMoveDetailsResponse
    Resource move details for backup vault
    resourceMoveState string
    Resource move state for backup vault
    storageSettings StorageSettingResponse[]
    Storage Settings
    featureSettings FeatureSettingsResponse
    Feature Settings
    monitoringSettings MonitoringSettingsResponse
    Monitoring Settings
    securitySettings SecuritySettingsResponse
    Security Settings
    is_vault_protected_by_resource_guard bool
    Is vault protected by resource guard
    provisioning_state str
    Provisioning state of the BackupVault resource
    resource_move_details ResourceMoveDetailsResponse
    Resource move details for backup vault
    resource_move_state str
    Resource move state for backup vault
    storage_settings Sequence[StorageSettingResponse]
    Storage Settings
    feature_settings FeatureSettingsResponse
    Feature Settings
    monitoring_settings MonitoringSettingsResponse
    Monitoring Settings
    security_settings SecuritySettingsResponse
    Security Settings
    isVaultProtectedByResourceGuard Boolean
    Is vault protected by resource guard
    provisioningState String
    Provisioning state of the BackupVault resource
    resourceMoveDetails Property Map
    Resource move details for backup vault
    resourceMoveState String
    Resource move state for backup vault
    storageSettings List<Property Map>
    Storage Settings
    featureSettings Property Map
    Feature Settings
    monitoringSettings Property Map
    Monitoring Settings
    securitySettings Property Map
    Security Settings

    CrossSubscriptionRestoreSettingsResponse

    State string
    CrossSubscriptionRestore state
    State string
    CrossSubscriptionRestore state
    state String
    CrossSubscriptionRestore state
    state string
    CrossSubscriptionRestore state
    state str
    CrossSubscriptionRestore state
    state String
    CrossSubscriptionRestore state

    DppIdentityDetailsResponse

    PrincipalId string
    The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource.
    TenantId string
    A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.
    Type string
    The identityType which can be either SystemAssigned or None
    PrincipalId string
    The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource.
    TenantId string
    A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.
    Type string
    The identityType which can be either SystemAssigned or None
    principalId String
    The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource.
    tenantId String
    A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.
    type String
    The identityType which can be either SystemAssigned or None
    principalId string
    The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource.
    tenantId string
    A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.
    type string
    The identityType which can be either SystemAssigned or None
    principal_id str
    The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource.
    tenant_id str
    A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.
    type str
    The identityType which can be either SystemAssigned or None
    principalId String
    The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource.
    tenantId String
    A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.
    type String
    The identityType which can be either SystemAssigned or None

    FeatureSettingsResponse

    crossSubscriptionRestoreSettings Property Map
    CrossSubscriptionRestore Settings

    ImmutabilitySettingsResponse

    State string
    Immutability state
    State string
    Immutability state
    state String
    Immutability state
    state string
    Immutability state
    state str
    Immutability state
    state String
    Immutability state

    MonitoringSettingsResponse

    AzureMonitorAlertSettings AzureMonitorAlertSettingsResponse
    Settings for Azure Monitor based alerts
    azureMonitorAlertSettings AzureMonitorAlertSettingsResponse
    Settings for Azure Monitor based alerts
    azureMonitorAlertSettings AzureMonitorAlertSettingsResponse
    Settings for Azure Monitor based alerts
    azureMonitorAlertSettings Property Map
    Settings for Azure Monitor based alerts

    ResourceMoveDetailsResponse

    CompletionTimeUtc string
    Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
    OperationId string
    CorrelationId of latest ResourceMove operation attempted
    SourceResourcePath string
    ARM resource path of source resource
    StartTimeUtc string
    Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
    TargetResourcePath string
    ARM resource path of target resource used in latest ResourceMove operation
    CompletionTimeUtc string
    Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
    OperationId string
    CorrelationId of latest ResourceMove operation attempted
    SourceResourcePath string
    ARM resource path of source resource
    StartTimeUtc string
    Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
    TargetResourcePath string
    ARM resource path of target resource used in latest ResourceMove operation
    completionTimeUtc String
    Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
    operationId String
    CorrelationId of latest ResourceMove operation attempted
    sourceResourcePath String
    ARM resource path of source resource
    startTimeUtc String
    Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
    targetResourcePath String
    ARM resource path of target resource used in latest ResourceMove operation
    completionTimeUtc string
    Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
    operationId string
    CorrelationId of latest ResourceMove operation attempted
    sourceResourcePath string
    ARM resource path of source resource
    startTimeUtc string
    Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
    targetResourcePath string
    ARM resource path of target resource used in latest ResourceMove operation
    completion_time_utc str
    Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
    operation_id str
    CorrelationId of latest ResourceMove operation attempted
    source_resource_path str
    ARM resource path of source resource
    start_time_utc str
    Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
    target_resource_path str
    ARM resource path of target resource used in latest ResourceMove operation
    completionTimeUtc String
    Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
    operationId String
    CorrelationId of latest ResourceMove operation attempted
    sourceResourcePath String
    ARM resource path of source resource
    startTimeUtc String
    Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
    targetResourcePath String
    ARM resource path of target resource used in latest ResourceMove operation

    SecuritySettingsResponse

    ImmutabilitySettings ImmutabilitySettingsResponse
    Immutability Settings at vault level
    SoftDeleteSettings SoftDeleteSettingsResponse
    Soft delete related settings
    immutabilitySettings ImmutabilitySettingsResponse
    Immutability Settings at vault level
    softDeleteSettings SoftDeleteSettingsResponse
    Soft delete related settings
    immutabilitySettings ImmutabilitySettingsResponse
    Immutability Settings at vault level
    softDeleteSettings SoftDeleteSettingsResponse
    Soft delete related settings
    immutability_settings ImmutabilitySettingsResponse
    Immutability Settings at vault level
    soft_delete_settings SoftDeleteSettingsResponse
    Soft delete related settings
    immutabilitySettings Property Map
    Immutability Settings at vault level
    softDeleteSettings Property Map
    Soft delete related settings

    SoftDeleteSettingsResponse

    RetentionDurationInDays double
    Soft delete retention duration
    State string
    State of soft delete
    RetentionDurationInDays float64
    Soft delete retention duration
    State string
    State of soft delete
    retentionDurationInDays Double
    Soft delete retention duration
    state String
    State of soft delete
    retentionDurationInDays number
    Soft delete retention duration
    state string
    State of soft delete
    retention_duration_in_days float
    Soft delete retention duration
    state str
    State of soft delete
    retentionDurationInDays Number
    Soft delete retention duration
    state String
    State of soft delete

    StorageSettingResponse

    DatastoreType string
    Gets or sets the type of the datastore.
    Type string
    Gets or sets the type.
    DatastoreType string
    Gets or sets the type of the datastore.
    Type string
    Gets or sets the type.
    datastoreType String
    Gets or sets the type of the datastore.
    type String
    Gets or sets the type.
    datastoreType string
    Gets or sets the type of the datastore.
    type string
    Gets or sets the type.
    datastore_type str
    Gets or sets the type of the datastore.
    type str
    Gets or sets the type.
    datastoreType String
    Gets or sets the type of the datastore.
    type String
    Gets or sets the type.

    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native