Share

Manages a File Share within Azure Storage.

Create a Share Resource

new Share(name: string, args: ShareArgs, opts?: CustomResourceOptions);

def Share(resource_name, opts=None, acls=None, metadata=None, name=None, quota=None, storage_account_name=None, __props__=None);

func NewShare(ctx *Context, name string, args ShareArgs, opts ...ResourceOption) (*Share, error)

public Share(string name, ShareArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ShareArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ShareArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ShareArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Share Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Share resource accepts the following input properties:

StorageAccountName string: Specifies the storage account in which to create the share. Changing this forces a new resource to be created.
Acls List<ShareAclArgs>: One or more acl blocks as defined below.
Metadata Dictionary<string, string>: A mapping of MetaData for this File Share.
Name string: The name of the share. Must be unique within the storage account where the share is located.
Quota int: The maximum size of the share, in gigabytes. For Standard storage accounts, this must be greater than 0 and less than 5120 GB (5 TB). For Premium FileStorage storage accounts, this must be greater than 100 GB and less than 102400 GB (100 TB). Default is 5120.

StorageAccountName string: Specifies the storage account in which to create the share. Changing this forces a new resource to be created.
Acls []ShareAcl: One or more acl blocks as defined below.
Metadata map[string]string: A mapping of MetaData for this File Share.
Name string: The name of the share. Must be unique within the storage account where the share is located.
Quota int: The maximum size of the share, in gigabytes. For Standard storage accounts, this must be greater than 0 and less than 5120 GB (5 TB). For Premium FileStorage storage accounts, this must be greater than 100 GB and less than 102400 GB (100 TB). Default is 5120.

storageAccountName string: Specifies the storage account in which to create the share. Changing this forces a new resource to be created.
acls ShareAcl[]: One or more acl blocks as defined below.
metadata {[key: string]: string}: A mapping of MetaData for this File Share.
name string: The name of the share. Must be unique within the storage account where the share is located.
quota number: The maximum size of the share, in gigabytes. For Standard storage accounts, this must be greater than 0 and less than 5120 GB (5 TB). For Premium FileStorage storage accounts, this must be greater than 100 GB and less than 102400 GB (100 TB). Default is 5120.

storage_account_name str: Specifies the storage account in which to create the share. Changing this forces a new resource to be created.
acls List[ShareAcl]: One or more acl blocks as defined below.
metadata Dict[str, str]: A mapping of MetaData for this File Share.
name str: The name of the share. Must be unique within the storage account where the share is located.
quota float: The maximum size of the share, in gigabytes. For Standard storage accounts, this must be greater than 0 and less than 5120 GB (5 TB). For Premium FileStorage storage accounts, this must be greater than 100 GB and less than 102400 GB (100 TB). Default is 5120.

Outputs

All input properties are implicitly available as output properties. Additionally, the Share resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
ResourceManagerId string: The Resource Manager ID of this File Share.
Url string: The URL of the File Share

Id string: The provider-assigned unique ID for this managed resource.
ResourceManagerId string: The Resource Manager ID of this File Share.
Url string: The URL of the File Share

id string: The provider-assigned unique ID for this managed resource.
resourceManagerId string: The Resource Manager ID of this File Share.
url string: The URL of the File Share

id str: The provider-assigned unique ID for this managed resource.
resource_manager_id str: The Resource Manager ID of this File Share.
url str: The URL of the File Share

Look up an Existing Share Resource

Get an existing Share resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ShareState, opts?: CustomResourceOptions): Share

static get(resource_name, id, opts=None, acls=None, metadata=None, name=None, quota=None, resource_manager_id=None, storage_account_name=None, url=None, __props__=None);

func GetShare(ctx *Context, name string, id IDInput, state *ShareState, opts ...ResourceOption) (*Share, error)

