1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsBackupPolicies
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getIsBackupPolicies

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Provides a read-only data source for BackupPolicyCollection. For more information, about backup policy in your IBM Cloud VPC, see Backup policy.

    Note: VPC infrastructure services are a regional specific based endpoint, by default targets to us-south. Please make sure to target right region in the provider block as shown in the provider.tf file, if VPC service is created in region other than us-south.

    provider.tf

    import * as pulumi from "@pulumi/pulumi";
    
    import pulumi
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    
    return await Deployment.RunAsync(() => 
    {
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
        }
    }
    
    {}
    

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const example = ibm.getIsBackupPolicies({});
    
    import pulumi
    import pulumi_ibm as ibm
    
    example = ibm.get_is_backup_policies()
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.GetIsBackupPolicies(ctx, &ibm.GetIsBackupPoliciesArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Ibm.GetIsBackupPolicies.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetIsBackupPoliciesArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = IbmFunctions.getIsBackupPolicies();
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: ibm:getIsBackupPolicies
          arguments: {}
    

    Using getIsBackupPolicies

    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 getIsBackupPolicies(args: GetIsBackupPoliciesArgs, opts?: InvokeOptions): Promise<GetIsBackupPoliciesResult>
    function getIsBackupPoliciesOutput(args: GetIsBackupPoliciesOutputArgs, opts?: InvokeOptions): Output<GetIsBackupPoliciesResult>
    def get_is_backup_policies(id: Optional[str] = None,
                               name: Optional[str] = None,
                               resource_group: Optional[str] = None,
                               tag: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetIsBackupPoliciesResult
    def get_is_backup_policies_output(id: Optional[pulumi.Input[str]] = None,
                               name: Optional[pulumi.Input[str]] = None,
                               resource_group: Optional[pulumi.Input[str]] = None,
                               tag: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetIsBackupPoliciesResult]
    func GetIsBackupPolicies(ctx *Context, args *GetIsBackupPoliciesArgs, opts ...InvokeOption) (*GetIsBackupPoliciesResult, error)
    func GetIsBackupPoliciesOutput(ctx *Context, args *GetIsBackupPoliciesOutputArgs, opts ...InvokeOption) GetIsBackupPoliciesResultOutput

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

    public static class GetIsBackupPolicies 
    {
        public static Task<GetIsBackupPoliciesResult> InvokeAsync(GetIsBackupPoliciesArgs args, InvokeOptions? opts = null)
        public static Output<GetIsBackupPoliciesResult> Invoke(GetIsBackupPoliciesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIsBackupPoliciesResult> getIsBackupPolicies(GetIsBackupPoliciesArgs args, InvokeOptions options)
    public static Output<GetIsBackupPoliciesResult> getIsBackupPolicies(GetIsBackupPoliciesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getIsBackupPolicies:getIsBackupPolicies
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    (String) The unique identifier for this enterprise or account.
    Name string
    Filters the collection to resources with the exact specified name.
    ResourceGroup string
    Filters the collection to resources in the resource group with the specified identifier.
    Tag string
    Filters the collection to resources with the exact tag value.
    Id string
    (String) The unique identifier for this enterprise or account.
    Name string
    Filters the collection to resources with the exact specified name.
    ResourceGroup string
    Filters the collection to resources in the resource group with the specified identifier.
    Tag string
    Filters the collection to resources with the exact tag value.
    id String
    (String) The unique identifier for this enterprise or account.
    name String
    Filters the collection to resources with the exact specified name.
    resourceGroup String
    Filters the collection to resources in the resource group with the specified identifier.
    tag String
    Filters the collection to resources with the exact tag value.
    id string
    (String) The unique identifier for this enterprise or account.
    name string
    Filters the collection to resources with the exact specified name.
    resourceGroup string
    Filters the collection to resources in the resource group with the specified identifier.
    tag string
    Filters the collection to resources with the exact tag value.
    id str
    (String) The unique identifier for this enterprise or account.
    name str
    Filters the collection to resources with the exact specified name.
    resource_group str
    Filters the collection to resources in the resource group with the specified identifier.
    tag str
    Filters the collection to resources with the exact tag value.
    id String
    (String) The unique identifier for this enterprise or account.
    name String
    Filters the collection to resources with the exact specified name.
    resourceGroup String
    Filters the collection to resources in the resource group with the specified identifier.
    tag String
    Filters the collection to resources with the exact tag value.

    getIsBackupPolicies Result

    The following output properties are available:

    BackupPolicies List<GetIsBackupPoliciesBackupPolicy>
    (List) Collection of backup policies.
    Id string
    (String) The unique identifier for this enterprise or account.
    Name string
    (String) The user-defined name for this resource group.
    ResourceGroup string
    (List) The resource group object, for this backup policy.
    Tag string
    BackupPolicies []GetIsBackupPoliciesBackupPolicy
    (List) Collection of backup policies.
    Id string
    (String) The unique identifier for this enterprise or account.
    Name string
    (String) The user-defined name for this resource group.
    ResourceGroup string
    (List) The resource group object, for this backup policy.
    Tag string
    backupPolicies List<GetIsBackupPoliciesBackupPolicy>
    (List) Collection of backup policies.
    id String
    (String) The unique identifier for this enterprise or account.
    name String
    (String) The user-defined name for this resource group.
    resourceGroup String
    (List) The resource group object, for this backup policy.
    tag String
    backupPolicies GetIsBackupPoliciesBackupPolicy[]
    (List) Collection of backup policies.
    id string
    (String) The unique identifier for this enterprise or account.
    name string
    (String) The user-defined name for this resource group.
    resourceGroup string
    (List) The resource group object, for this backup policy.
    tag string
    backup_policies Sequence[GetIsBackupPoliciesBackupPolicy]
    (List) Collection of backup policies.
    id str
    (String) The unique identifier for this enterprise or account.
    name str
    (String) The user-defined name for this resource group.
    resource_group str
    (List) The resource group object, for this backup policy.
    tag str
    backupPolicies List<Property Map>
    (List) Collection of backup policies.
    id String
    (String) The unique identifier for this enterprise or account.
    name String
    (String) The user-defined name for this resource group.
    resourceGroup String
    (List) The resource group object, for this backup policy.
    tag String

    Supporting Types

    GetIsBackupPoliciesBackupPolicy

    CreatedAt string
    (String) The date and time that the backup policy was created.
    Crn string
    (String) The CRN for this enterprise.
    HealthReasons List<GetIsBackupPoliciesBackupPolicyHealthReason>
    (List) The reasons for the current health_state (if any).
    HealthState string
    (String) The health of this resource.
    Href string
    (String) The URL for this resource group.
    Id string
    (String) The unique identifier for this enterprise or account.
    IncludedContents List<string>
    (Optional, List) The included content for backups created using this policy.
    LastJobCompletedAt string
    (String) he date and time that the most recent job for this backup policy completed.
    LifecycleState string
    (String) The lifecycle state of the backup policy.
    MatchResourceType string
    (Optional, String) The resource type this backup policy will apply to. Resources that have both a matching type and a matching user tag will be subject to the backup policy.
    MatchResourceTypes List<string>

    (List) A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy.

    Note match_resource_types is deprecated. Please use match_resource_type instead.

    MatchUserTags List<string>
    (List) The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.
    Name string
    Filters the collection to resources with the exact specified name.
    Plans List<GetIsBackupPoliciesBackupPolicyPlan>
    (List) The plans for the backup policy.
    ResourceGroups List<GetIsBackupPoliciesBackupPolicyResourceGroup>
    Filters the collection to resources in the resource group with the specified identifier.
    ResourceType string
    (String) The resource type.
    Scopes List<GetIsBackupPoliciesBackupPolicyScope>
    (List) If present, the scope for this backup policy.
    CreatedAt string
    (String) The date and time that the backup policy was created.
    Crn string
    (String) The CRN for this enterprise.
    HealthReasons []GetIsBackupPoliciesBackupPolicyHealthReason
    (List) The reasons for the current health_state (if any).
    HealthState string
    (String) The health of this resource.
    Href string
    (String) The URL for this resource group.
    Id string
    (String) The unique identifier for this enterprise or account.
    IncludedContents []string
    (Optional, List) The included content for backups created using this policy.
    LastJobCompletedAt string
    (String) he date and time that the most recent job for this backup policy completed.
    LifecycleState string
    (String) The lifecycle state of the backup policy.
    MatchResourceType string
    (Optional, String) The resource type this backup policy will apply to. Resources that have both a matching type and a matching user tag will be subject to the backup policy.
    MatchResourceTypes []string

    (List) A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy.

    Note match_resource_types is deprecated. Please use match_resource_type instead.

    MatchUserTags []string
    (List) The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.
    Name string
    Filters the collection to resources with the exact specified name.
    Plans []GetIsBackupPoliciesBackupPolicyPlan
    (List) The plans for the backup policy.
    ResourceGroups []GetIsBackupPoliciesBackupPolicyResourceGroup
    Filters the collection to resources in the resource group with the specified identifier.
    ResourceType string
    (String) The resource type.
    Scopes []GetIsBackupPoliciesBackupPolicyScope
    (List) If present, the scope for this backup policy.
    createdAt String
    (String) The date and time that the backup policy was created.
    crn String
    (String) The CRN for this enterprise.
    healthReasons List<GetIsBackupPoliciesBackupPolicyHealthReason>
    (List) The reasons for the current health_state (if any).
    healthState String
    (String) The health of this resource.
    href String
    (String) The URL for this resource group.
    id String
    (String) The unique identifier for this enterprise or account.
    includedContents List<String>
    (Optional, List) The included content for backups created using this policy.
    lastJobCompletedAt String
    (String) he date and time that the most recent job for this backup policy completed.
    lifecycleState String
    (String) The lifecycle state of the backup policy.
    matchResourceType String
    (Optional, String) The resource type this backup policy will apply to. Resources that have both a matching type and a matching user tag will be subject to the backup policy.
    matchResourceTypes List<String>

    (List) A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy.

    Note match_resource_types is deprecated. Please use match_resource_type instead.

    matchUserTags List<String>
    (List) The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.
    name String
    Filters the collection to resources with the exact specified name.
    plans List<GetIsBackupPoliciesBackupPolicyPlan>
    (List) The plans for the backup policy.
    resourceGroups List<GetIsBackupPoliciesBackupPolicyResourceGroup>
    Filters the collection to resources in the resource group with the specified identifier.
    resourceType String
    (String) The resource type.
    scopes List<GetIsBackupPoliciesBackupPolicyScope>
    (List) If present, the scope for this backup policy.
    createdAt string
    (String) The date and time that the backup policy was created.
    crn string
    (String) The CRN for this enterprise.
    healthReasons GetIsBackupPoliciesBackupPolicyHealthReason[]
    (List) The reasons for the current health_state (if any).
    healthState string
    (String) The health of this resource.
    href string
    (String) The URL for this resource group.
    id string
    (String) The unique identifier for this enterprise or account.
    includedContents string[]
    (Optional, List) The included content for backups created using this policy.
    lastJobCompletedAt string
    (String) he date and time that the most recent job for this backup policy completed.
    lifecycleState string
    (String) The lifecycle state of the backup policy.
    matchResourceType string
    (Optional, String) The resource type this backup policy will apply to. Resources that have both a matching type and a matching user tag will be subject to the backup policy.
    matchResourceTypes string[]

    (List) A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy.

    Note match_resource_types is deprecated. Please use match_resource_type instead.

    matchUserTags string[]
    (List) The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.
    name string
    Filters the collection to resources with the exact specified name.
    plans GetIsBackupPoliciesBackupPolicyPlan[]
    (List) The plans for the backup policy.
    resourceGroups GetIsBackupPoliciesBackupPolicyResourceGroup[]
    Filters the collection to resources in the resource group with the specified identifier.
    resourceType string
    (String) The resource type.
    scopes GetIsBackupPoliciesBackupPolicyScope[]
    (List) If present, the scope for this backup policy.
    created_at str
    (String) The date and time that the backup policy was created.
    crn str
    (String) The CRN for this enterprise.
    health_reasons Sequence[GetIsBackupPoliciesBackupPolicyHealthReason]
    (List) The reasons for the current health_state (if any).
    health_state str
    (String) The health of this resource.
    href str
    (String) The URL for this resource group.
    id str
    (String) The unique identifier for this enterprise or account.
    included_contents Sequence[str]
    (Optional, List) The included content for backups created using this policy.
    last_job_completed_at str
    (String) he date and time that the most recent job for this backup policy completed.
    lifecycle_state str
    (String) The lifecycle state of the backup policy.
    match_resource_type str
    (Optional, String) The resource type this backup policy will apply to. Resources that have both a matching type and a matching user tag will be subject to the backup policy.
    match_resource_types Sequence[str]

    (List) A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy.

    Note match_resource_types is deprecated. Please use match_resource_type instead.

    match_user_tags Sequence[str]
    (List) The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.
    name str
    Filters the collection to resources with the exact specified name.
    plans Sequence[GetIsBackupPoliciesBackupPolicyPlan]
    (List) The plans for the backup policy.
    resource_groups Sequence[GetIsBackupPoliciesBackupPolicyResourceGroup]
    Filters the collection to resources in the resource group with the specified identifier.
    resource_type str
    (String) The resource type.
    scopes Sequence[GetIsBackupPoliciesBackupPolicyScope]
    (List) If present, the scope for this backup policy.
    createdAt String
    (String) The date and time that the backup policy was created.
    crn String
    (String) The CRN for this enterprise.
    healthReasons List<Property Map>
    (List) The reasons for the current health_state (if any).
    healthState String
    (String) The health of this resource.
    href String
    (String) The URL for this resource group.
    id String
    (String) The unique identifier for this enterprise or account.
    includedContents List<String>
    (Optional, List) The included content for backups created using this policy.
    lastJobCompletedAt String
    (String) he date and time that the most recent job for this backup policy completed.
    lifecycleState String
    (String) The lifecycle state of the backup policy.
    matchResourceType String
    (Optional, String) The resource type this backup policy will apply to. Resources that have both a matching type and a matching user tag will be subject to the backup policy.
    matchResourceTypes List<String>

    (List) A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy.

    Note match_resource_types is deprecated. Please use match_resource_type instead.

    matchUserTags List<String>
    (List) The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.
    name String
    Filters the collection to resources with the exact specified name.
    plans List<Property Map>
    (List) The plans for the backup policy.
    resourceGroups List<Property Map>
    Filters the collection to resources in the resource group with the specified identifier.
    resourceType String
    (String) The resource type.
    scopes List<Property Map>
    (List) If present, the scope for this backup policy.

    GetIsBackupPoliciesBackupPolicyHealthReason

    Code string
    (String) A snake case string succinctly identifying the reason for this health state.
    Message string
    (String) An explanation of the reason for this health state.
    MoreInfo string
    (String) Link to documentation about deleted resources.
    Code string
    (String) A snake case string succinctly identifying the reason for this health state.
    Message string
    (String) An explanation of the reason for this health state.
    MoreInfo string
    (String) Link to documentation about deleted resources.
    code String
    (String) A snake case string succinctly identifying the reason for this health state.
    message String
    (String) An explanation of the reason for this health state.
    moreInfo String
    (String) Link to documentation about deleted resources.
    code string
    (String) A snake case string succinctly identifying the reason for this health state.
    message string
    (String) An explanation of the reason for this health state.
    moreInfo string
    (String) Link to documentation about deleted resources.
    code str
    (String) A snake case string succinctly identifying the reason for this health state.
    message str
    (String) An explanation of the reason for this health state.
    more_info str
    (String) Link to documentation about deleted resources.
    code String
    (String) A snake case string succinctly identifying the reason for this health state.
    message String
    (String) An explanation of the reason for this health state.
    moreInfo String
    (String) Link to documentation about deleted resources.

    GetIsBackupPoliciesBackupPolicyPlan

    Deleteds List<GetIsBackupPoliciesBackupPolicyPlanDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    Href string
    (String) The URL for this resource group.
    Id string
    (String) The unique identifier for this enterprise or account.
    Name string
    Filters the collection to resources with the exact specified name.
    ResourceType string
    (String) The resource type.
    Deleteds []GetIsBackupPoliciesBackupPolicyPlanDeleted
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    Href string
    (String) The URL for this resource group.
    Id string
    (String) The unique identifier for this enterprise or account.
    Name string
    Filters the collection to resources with the exact specified name.
    ResourceType string
    (String) The resource type.
    deleteds List<GetIsBackupPoliciesBackupPolicyPlanDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href String
    (String) The URL for this resource group.
    id String
    (String) The unique identifier for this enterprise or account.
    name String
    Filters the collection to resources with the exact specified name.
    resourceType String
    (String) The resource type.
    deleteds GetIsBackupPoliciesBackupPolicyPlanDeleted[]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href string
    (String) The URL for this resource group.
    id string
    (String) The unique identifier for this enterprise or account.
    name string
    Filters the collection to resources with the exact specified name.
    resourceType string
    (String) The resource type.
    deleteds Sequence[GetIsBackupPoliciesBackupPolicyPlanDeleted]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href str
    (String) The URL for this resource group.
    id str
    (String) The unique identifier for this enterprise or account.
    name str
    Filters the collection to resources with the exact specified name.
    resource_type str
    (String) The resource type.
    deleteds List<Property Map>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href String
    (String) The URL for this resource group.
    id String
    (String) The unique identifier for this enterprise or account.
    name String
    Filters the collection to resources with the exact specified name.
    resourceType String
    (String) The resource type.

    GetIsBackupPoliciesBackupPolicyPlanDeleted

    MoreInfo string
    (String) Link to documentation about deleted resources.
    MoreInfo string
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.
    moreInfo string
    (String) Link to documentation about deleted resources.
    more_info str
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.

    GetIsBackupPoliciesBackupPolicyResourceGroup

    Href string
    (String) The URL for this resource group.
    Id string
    (String) The unique identifier for this enterprise or account.
    Name string
    Filters the collection to resources with the exact specified name.
    Href string
    (String) The URL for this resource group.
    Id string
    (String) The unique identifier for this enterprise or account.
    Name string
    Filters the collection to resources with the exact specified name.
    href String
    (String) The URL for this resource group.
    id String
    (String) The unique identifier for this enterprise or account.
    name String
    Filters the collection to resources with the exact specified name.
    href string
    (String) The URL for this resource group.
    id string
    (String) The unique identifier for this enterprise or account.
    name string
    Filters the collection to resources with the exact specified name.
    href str
    (String) The URL for this resource group.
    id str
    (String) The unique identifier for this enterprise or account.
    name str
    Filters the collection to resources with the exact specified name.
    href String
    (String) The URL for this resource group.
    id String
    (String) The unique identifier for this enterprise or account.
    name String
    Filters the collection to resources with the exact specified name.

    GetIsBackupPoliciesBackupPolicyScope

    Crn string
    (String) The CRN for this enterprise.
    Id string
    (String) The unique identifier for this enterprise or account.
    ResourceType string
    (String) The resource type.
    Crn string
    (String) The CRN for this enterprise.
    Id string
    (String) The unique identifier for this enterprise or account.
    ResourceType string
    (String) The resource type.
    crn String
    (String) The CRN for this enterprise.
    id String
    (String) The unique identifier for this enterprise or account.
    resourceType String
    (String) The resource type.
    crn string
    (String) The CRN for this enterprise.
    id string
    (String) The unique identifier for this enterprise or account.
    resourceType string
    (String) The resource type.
    crn str
    (String) The CRN for this enterprise.
    id str
    (String) The unique identifier for this enterprise or account.
    resource_type str
    (String) The resource type.
    crn String
    (String) The CRN for this enterprise.
    id String
    (String) The unique identifier for this enterprise or account.
    resourceType String
    (String) The resource type.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud