azure / azure.azcollection / 2.3.0 / module / azure_rm_storageshare Manage Azure storage file share | "added in version" 1.8.0 of azure.azcollection" Authors: Andrii Bilorus (@ewscat)azure.azcollection.azure_rm_storageshare (2.3.0) — module
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections: - name: azure.azcollection version: 2.3.0
Create, update or delete a storage file share in existing storage account.
--- - 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
name: description: - Name of the storage file share to delete or create. required: true type: str quota: description: - 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 type: int state: choices: - absent - present default: present description: - State of the storage file share. Use 'present' to create or update a storage file share and use 'absent' to delete a file share. type: str secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str profile: description: - Security profile found in ~/.azure/credentials file. type: str log_mode: description: - Parent argument. type: str log_path: description: - Parent argument. type: str metadata: description: - A name-value pair to associate with the container as metadata. type: dict password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str client_id: description: - Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). - Can also be set via the C(AZURE_CLIENT_ID) environment variable. type: str thumbprint: description: - The thumbprint of the private key specified in I(x509_certificate_path). - Use when authenticating with a Service Principal. - Required if I(x509_certificate_path) is defined. type: str version_added: 1.14.0 version_added_collection: azure.azcollection access_tier: choices: - TransactionOptimized - Hot - Cool - Premium description: - The access tier determines the price and in some cases also the performance of a file share. TransactionOptimized if not set. type: str api_profile: default: latest description: - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. type: str version_added: 0.0.1 version_added_collection: azure.azcollection auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6. type: str version_added: 0.0.1 version_added_collection: azure.azcollection root_squash: choices: - NoRootSquash - RootSquash - AllSquash description: - The property is for NFS share only. - The default is C(NoRootSquash). type: str account_name: description: - Name of the parent storage account for the storage file share. required: true type: str resource_group: description: - Name of the resource group to use. required: true type: str subscription_id: description: - Your Azure subscription Id. type: str cloud_environment: default: AzureCloud description: - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection enabled_protocols: choices: - SMB - NFS description: - The authentication protocol that is used for the file share. - Can only be specified when creating a share. type: str adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection cert_validation_mode: choices: - ignore - validate description: - 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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection x509_certificate_path: description: - 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. type: path version_added: 1.14.0 version_added_collection: azure.azcollection disable_instance_discovery: default: false description: - 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 C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable. type: bool version_added: 2.3.0 version_added_collection: azure.azcollection
state: contains: access_tier: description: - Access tier for specific file share returned: always sample: TransactionOptimized type: str access_tier_change_time: description: - Indicates the last modification time for file share access tier returned: always sample: '2021-08-23T08:17:35+00:00' type: str etag: description: - Resource Etag returned: always sample: '0x8D75E4BA3E275F1' type: str id: description: - 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 type: str last_modified_time: description: - Returns the date and time the file share was last modified returned: always sample: '2021-08-23T08:17:35+00:00' type: str metadata: description: - A name-value pair to associate with the file share as metadata returned: always sample: '{"key1": "value1"}' type: dict name: description: - Name of the file share returned: always sample: myshare type: str share_quota: description: - The maximum size of the file share, in gigabytes returned: always sample: 102400 type: int type: description: - The type of the resource returned: always sample: Microsoft.Storage/storageAccounts/fileServices/shares type: str description: - Facts about the current state of the storage file file share. returned: always type: complex