public static Share Get(string name, Input<string> id, ShareState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Acls List<ShareAclArgs>: One or more acl blocks as defined below.
Metadata Dictionary<string, string>: A mapping of MetaData for this File Share.
Name string: The name of the share. Must be unique within the storage account where the share is located.
Quota int: The maximum size of the share, in gigabytes. For Standard storage accounts, this must be greater than 0 and less than 5120 GB (5 TB). For Premium FileStorage storage accounts, this must be greater than 100 GB and less than 102400 GB (100 TB). Default is 5120.
ResourceManagerId string: The Resource Manager ID of this File Share.
StorageAccountName string: Specifies the storage account in which to create the share. Changing this forces a new resource to be created.
Url string: The URL of the File Share

Acls []ShareAcl: One or more acl blocks as defined below.
Metadata map[string]string: A mapping of MetaData for this File Share.
Name string: The name of the share. Must be unique within the storage account where the share is located.
Quota int: The maximum size of the share, in gigabytes. For Standard storage accounts, this must be greater than 0 and less than 5120 GB (5 TB). For Premium FileStorage storage accounts, this must be greater than 100 GB and less than 102400 GB (100 TB). Default is 5120.
ResourceManagerId string: The Resource Manager ID of this File Share.
StorageAccountName string: Specifies the storage account in which to create the share. Changing this forces a new resource to be created.
Url string: The URL of the File Share

acls ShareAcl[]: One or more acl blocks as defined below.
metadata {[key: string]: string}: A mapping of MetaData for this File Share.
name string: The name of the share. Must be unique within the storage account where the share is located.
quota number: The maximum size of the share, in gigabytes. For Standard storage accounts, this must be greater than 0 and less than 5120 GB (5 TB). For Premium FileStorage storage accounts, this must be greater than 100 GB and less than 102400 GB (100 TB). Default is 5120.
resourceManagerId string: The Resource Manager ID of this File Share.
storageAccountName string: Specifies the storage account in which to create the share. Changing this forces a new resource to be created.
url string: The URL of the File Share

acls List[ShareAcl]: One or more acl blocks as defined below.
metadata Dict[str, str]: A mapping of MetaData for this File Share.
name str: The name of the share. Must be unique within the storage account where the share is located.
quota float: The maximum size of the share, in gigabytes. For Standard storage accounts, this must be greater than 0 and less than 5120 GB (5 TB). For Premium FileStorage storage accounts, this must be greater than 100 GB and less than 102400 GB (100 TB). Default is 5120.
resource_manager_id str: The Resource Manager ID of this File Share.
storage_account_name str: Specifies the storage account in which to create the share. Changing this forces a new resource to be created.
url str: The URL of the File Share

Supporting Types

ShareAcl

See the input and output API doc for this type.

Id string: The ID which should be used for this Shared Identifier.
AccessPolicies List<ShareAclAccessPolicyArgs>: An access_policy block as defined below.

Id string: The ID which should be used for this Shared Identifier.
AccessPolicies []ShareAclAccessPolicy: An access_policy block as defined below.

id string: The ID which should be used for this Shared Identifier.
accessPolicies ShareAclAccessPolicy[]: An access_policy block as defined below.

id str: The ID which should be used for this Shared Identifier.
access_policies List[ShareAclAccessPolicy]: An access_policy block as defined below.

ShareAclAccessPolicy

See the input and output API doc for this type.

Expiry string: The time at which this Access Policy should be valid until, in ISO8601 format.
Permissions string: The permissions which should be associated with this Shared Identifier. Possible value is combination of d (delete), l (list), r (read) and w (write).
Start string: The time at which this Access Policy should be valid from, in ISO8601 format.

Expiry string: The time at which this Access Policy should be valid until, in ISO8601 format.
Permissions string: The permissions which should be associated with this Shared Identifier. Possible value is combination of d (delete), l (list), r (read) and w (write).
Start string: The time at which this Access Policy should be valid from, in ISO8601 format.

expiry string: The time at which this Access Policy should be valid until, in ISO8601 format.
permissions string: The permissions which should be associated with this Shared Identifier. Possible value is combination of d (delete), l (list), r (read) and w (write).
start string: The time at which this Access Policy should be valid from, in ISO8601 format.

expiry str: The time at which this Access Policy should be valid until, in ISO8601 format.
permissions str: The permissions which should be associated with this Shared Identifier. Possible value is combination of d (delete), l (list), r (read) and w (write).
start str: The time at which this Access Policy should be valid from, in ISO8601 format.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud