Skip to content

Data Source: azurermStorageShare

Use this data source to access information about an existing File Share.

Example Usage

import * as cdktf from "cdktf";
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const dataAzurermStorageShareExample =
  new azurerm.dataAzurermStorageShare.DataAzurermStorageShare(this, "example", {
    name: "existing",
    storage_account_name: "existing",
  });
new cdktf.TerraformOutput(this, "id", {
  value: dataAzurermStorageShareExample.id,
});

Arguments Reference

The following arguments are supported:

  • name - (Required) The name of the share.

  • storageAccountName - (Required) The name of the storage account.

Attributes Reference

  • id - The ID of the File Share.

  • quota - The quota of the File Share in GB.

  • metadata - A map of custom file share metadata.

  • acl - One or more acl blocks as defined below.

A acl block has the following attributes:

  • id - The ID which should be used for this Shared Identifier.

  • accessPolicy - An accessPolicy block as defined below.

A accessPolicy block has the following attributes:

  • permissions - The permissions which should be associated with this Shared Identifier. Possible value is combination of r (read), w (write), d (delete), and l (list).

  • start - The time at which this Access Policy should be valid from, in ISO8601 format.

  • expiry - The time at which this Access Policy should be valid until, in ISO8601 format.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minutes) Used when retrieving the Storage.