azure.azcollection.azure_rm_storageshare module – Manage Azure storage file share

Note

This module is part of the azure.azcollection collection (version 3.1.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: azure.azcollection.azure_rm_storageshare.

New in azure.azcollection 1.8.0

Synopsis 

Create, update or delete a storage file share in existing storage account.

Requirements 

The below requirements are needed on the host that executes this module.

python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters 

Parameter	Comments
access_tier string	The access tier determines the price and in some cases also the performance of a file share. TransactionOptimized if not set. Choices: `"TransactionOptimized"` `"Hot"` `"Cool"` `"Premium"`
account_name string / required	Name of the parent storage account for the storage file share.
ad_user string	Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in azure.azcollection 0.0.1	Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in azure.azcollection 0.0.1	Selects an API profile to use when communicating with Azure services. Default value of `latest` is appropriate for public clouds; future values will allow use with Azure Stack. Default: `"latest"`
auth_source string added in azure.azcollection 0.0.1	Controls the source of the credentials to use for authentication. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. When set to `auto` (the default) the precedence is module parameters -> `env` -> `credential_file` -> `cli`. When set to `env`, the credentials will be read from the environment variables When set to `credential_file`, it will read the profile from `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the Azure CLI profile. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. When set to `msi`, the host machine must be an azure resource with an enabled MSI extension. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. The `msi` was added in Ansible 2.6. Choices: `"auto"` ← (default) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string added in azure.azcollection 0.0.1	Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing `ignore`. Can also be set via credential file profile or the `AZURE_CERT_VALIDATION` environment variable. Choices: `"ignore"` `"validate"`
client_id string	Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the `AZURE_CLIENT_ID` environment variable.
cloud_environment string added in azure.azcollection 0.0.1	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, `AzureChinaCloud`, `AzureUSGovernment`), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the `AZURE_CLOUD_ENVIRONMENT` environment variable. Default: `"AzureCloud"`
disable_instance_discovery boolean added in azure.azcollection 2.3.0	Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to True, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. Set via credential file profile or the `AZURE_DISABLE_INSTANCE_DISCOVERY` environment variable. Choices: `false` ← (default) `true`
enabled_protocols string	The authentication protocol that is used for the file share. Can only be specified when creating a share. Choices: `"SMB"` `"NFS"`
log_mode string	Parent argument.
log_path string	Parent argument.
metadata dictionary	A name-value pair to associate with the container as metadata.
name string / required	Name of the storage file share to delete or create.
password string	Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile string	Security profile found in ~/.azure/credentials file.
quota integer	The maximum size of the file share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For large file shares, the maximum size is 102400. By default 102400
resource_group string / required	Name of the resource group to use.
root_squash string	The property is for NFS share only. The default is `NoRootSquash`. Choices: `"NoRootSquash"` `"RootSquash"` `"AllSquash"`
secret string	Azure client secret. Use when authenticating with a Service Principal.
state string	State of the storage file share. Use ‘present’ to create or update a storage file share and use ‘absent’ to delete a file share. Choices: `"absent"` `"present"` ← (default)
subscription_id string	Your Azure subscription Id.
tenant string	Azure tenant ID. Use when authenticating with a Service Principal.
thumbprint string added in azure.azcollection 1.14.0	The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined.
x509_certificate_path path added in azure.azcollection 1.14.0	Path to the X509 certificate used to create the service principal in PEM format. The certificate must be appended to the private key. Use when authenticating with a Service Principal.

Notes 

Note

For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.
Authentication is also possible using a service principal or Active Directory user.
To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

Examples 

---
- name: Create storage share
  azure_rm_storageshare:
    name: testShare
    resource_group: myResourceGroup
    account_name: testStorageAccount
    state: present
    access_tier: Cool
    quota: 2048
    metadata:
      key1: value1
      key2: value2

- name: Create share with enalbed protocols
  azure_rm_storageshare:
    name: "{{ share_name }}"
    resource_group: "{{ resource_group }}"
    account_name: "{{ storage_account }}"
    access_tier: "{{ access_tier }}"
    root_squash: RootSquash
    enabled_protocols: NFS

- name: Delete storage share
  azure_rm_storageshare:
    name: testShare
    resource_group: myResourceGroup
    account_name: testStorageAccount
    state: absent

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
state complex	Facts about the current state of the storage file file share. Returned: always
access_tier string	Access tier for specific file share Returned: always Sample: `"TransactionOptimized"`
access_tier_change_time string	Indicates the last modification time for file share access tier Returned: always Sample: `"2021-08-23T08:17:35+00:00"`
etag string	Resource Etag Returned: always Sample: `"0x8D75E4BA3E275F1"`
id string	Resource ID of the storage file share Returned: always Sample: `"/subscriptions/9e700857-1631-4d8a-aed5-908520ede375/resourceGroups/myResourceGroup/providers/Microsoft.Storage/ storageAccounts/mystorageaccount/fileServices/default/shares/myshare"`
last_modified_time string	Returns the date and time the file share was last modified Returned: always Sample: `"2021-08-23T08:17:35+00:00"`
metadata dictionary	A name-value pair to associate with the file share as metadata Returned: always Sample: `{"key1": "value1"}`
name string	Name of the file share Returned: always Sample: `"myshare"`
share_quota integer	The maximum size of the file share, in gigabytes Returned: always Sample: `102400`
type string	The type of the resource Returned: always Sample: `"Microsoft.Storage/storageAccounts/fileServices/shares"`

Authors

Andrii Bilorus (@ewscat)

azure.azcollection.azure_rm_storageshare module – Manage Azure storage file share

Synopsis

Requirements

Parameters

Notes

See Also

Examples

Return Values