Try SpotterGet Azure storage file share info
| "added in version" 1.8.0 of azure.azcollection"
Authors: Andrii Bilorus (@ewscat)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Get facts for storage file share.
---
- name: Get storage share details
azure_rm_storageshare_info:
name: testShare
resource_group: myResourceGroup
account_name: testStorageAccount
- name: Get all storage file shares in storage account
azure_rm_storageshare:
resource_group: myResourceGroup
account_name: testStorageAccount
name:
description:
- Name of the storage file share.
required: false
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
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
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
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
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
access_tier_status:
description:
- Indicates if there is a pending transition for access tier
returned: always
type: str
deleted:
description:
- Indicates whether the share was deleted
returned: always
type: str
deleted_time:
description:
- The deleted time if the share was deleted
returned: always
type: str
enabled_protocols:
description:
- The authentication protocol that is used for the file share.
returned: always
sample: SMB
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
remaining_retention_days:
description:
- Remaining retention days for share that
returned: always
type: str
root_squash:
description:
- The property is for NFS share only. The default is NoRootSquash.
returned: always
sample: NoRootSquash
type: str
share_quota:
description:
- The maximum size of the file share, in gigabytes
returned: always
sample: 102400
type: int
share_usage_bytes:
description:
- The approximate size of the data stored on the share. Note that this value
may not include all recently created or recently resized files.
returned: always
type: int
type:
description:
- The type of the resource
returned: always
sample: Microsoft.Storage/storageAccounts/fileServices/shares
type: str
version:
description:
- The version of the file share
returned: always
type: str
description:
- Facts about the current state of the storage file share
returned: always
type: complex