Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_sqlserver_info — Получение фактов о SQL Server

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.

Для использования в плейбуке укажите: azure.azcollection.azure_rm_sqlserver_info.

Добавлена в azure.azcollection 0.1.2

  • Описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Описание

  • Получение фактов о SQL Server.

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.

  • python >= 2.7
  • На хосте, на котором выполняется этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
  • Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
  • Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

ad_user

string

Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности.

adfs_authority_url

string

added in azure.azcollection 0.0.1

URL-адрес центра проверки подлинности Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и имеет собственный центр проверки подлинности ADFS.

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

append_tags

boolean

Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам.

В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.

Choices:

  • false
  • true ← (default)

auth_source

string

added in 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 могут использоваться для идентификации идентификатора подписки, если присутствует более одного, в противном случае используется подписка az cli по умолчанию.

При установке в значение msi, хост-машина должна быть ресурсом Azure с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к более чем одной подписке, в противном случае выбирается первая подписка.

Параметр msi был добавлен в Ansible 2.6.

Choices:

  • "auto" ← (default)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в отношении Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Choices:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi).

Также может быть установлен через переменную среды AZURE_CLIENT_ID.

cloud_environment

string

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных центра проверки подлинности из https://login.microsoft.com/ для проверки центра проверки подлинности. Установив это значение в **True**, проверка центра проверки подлинности отключается. В результате очень важно убедиться, что настроенный узел центра проверки подлинности является действительным и заслуживающим доверия.

Устанавливается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Choices:

  • false ← (default)
  • true

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

password

string

Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности.

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

resource_group

string / required

Имя группы ресурсов, содержащей ресурс. Вы можете получить это значение из API Azure Resource Manager или портала.

secret

string

Секретный ключ клиента Azure. Используется при аутентификации с главным субъектом безопасности.

server_name

string

Имя сервера.

subscription_id

string

Идентификатор вашей подписки Azure.

tags

dictionary

Словарь пар строка:строка, назначаемых в качестве метаданных для объекта.

Метаданные теги объекта будут обновлены всеми предоставленными значениями.

Для удаления тегов установите параметр append_tags в значение false.

В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают использование пробелов в теге.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов.

tenant

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью принципала службы.

thumbprint

string

added in azure.azcollection 1.14.0

Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path.

Используйте при аутентификации с помощью принципала службы.

Требуется, если определен параметр x509_certificate_path.

x509_certificate_path

path

added in azure.azcollection 1.14.0

Путь к сертификату X509, используемому для создания принципала службы в формате PEM.

Сертификат должен быть добавлен к закрытому ключу.

Используйте при аутентификации с помощью принципала службы.

Примечания

Примечание

  • Для аутентификации в Azure вы можете передавать параметры, устанавливать переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или войти в систему перед выполнением задач или playbook с 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: 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-сервера, а значения — данные фактов для этого SQL-сервера.

Возвращается: всегда

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

строка

SID (идентификатор объекта) администратора Azure AD.

Возвращается: успех

Пример: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

tenant_id

строка

Идентификатор клиента Azure AD администратора.

Возвращается: успех

Пример: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

fully_qualified_domain_name

строка

Полное доменное имя сервера.

Возвращается: всегда

Пример: "fully_qualified_domain_name"

id

строка

Идентификатор ресурса.

Возвращается: всегда

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/sqlcrudtest-4645"

identity

сложный

Идентификатор сервера.

Возвращается: при наличии

type

строка

Тип управляемой подписки

Возвращается: всегда

Пример: "UserAssigned"

user_assigned_identities

сложный

Присвоенные пользователям управляемые подписки и их параметры

Возвращается: всегда

id

словарь

Словарь идентификаторов присвоенных пользователям подписок, связанных с ресурсом

Возвращается: всегда

kind

строка

Тип SQL-сервера. Это метаданные, используемые для работы с порталом Azure.

Возвращается: всегда

Пример: "v12.0"

местоположение

строка

Расположение ресурса.

Возвращается: всегда

Пример: "japaneast"

минимальная_версия_tls

строка

добавлено в azure.azcollection 1.11.0

Версия TLS, которую должны использовать клиенты для подключения.

Возвращается: всегда

Пример: "1.2"

имя

строка

Имя ресурса.

Возвращается: всегда

Пример: "sqlcrudtest-4645"

доступ_по_общей_сети

строка

добавлено в azure.azcollection 1.11.0

Разрешен ли доступ к общему ресурсу для сервера.

Возвращается: всегда

Пример: "Enabled"

ограничить_доступ_в_сети

строка

добавлено в azure.azcollection 1.11.0

Разрешен ли выходной доступ в сети для этого сервера.

Возвращается: всегда

Пример: "Enabled"

состояние

строка

Состояние сервера.

Возвращается: всегда

Пример: "Ready"

тип

строка

Тип ресурса.

Возвращается: всегда

Пример: "Microsoft.Sql/servers"

версия

строка

Версия сервера.

Возвращается: всегда

Пример: "12.0"

Авторы

  • Zim Kalinowski (@zikalino)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (исходные коды)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_sqlserver_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API