azure.azcollection.azure_rm_sqlserver_info 模块 – 获取 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_info。

azure.azcollection 0.1.2 中的新增功能

概要 

获取 SQL Server 的信息。

要求 

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

python >= 2.7
执行此模块的主机必须通过 galaxy 安装了 azure.azcollection 集合
通过 pip 在执行来自 azure.azcollection 的模块的主机上必须安装集合的 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 授权时使用。
api_profile 字符串在 azure.azcollection 0.0.1 中添加	选择与 Azure 服务通信时使用的 API 配置文件。默认值 `latest` 适用于公共云；未来的值将允许与 Azure Stack 一起使用。默认值： `"latest"`
append_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 配置文件。`subscription_id` 或环境变量 `AZURE_SUBSCRIPTION_ID` 可用于标识订阅 ID（如果存在多个订阅 ID），否则将使用默认的 az cli 订阅。当设置为 `msi` 时，主机必须是启用了 MSI 扩展的 Azure 资源。`subscription_id` 或环境变量 `AZURE_SUBSCRIPTION_ID` 可用于标识订阅 ID（如果资源被授予对多个订阅的访问权限），否则将选择第一个订阅。在 Ansible 2.6 中添加了 `msi`。选择 `"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`
log_mode 字符串	父参数。
log_path 字符串	父参数。
password 字符串	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
resource_group 字符串 / 必需	包含资源的资源组的名称。您可以从 Azure 资源管理器 API 或门户获取此值。
secret 字符串	Azure 客户端密钥。当使用服务主体进行身份验证时使用。
server_name 字符串	服务器的名称。
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，则为必需。
x509_certificate_path 路径在 azure.azcollection 1.14.0 中添加	用于以 PEM 格式创建服务主体的 X509 证书的路径。该证书必须附加到私钥。当使用服务主体进行身份验证时使用。

注释 

注意

要使用 Azure 进行身份验证，您可以传递参数、设置环境变量、使用存储在 ~/.azure/credentials 中的配置文件，或在使用 az login 运行任务或 playbook 之前登录。
也可以使用服务主体或 Active Directory 用户进行身份验证。
要通过服务主体进行身份验证，请传递 subscription_id、client_id、secret 和 tenant 或设置环境变量 AZURE_SUBSCRIPTION_ID、AZURE_CLIENT_ID、AZURE_SECRET 和 AZURE_TENANT。
要通过 Active Directory 用户进行身份验证，请传递 ad_user 和密码，或在环境中设置 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: Get instance of SQL Server
  azure_rm_sqlserver_info:
    resource_group: myResourceGroup
    server_name: server_name

- name: List instances of SQL Server
  azure_rm_sqlserver_info:
    resource_group: myResourceGroup

返回值 

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

键	描述
servers 复杂	字典结果的列表，其中键是 SQL Server 的名称，值是该 SQL Server 的事实。返回: 始终
sqlserver_name 复杂	键是值相关的服务器名称。返回: 成功
admin_username 字符串在 azure.azcollection 1.11.0 中添加	服务器的 SQL 管理员帐户的用户名。返回: 始终示例: `"sqladmin"`
administrators 字典在 azure.azcollection 1.11.0 中添加	服务器的 Azure Active Directory 标识。返回: 始终
administrator_type 字符串	Azure AD 管理员的类型。返回: 成功示例: `"ActiveDirectory"`
azure_ad_only_authentication 布尔值	启用了仅 Azure AD 身份验证。返回: 成功示例: `false`
login 字符串	Azure AD 管理员的登录名。返回: 成功示例: `"MyAzureAdGroup"`
principal_type 字符串	Azure AD 管理员的主体类型。返回: 成功示例: `"Group"`
sid 字符串	Azure AD 管理员的 SID（对象 ID）。返回: 成功示例: `"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"`
tenant_id 字符串	Azure AD 管理员的租户 ID。返回: 成功示例: `"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"`
fully_qualified_domain_name 字符串	服务器的完全限定域名。返回: 始终示例: `"fully_qualified_domain_name"`
id 字符串	资源 ID。返回: 始终示例: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/sqlcrudtest-4645"`
identity 复杂	服务器的标识。返回: 可用时
type 字符串	托管标识的类型返回: 始终示例: `"UserAssigned"`
user_assigned_identities 复杂	用户分配的托管标识及其选项返回: 始终
id 字典	与资源关联的用户分配的标识 ID 的字典返回: 始终
kind 字符串	SQL Server 的种类。这是用于 Azure 门户体验的元数据。返回: 始终示例: `"v12.0"`
location 字符串	资源位置。返回: 始终示例: `"japaneast"`
minimal_tls_version 字符串在 azure.azcollection 1.11.0 中添加	客户端必须连接的 TLS 版本。返回: 始终示例: `"1.2"`
name 字符串	资源名称。返回: 始终示例: `"sqlcrudtest-4645"`
public_network_access 字符串在 azure.azcollection 1.11.0 中添加	是否允许服务器的公共终结点访问。返回: 始终示例: `"Enabled"`
restrict_outbound_network_access 字符串在 azure.azcollection 1.11.0 中添加	是否允许此服务器的出站网络访问。返回: 始终示例: `"Enabled"`
state 字符串	服务器的状态。返回: 始终示例: `"Ready"`
type 字符串	资源类型。返回: 始终示例: `"Microsoft.Sql/servers"`
version 字符串	服务器的版本。返回: 始终示例: `"12.0"`

作者

Zim Kalinowski (@zikalino)