Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsShareSnapshot
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getIsShareSnapshot

Explore with Pulumi AI

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

    Provides a read-only data source to retrieve information about a ShareSnapshot. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

    Using getIsShareSnapshot

    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 getIsShareSnapshot(args: GetIsShareSnapshotArgs, opts?: InvokeOptions): Promise<GetIsShareSnapshotResult>
function getIsShareSnapshotOutput(args: GetIsShareSnapshotOutputArgs, opts?: InvokeOptions): Output<GetIsShareSnapshotResult>
    def get_is_share_snapshot(id: Optional[str] = None,
                          share: Optional[str] = None,
                          share_snapshot: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetIsShareSnapshotResult
def get_is_share_snapshot_output(id: Optional[pulumi.Input[str]] = None,
                          share: Optional[pulumi.Input[str]] = None,
                          share_snapshot: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetIsShareSnapshotResult]
    func LookupIsShareSnapshot(ctx *Context, args *LookupIsShareSnapshotArgs, opts ...InvokeOption) (*LookupIsShareSnapshotResult, error)
func LookupIsShareSnapshotOutput(ctx *Context, args *LookupIsShareSnapshotOutputArgs, opts ...InvokeOption) LookupIsShareSnapshotResultOutput

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

    public static class GetIsShareSnapshot 
{
    public static Task<GetIsShareSnapshotResult> InvokeAsync(GetIsShareSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetIsShareSnapshotResult> Invoke(GetIsShareSnapshotInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIsShareSnapshotResult> getIsShareSnapshot(GetIsShareSnapshotArgs args, InvokeOptions options)
public static Output<GetIsShareSnapshotResult> getIsShareSnapshot(GetIsShareSnapshotArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getIsShareSnapshot:getIsShareSnapshot
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Share string
    The file share identifier.
    ShareSnapshot string
    The share snapshot identifier.
    Id string
    (String) The unique identifier for this resource group.
    Share string
    The file share identifier.
    ShareSnapshot string
    The share snapshot identifier.
    Id string
    (String) The unique identifier for this resource group.
    share String
    The file share identifier.
    shareSnapshot String
    The share snapshot identifier.
    id String
    (String) The unique identifier for this resource group.
    share string
    The file share identifier.
    shareSnapshot string
    The share snapshot identifier.
    id string
    (String) The unique identifier for this resource group.
    share str
    The file share identifier.
    share_snapshot str
    The share snapshot identifier.
    id str
    (String) The unique identifier for this resource group.
    share String
    The file share identifier.
    shareSnapshot String
    The share snapshot identifier.
    id String
    (String) The unique identifier for this resource group.

    getIsShareSnapshot Result

    The following output properties are available:

    BackupPolicyPlans List<GetIsShareSnapshotBackupPolicyPlan>
    (List) If present, the backup policy plan which created this share snapshot. Nested schema for backup_policy_plan:
    CapturedAt string
    (String) The date and time the data capture for this share snapshot was completed.If absent, this snapshot's data has not yet been captured.
    CreatedAt string
    (String) The date and time that the share snapshot was created.
    Crn string
    (String) The CRN for this share snapshot.
    Fingerprint string
    (String) The fingerprint for this snapshot.
    Href string
    (String) The URL for this zone.
    Id string
    (String) The unique identifier for this resource group.
    LifecycleState string
    (String) The lifecycle state of this share snapshot.
    MinimumSize double
    (Integer) The minimum size of a share created from this snapshot. When a snapshot is created, this will be set to the size of the source_share.
    Name string
    (String) The globally unique name for this zone.
    ResourceGroups List<GetIsShareSnapshotResourceGroup>
    (List) The resource group for this file share. Nested schema for resource_group:
    ResourceType string
    (String) The resource type.
    Share string
    ShareSnapshot string
    Status string
    (String) The status of the share snapshot:- available: The share snapshot is available for use.- failed: The share snapshot is irrecoverably unusable.- pending: The share snapshot is being provisioned and is not yet usable.- unusable: The share snapshot is not currently usable (see status_reasons)The enumerated values for this property mayexpand in the future.
    StatusReasons List<GetIsShareSnapshotStatusReason>
    (List) The reasons for the current status (if any). Nested schema for status_reasons:
    Tags List<string>
    (List) The user tags associated with this share snapshot.
    UserTags List<string>
    Zones List<GetIsShareSnapshotZone>
    (List) The zone this share snapshot resides in. Nested schema for zone:
    BackupPolicyPlans []GetIsShareSnapshotBackupPolicyPlan
    (List) If present, the backup policy plan which created this share snapshot. Nested schema for backup_policy_plan:
    CapturedAt string
    (String) The date and time the data capture for this share snapshot was completed.If absent, this snapshot's data has not yet been captured.
    CreatedAt string
    (String) The date and time that the share snapshot was created.
    Crn string
    (String) The CRN for this share snapshot.
    Fingerprint string
    (String) The fingerprint for this snapshot.
    Href string
    (String) The URL for this zone.
    Id string
    (String) The unique identifier for this resource group.
    LifecycleState string
    (String) The lifecycle state of this share snapshot.
    MinimumSize float64
    (Integer) The minimum size of a share created from this snapshot. When a snapshot is created, this will be set to the size of the source_share.
    Name string
    (String) The globally unique name for this zone.
    ResourceGroups []GetIsShareSnapshotResourceGroup
    (List) The resource group for this file share. Nested schema for resource_group:
    ResourceType string
    (String) The resource type.
    Share string
    ShareSnapshot string
    Status string
    (String) The status of the share snapshot:- available: The share snapshot is available for use.- failed: The share snapshot is irrecoverably unusable.- pending: The share snapshot is being provisioned and is not yet usable.- unusable: The share snapshot is not currently usable (see status_reasons)The enumerated values for this property mayexpand in the future.
    StatusReasons []GetIsShareSnapshotStatusReason
    (List) The reasons for the current status (if any). Nested schema for status_reasons:
    Tags []string
    (List) The user tags associated with this share snapshot.
    UserTags []string
    Zones []GetIsShareSnapshotZone
    (List) The zone this share snapshot resides in. Nested schema for zone:
    backupPolicyPlans List<GetIsShareSnapshotBackupPolicyPlan>
    (List) If present, the backup policy plan which created this share snapshot. Nested schema for backup_policy_plan:
    capturedAt String
    (String) The date and time the data capture for this share snapshot was completed.If absent, this snapshot's data has not yet been captured.
    createdAt String
    (String) The date and time that the share snapshot was created.
    crn String
    (String) The CRN for this share snapshot.
    fingerprint String
    (String) The fingerprint for this snapshot.
    href String
    (String) The URL for this zone.
    id String
    (String) The unique identifier for this resource group.
    lifecycleState String
    (String) The lifecycle state of this share snapshot.
    minimumSize Double
    (Integer) The minimum size of a share created from this snapshot. When a snapshot is created, this will be set to the size of the source_share.
    name String
    (String) The globally unique name for this zone.
    resourceGroups List<GetIsShareSnapshotResourceGroup>
    (List) The resource group for this file share. Nested schema for resource_group:
    resourceType String
    (String) The resource type.
    share String
    shareSnapshot String
    status String
    (String) The status of the share snapshot:- available: The share snapshot is available for use.- failed: The share snapshot is irrecoverably unusable.- pending: The share snapshot is being provisioned and is not yet usable.- unusable: The share snapshot is not currently usable (see status_reasons)The enumerated values for this property mayexpand in the future.
    statusReasons List<GetIsShareSnapshotStatusReason>
    (List) The reasons for the current status (if any). Nested schema for status_reasons:
    tags List<String>
    (List) The user tags associated with this share snapshot.
    userTags List<String>
    zones List<GetIsShareSnapshotZone>
    (List) The zone this share snapshot resides in. Nested schema for zone:
    backupPolicyPlans GetIsShareSnapshotBackupPolicyPlan[]
    (List) If present, the backup policy plan which created this share snapshot. Nested schema for backup_policy_plan:
    capturedAt string
    (String) The date and time the data capture for this share snapshot was completed.If absent, this snapshot's data has not yet been captured.
    createdAt string
    (String) The date and time that the share snapshot was created.
    crn string
    (String) The CRN for this share snapshot.
    fingerprint string
    (String) The fingerprint for this snapshot.
    href string
    (String) The URL for this zone.
    id string
    (String) The unique identifier for this resource group.
    lifecycleState string
    (String) The lifecycle state of this share snapshot.
    minimumSize number
    (Integer) The minimum size of a share created from this snapshot. When a snapshot is created, this will be set to the size of the source_share.
    name string
    (String) The globally unique name for this zone.
    resourceGroups GetIsShareSnapshotResourceGroup[]
    (List) The resource group for this file share. Nested schema for resource_group:
    resourceType string
    (String) The resource type.
    share string
    shareSnapshot string
    status string
    (String) The status of the share snapshot:- available: The share snapshot is available for use.- failed: The share snapshot is irrecoverably unusable.- pending: The share snapshot is being provisioned and is not yet usable.- unusable: The share snapshot is not currently usable (see status_reasons)The enumerated values for this property mayexpand in the future.
    statusReasons GetIsShareSnapshotStatusReason[]
    (List) The reasons for the current status (if any). Nested schema for status_reasons:
    tags string[]
    (List) The user tags associated with this share snapshot.
    userTags string[]
    zones GetIsShareSnapshotZone[]
    (List) The zone this share snapshot resides in. Nested schema for zone:
    backup_policy_plans Sequence[GetIsShareSnapshotBackupPolicyPlan]
    (List) If present, the backup policy plan which created this share snapshot. Nested schema for backup_policy_plan:
    captured_at str
    (String) The date and time the data capture for this share snapshot was completed.If absent, this snapshot's data has not yet been captured.
    created_at str
    (String) The date and time that the share snapshot was created.
    crn str
    (String) The CRN for this share snapshot.
    fingerprint str
    (String) The fingerprint for this snapshot.
    href str
    (String) The URL for this zone.
    id str
    (String) The unique identifier for this resource group.
    lifecycle_state str
    (String) The lifecycle state of this share snapshot.
    minimum_size float
    (Integer) The minimum size of a share created from this snapshot. When a snapshot is created, this will be set to the size of the source_share.
    name str
    (String) The globally unique name for this zone.
    resource_groups Sequence[GetIsShareSnapshotResourceGroup]
    (List) The resource group for this file share. Nested schema for resource_group:
    resource_type str
    (String) The resource type.
    share str
    share_snapshot str
    status str
    (String) The status of the share snapshot:- available: The share snapshot is available for use.- failed: The share snapshot is irrecoverably unusable.- pending: The share snapshot is being provisioned and is not yet usable.- unusable: The share snapshot is not currently usable (see status_reasons)The enumerated values for this property mayexpand in the future.
    status_reasons Sequence[GetIsShareSnapshotStatusReason]
    (List) The reasons for the current status (if any). Nested schema for status_reasons:
    tags Sequence[str]
    (List) The user tags associated with this share snapshot.
    user_tags Sequence[str]
    zones Sequence[GetIsShareSnapshotZone]
    (List) The zone this share snapshot resides in. Nested schema for zone:
    backupPolicyPlans List<Property Map>
    (List) If present, the backup policy plan which created this share snapshot. Nested schema for backup_policy_plan:
    capturedAt String
    (String) The date and time the data capture for this share snapshot was completed.If absent, this snapshot's data has not yet been captured.
    createdAt String
    (String) The date and time that the share snapshot was created.
    crn String
    (String) The CRN for this share snapshot.
    fingerprint String
    (String) The fingerprint for this snapshot.
    href String
    (String) The URL for this zone.
    id String
    (String) The unique identifier for this resource group.
    lifecycleState String
    (String) The lifecycle state of this share snapshot.
    minimumSize Number
    (Integer) The minimum size of a share created from this snapshot. When a snapshot is created, this will be set to the size of the source_share.
    name String
    (String) The globally unique name for this zone.
    resourceGroups List<Property Map>
    (List) The resource group for this file share. Nested schema for resource_group:
    resourceType String
    (String) The resource type.
    share String
    shareSnapshot String
    status String
    (String) The status of the share snapshot:- available: The share snapshot is available for use.- failed: The share snapshot is irrecoverably unusable.- pending: The share snapshot is being provisioned and is not yet usable.- unusable: The share snapshot is not currently usable (see status_reasons)The enumerated values for this property mayexpand in the future.
    statusReasons List<Property Map>
    (List) The reasons for the current status (if any). Nested schema for status_reasons:
    tags List<String>
    (List) The user tags associated with this share snapshot.
    userTags List<String>
    zones List<Property Map>
    (List) The zone this share snapshot resides in. Nested schema for zone:

    Supporting Types

    GetIsShareSnapshotBackupPolicyPlan

    Deleteds List<GetIsShareSnapshotBackupPolicyPlanDeleted>
    (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
    Href string
    (String) The URL for this zone.
    Id string
    (String) The unique identifier for this resource group.
    Name string
    (String) The globally unique name for this zone.
    Remotes List<GetIsShareSnapshotBackupPolicyPlanRemote>
    (List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. Nested schema for remote:
    ResourceType string
    (String) The resource type.
    Deleteds []GetIsShareSnapshotBackupPolicyPlanDeleted
    (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
    Href string
    (String) The URL for this zone.
    Id string
    (String) The unique identifier for this resource group.
    Name string
    (String) The globally unique name for this zone.
    Remotes []GetIsShareSnapshotBackupPolicyPlanRemote
    (List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. Nested schema for remote:
    ResourceType string
    (String) The resource type.
    deleteds List<GetIsShareSnapshotBackupPolicyPlanDeleted>
    (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
    href String
    (String) The URL for this zone.
    id String
    (String) The unique identifier for this resource group.
    name String
    (String) The globally unique name for this zone.
    remotes List<GetIsShareSnapshotBackupPolicyPlanRemote>
    (List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. Nested schema for remote:
    resourceType String
    (String) The resource type.
    deleteds GetIsShareSnapshotBackupPolicyPlanDeleted[]
    (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
    href string
    (String) The URL for this zone.
    id string
    (String) The unique identifier for this resource group.
    name string
    (String) The globally unique name for this zone.
    remotes GetIsShareSnapshotBackupPolicyPlanRemote[]
    (List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. Nested schema for remote:
    resourceType string
    (String) The resource type.
    deleteds Sequence[GetIsShareSnapshotBackupPolicyPlanDeleted]
    (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
    href str
    (String) The URL for this zone.
    id str
    (String) The unique identifier for this resource group.
    name str
    (String) The globally unique name for this zone.
    remotes Sequence[GetIsShareSnapshotBackupPolicyPlanRemote]
    (List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. Nested schema for remote:
    resource_type str
    (String) The resource type.
    deleteds List<Property Map>
    (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
    href String
    (String) The URL for this zone.
    id String
    (String) The unique identifier for this resource group.
    name String
    (String) The globally unique name for this zone.
    remotes List<Property Map>
    (List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. Nested schema for remote:
    resourceType String
    (String) The resource type.

    GetIsShareSnapshotBackupPolicyPlanDeleted

    MoreInfo string
    (String) Link to documentation about this status reason.
    MoreInfo string
    (String) Link to documentation about this status reason.
    moreInfo String
    (String) Link to documentation about this status reason.
    moreInfo string
    (String) Link to documentation about this status reason.
    more_info str
    (String) Link to documentation about this status reason.
    moreInfo String
    (String) Link to documentation about this status reason.

    GetIsShareSnapshotBackupPolicyPlanRemote

    Regions List<GetIsShareSnapshotBackupPolicyPlanRemoteRegion>
    (List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. Nested schema for region:
    Regions []GetIsShareSnapshotBackupPolicyPlanRemoteRegion
    (List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. Nested schema for region:
    regions List<GetIsShareSnapshotBackupPolicyPlanRemoteRegion>
    (List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. Nested schema for region:
    regions GetIsShareSnapshotBackupPolicyPlanRemoteRegion[]
    (List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. Nested schema for region:
    regions Sequence[GetIsShareSnapshotBackupPolicyPlanRemoteRegion]
    (List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. Nested schema for region:
    regions List<Property Map>
    (List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. Nested schema for region:

    GetIsShareSnapshotBackupPolicyPlanRemoteRegion

    Href string
    (String) The URL for this zone.
    Name string
    (String) The globally unique name for this zone.
    Href string
    (String) The URL for this zone.
    Name string
    (String) The globally unique name for this zone.
    href String
    (String) The URL for this zone.
    name String
    (String) The globally unique name for this zone.
    href string
    (String) The URL for this zone.
    name string
    (String) The globally unique name for this zone.
    href str
    (String) The URL for this zone.
    name str
    (String) The globally unique name for this zone.
    href String
    (String) The URL for this zone.
    name String
    (String) The globally unique name for this zone.

    GetIsShareSnapshotResourceGroup

    Href string
    (String) The URL for this zone.
    Id string
    (String) The unique identifier for this resource group.
    Name string
    (String) The globally unique name for this zone.
    Href string
    (String) The URL for this zone.
    Id string
    (String) The unique identifier for this resource group.
    Name string
    (String) The globally unique name for this zone.
    href String
    (String) The URL for this zone.
    id String
    (String) The unique identifier for this resource group.
    name String
    (String) The globally unique name for this zone.
    href string
    (String) The URL for this zone.
    id string
    (String) The unique identifier for this resource group.
    name string
    (String) The globally unique name for this zone.
    href str
    (String) The URL for this zone.
    id str
    (String) The unique identifier for this resource group.
    name str
    (String) The globally unique name for this zone.
    href String
    (String) The URL for this zone.
    id String
    (String) The unique identifier for this resource group.
    name String
    (String) The globally unique name for this zone.

    GetIsShareSnapshotStatusReason

    Code string
    (String) A reason code for the status:- encryption_key_deleted: File share snapshot is unusable because its encryption_key was deleted- internal_error: Internal error (contact IBM support)The enumerated values for this property mayexpand in the future.
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (String) Link to documentation about this status reason.
    Code string
    (String) A reason code for the status:- encryption_key_deleted: File share snapshot is unusable because its encryption_key was deleted- internal_error: Internal error (contact IBM support)The enumerated values for this property mayexpand in the future.
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (String) Link to documentation about this status reason.
    code String
    (String) A reason code for the status:- encryption_key_deleted: File share snapshot is unusable because its encryption_key was deleted- internal_error: Internal error (contact IBM support)The enumerated values for this property mayexpand in the future.
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (String) Link to documentation about this status reason.
    code string
    (String) A reason code for the status:- encryption_key_deleted: File share snapshot is unusable because its encryption_key was deleted- internal_error: Internal error (contact IBM support)The enumerated values for this property mayexpand in the future.
    message string
    (String) An explanation of the status reason.
    moreInfo string
    (String) Link to documentation about this status reason.
    code str
    (String) A reason code for the status:- encryption_key_deleted: File share snapshot is unusable because its encryption_key was deleted- internal_error: Internal error (contact IBM support)The enumerated values for this property mayexpand in the future.
    message str
    (String) An explanation of the status reason.
    more_info str
    (String) Link to documentation about this status reason.
    code String
    (String) A reason code for the status:- encryption_key_deleted: File share snapshot is unusable because its encryption_key was deleted- internal_error: Internal error (contact IBM support)The enumerated values for this property mayexpand in the future.
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (String) Link to documentation about this status reason.

    GetIsShareSnapshotZone

    Href string
    (String) The URL for this zone.
    Name string
    (String) The globally unique name for this zone.
    Href string
    (String) The URL for this zone.
    Name string
    (String) The globally unique name for this zone.
    href String
    (String) The URL for this zone.
    name String
    (String) The globally unique name for this zone.
    href string
    (String) The URL for this zone.
    name string
    (String) The globally unique name for this zone.
    href str
    (String) The URL for this zone.
    name str
    (String) The globally unique name for this zone.
    href String
    (String) The URL for this zone.
    name String
    (String) The globally unique name for this zone.

    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
    ibm-cloud/terraform-provider-ibm