azure.azcollection.azure_rm_sqlserver 模块 – 管理 SQL Server 实例

注意

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

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

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要进一步的要求才能使用此模块，有关详细信息，请参阅要求。

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

azure.azcollection 0.1.2 中的新增功能

概要 

创建、更新和删除 SQL Server 实例。

要求 

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

python >= 2.7
执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合
必须通过 pip 在执行来自 azure.azcollection 的模块的主机上安装 collection 的 requirements.txt 中列出的所有 python 包
完整的安装说明可以在 https://galaxy.ansible.com/azure/azcollection 中找到

参数 

参数	注释
ad_user 字符串	Active Directory 用户名。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
adfs_authority_url 字符串在 azure.azcollection 0.0.1 中添加	Azure AD 授权 URL。当使用用户名/密码进行身份验证，并且有自己的 ADFS 授权时使用。
admin_password 字符串	服务器 SQL 管理员帐户的密码（创建服务器时必需）。
admin_username 字符串	服务器 SQL 管理员帐户的用户名。创建后无法更改。
administrators 字典在 azure.azcollection 1.11.0 中添加	服务器的 Azure Active Directory 标识。
administrator_type 字符串	Azure AD 管理员的类型。默认值： `"ActiveDirectory"`
azure_ad_only_authentication 布尔值	仅启用 Azure AD 身份验证。选择 `false` `true`
login 字符串	Azure AD 管理员的登录名。
principal_type 字符串	Azure AD 管理员的主体类型。选择 `"User"` `"Group"` `"Application"`
sid 字符串	Azure AD 管理员的 SID（对象 ID）。
tenant_id 字符串	Azure AD 管理员的租户 ID。
api_profile 字符串在 azure.azcollection 0.0.1 中添加	选择与 Azure 服务通信时使用的 API 配置文件。默认值 `latest` 适用于公共云；未来的值将允许与 Azure Stack 一起使用。默认值： `"latest"`
append_tags 布尔值	用于控制 tags 字段是规范的还是仅附加到现有标签。当为规范时，在 tags 参数中找不到的任何标签都将从对象的元数据中删除。选择 `false` `true` ←（默认）
auth_source 字符串在 azure.azcollection 0.0.1 中添加	控制用于身份验证的凭据的来源。也可以通过 `ANSIBLE_AZURE_AUTH_SOURCE` 环境变量设置。当设置为 `auto`（默认值）时，优先级为：模块参数 -> `env` -> `credential_file` -> `cli`。当设置为 `env` 时，凭据将从环境变量中读取当设置为 `credential_file` 时，它将从 `~/.azure/credentials` 中读取配置文件。当设置为 `cli` 时，凭据将从 Azure CLI 配置文件中获取。如果存在多个订阅 ID，则可以使用 `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"`
change_admin_password 布尔值在 azure.azcollection 1.11.0 中添加	是否应更新现有服务器的 admin_password。如果为 `true`，则只会更新密码值。选择 `false` ← (默认) `true`
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`
identity 任意	指定与 SqlServer 一起使用的托管标识。如果为字符串，则托管标识类型基于名称。可能的值包括 `SystemAssigned` 和 `None`。如果为带有键 type、user_assigned_identities 的字典 type 的可能值包括 `SystemAssigned, C(UserAssigned`、`SystemAssigned, UserAssigned` 和 `None`。 user_assigned_identities 的可能值包括带有 id 和 append 的字典。 id 的可能值是用户分配标识 ID 的列表 append 的可能值是一个布尔值，True 表示追加标识，False 表示用新的 id 覆盖。字符串格式已弃用，将来应使用新的字典格式。
location 字符串	资源位置。
log_mode 字符串	父参数。
log_path 字符串	父参数。
minimal_tls_version 字符串在 azure.azcollection 1.11.0 中添加	要求客户端使用指定的 TLS 版本。选择 `"1.0"` `"1.1"` `"1.2"`
name 字符串 / 必需	服务器的名称。
password 字符串	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
primary_user_assigned_identity_id 字符串在 azure.azcollection 2.7.0 中添加	指定要使用的主要用户分配标识。如果要使用 UserAssigned 类型的托管标识，则这是必需的
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
public_network_access 字符串在 azure.azcollection 1.11.0 中添加	是否允许服务器的公共终结点访问。选择 `"启用"` `"禁用"`
resource_group 字符串 / 必需	包含资源的资源组的名称。您可以从 Azure 资源管理器 API 或门户获取此值。
restrict_outbound_network_access 字符串在 azure.azcollection 1.11.0 中添加	是否限制此服务器的出站网络访问。选择 `"启用"` `"禁用"`
secret 字符串	Azure 客户端密钥。当使用服务主体进行身份验证时使用。
state 字符串	SQL Server 的状态。使用 `present` 创建或更新服务器，使用 `absent` 删除服务器。选择 `"absent"` `"present"` ← (默认)
subscription_id 字符串	您的 Azure 订阅 ID。
tags 字典	要作为元数据分配给对象的字符串:字符串对的字典。对象上的元数据标记将使用任何提供的值进行更新。要删除标记，请将 append_tags 选项设置为 false。目前，Azure DNS 区域和流量管理器服务也不允许在标记中使用空格。 Azure Front Door 不支持使用 Azure Automation 和 Azure CDN 仅支持资源上的 15 个标记。
tenant 字符串	Azure 租户 ID。当使用服务主体进行身份验证时使用。
thumbprint 字符串在 azure.azcollection 1.14.0 中添加	在 x509_certificate_path 中指定的私钥的指纹。当使用服务主体进行身份验证时使用。如果定义了 x509_certificate_path，则这是必需的。
version 字符串	服务器的版本。例如 `12.0`。
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 中。这是一个 ini 文件，包含一个 [default] 部分和以下键：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅 

另请参阅

使用 Azure CLI 登录: 如何使用 az login 命令进行身份验证。

示例 

- name: Create (or update) SQL Server
  azure_rm_sqlserver:
    resource_group: myResourceGroup
    name: server_name
    location: westus
    admin_username: mylogin
    admin_password: "{{ password }}"

- name: Change SQL Server admin password
  azure_rm_sqlserver:
    resource_group: myResourceGroup
    name: server_name
    location: westus
    admin_password: "{{ password }}"
    change_admin_password: true

- name: Create SQL Server with Azure Active Directory admin
  azure_rm_sqlserver:
    resource_group: myResourceGroup
    name: server_name
    location: westus
    admin_username: mylogin
    admin_password: "{{ password }}"
    administrators:
      principal_type: Group
      login: MySqlAdminGroup
      sid: "{{ MySqlAdminGroup.object_id }}"
      tenant_id: "{{ my_tenant_id }}"
      azure_ad_only_authentication: false

返回值 

常见的返回值记录在这里，以下是此模块独有的字段

键	描述
fully_qualified_domain_name 字符串	服务器的完全限定域名。已返回：始终示例： `"sqlcrudtest-4645.database.windows.net"`
id 字符串	资源 ID。已返回：始终示例： `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/sqlcrudtest-4645"`
state 字符串	服务器的状态。已返回：始终示例： `"state"`
version 字符串	服务器的版本。已返回：始终示例： `"12.0"`

作者

Zim Kalinowski (@zikalino)