azure.azcollection.azure_rm_storageshare 模块 – 管理 Azure 存储文件共享

注意

此模块是 azure.azcollection 集合 (版本 3.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定：azure.azcollection.azure_rm_storageshare。

azure.azcollection 1.8.0 中的新增功能

概要

• 在现有存储帐户中创建、更新或删除存储文件共享。

要求

执行此模块的主机需要以下要求。

• python >= 2.7

• 执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合

• 集合的 requirements.txt 中列出的所有 python 包都必须通过 pip 安装在执行 azure.azcollection 中模块的主机上

• 完整的安装说明可在 https://galaxy.ansible.com/azure/azcollection 找到

参数

参数	注释
access_tier 字符串	访问层决定文件共享的价格，在某些情况下也决定其性能。如果未设置，则为 TransactionOptimized。 选项 "TransactionOptimized" "Hot" "Cool" "Premium"
account_name 字符串 / 必需	存储文件共享的父存储帐户的名称。
ad_user 字符串	Active Directory 用户名。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。
adfs_authority_url 字符串 azure.azcollection 0.0.1 中添加	Azure AD 授权 URL。在使用用户名/密码进行身份验证并且拥有自己的 ADFS 授权时使用。
api_profile 字符串 azure.azcollection 0.0.1 中添加	选择与 Azure 服务通信时要使用的 API 配置文件。对于公有云，latest 的默认值是合适的；未来的值将允许与 Azure Stack 一起使用。 默认值： "latest"
auth_source 字符串 azure.azcollection 0.0.1 中添加	控制用于身份验证的凭据来源。 也可以通过 ANSIBLE_AZURE_AUTH_SOURCE 环境变量设置。 当设置为 auto（默认值）时，优先级为模块参数 -> env -> credential_file -> cli。 当设置为 env 时，凭据将从环境变量中读取。 当设置为 credential_file 时，它将从 ~/.azure/credentials 读取配置文件。 当设置为 cli 时，凭据将来自 Azure CLI 配置文件。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于标识订阅 ID（如果存在多个），否则使用默认的 az cli 订阅。 当设置为 msi 时，主机必须是启用了 MSI 扩展的 Azure 资源。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于标识订阅 ID（如果资源被授予对多个订阅的访问权限），否则选择第一个订阅。 msi 是在 Ansible 2.6 中添加的。 选项 "auto" ← (默认) "cli" "credential_file" "env" "msi"
cert_validation_mode 字符串 azure.azcollection 0.0.1 中添加	控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但在使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 ignore 来禁用此行为。也可以通过凭据文件配置文件或 AZURE_CERT_VALIDATION 环境变量设置。 选项 "ignore" "validate"
client_id 字符串	Azure 客户端 ID。在使用服务主体或托管身份 (msi) 进行身份验证时使用。 也可以通过 AZURE_CLIENT_ID 环境变量设置。
cloud_environment 字符串 azure.azcollection 0.0.1 中添加	对于美国公有云以外的云环境，环境名称（由 Azure Python SDK 定义，例如 AzureChinaCloud、AzureUSGovernment）或元数据发现端点 URL（Azure Stack 需要）。也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量设置。 默认值： "AzureCloud"
disable_instance_discovery 布尔值 azure.azcollection 2.3.0 中添加	确定在尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能旨在用于无法访问元数据端点的场景，例如私有云或 Azure Stack。实例发现过程需要从 https://login.microsoft.com/ 检索权限元数据以验证权限。将其设置为 **True** 将禁用权限的验证。因此，必须确保配置的权限主机有效且值得信赖。 通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。 选项 false ← (默认) true
enabled_protocols 字符串	文件共享使用的身份验证协议。 仅在创建共享时才能指定。 选项 "SMB" "NFS"
log_mode 字符串	父参数。
log_path 字符串	父参数。
metadata 字典	与容器关联为元数据的键值对。
name 字符串 / 必需	要删除或创建的存储文件共享的名称。
password 字符串	Active Directory 用户密码。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
quota 整数	文件共享的最大大小（以千兆字节为单位）。必须大于 0，且小于或等于 5TB (5120)。对于大型文件共享，最大大小为 102400。默认值为 102400
resource_group 字符串 / 必需	要使用的资源组的名称。
root_squash 字符串	此属性仅适用于 NFS 共享。 默认为 NoRootSquash。 选项 "NoRootSquash" "RootSquash" "AllSquash"
secret 字符串	Azure 客户端密钥。在使用服务主体进行身份验证时使用。
state 字符串	存储文件共享的状态。使用“present”创建或更新存储文件共享，使用“absent”删除文件共享。 选项 "absent" "present" ← (默认)
subscription_id 字符串	您的 Azure 订阅 ID。
tenant 字符串	Azure 租户 ID。在使用服务主体进行身份验证时使用。
thumbprint 字符串 在 azure.azcollection 1.14.0 中添加	在 *x509_certificate_path* 中指定的私钥的指纹。 在使用服务主体进行身份验证时使用。 如果定义了 *x509_certificate_path*，则需要此参数。
x509_certificate_path 路径 在 azure.azcollection 1.14.0 中添加	PEM 格式下用于创建服务主体的 X509 证书的路径。 证书必须附加到私钥。 在使用服务主体进行身份验证时使用。

备注

注意

• 对于使用 Azure 进行身份验证，您可以传递参数、设置环境变量、使用存储在 ~/.azure/credentials 中的配置文件，或者在运行任务或剧本之前使用 az login 登录。

• 也可以使用服务主体或 Active Directory 用户进行身份验证。

• 要通过服务主体进行身份验证，请传递 subscription_id、client_id、secret 和 tenant，或设置环境变量 AZURE_SUBSCRIPTION_ID、AZURE_CLIENT_ID、AZURE_SECRET 和 AZURE_TENANT。

• 要通过 Active Directory 用户进行身份验证，请传递 ad_user 和 password，或在环境中设置 AZURE_AD_USER 和 AZURE_PASSWORD。

• 或者，凭据可以存储在 ~/.azure/credentials 中。这是一个包含 [default] 部分和以下键的 ini 文件：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

如何使用 az login 命令进行身份验证。

示例

---
- 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

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段

键	描述
state 复杂	关于存储文件共享当前状态的事实。 返回：始终
access_tier 字符串	特定文件共享的访问层 返回：始终 示例： "TransactionOptimized"
access_tier_change_time 字符串	指示文件共享访问层的最后修改时间 返回：始终 示例： "2021-08-23T08:17:35+00:00"
etag 字符串	资源 Etag 返回：始终 示例： "0x8D75E4BA3E275F1"
id 字符串	存储文件共享的资源 ID 返回：始终 示例： "/subscriptions/9e700857-1631-4d8a-aed5-908520ede375/resourceGroups/myResourceGroup/providers/Microsoft.Storage/ storageAccounts/mystorageaccount/fileServices/default/shares/myshare"
last_modified_time 字符串	返回文件共享上次修改的日期和时间 返回：始终 示例： "2021-08-23T08:17:35+00:00"
metadata 字典	与文件共享关联为元数据的键值对 返回：始终 示例： {"key1": "value1"}
name 字符串	文件共享的名称 返回：始终 示例： "myshare"
share_quota 整数	文件共享的最大大小（以千兆字节为单位） 返回：始终 示例： 102400
type 字符串	资源的类型 返回：始终 示例： "Microsoft.Storage/storageAccounts/fileServices/shares"

作者

• Andrii Bilorus (@ewscat)

集合链接

• 问题追踪器
• 主页
• 代码库（源代码）