Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_postgresqlflexibleserver_info – Получение фактов о гибком сервере Azure PostgreSQL

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_rm_postgresqlflexibleserver_info.

Новое в azure.azcollection 2.2.0

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

Описание

  • Получение фактов о гибком сервере PostgreSQL.

Требования

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

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

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.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

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

Варианты:

  • "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.

Варианты:

  • false ← (по умолчанию)
  • true

log_mode

string

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

log_path

string

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

name

string

Имя сервера.

password

string

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

profile

string

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

resource_group

string

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

secret

string

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

subscription_id

string

Ваш идентификатор подписки Azure.

метки

список / элементы=строка

Ограничьте результаты, предоставив список меток. Форматируйте метки как ‘ключ’ или ‘ключ:значение’.

арендатор

строка

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

отпечаток

строка

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

Отпечаток частного ключа, указанного в x509_certificate_path.

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

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

путь_к_сертификату_x509

путь

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

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

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

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

Примечания

Примечание

  • Для аутентификации с 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: Get instance of PostgreSQL Flexible Server
  azure_rm_postgresqlflexibleserver_info:
    resource_group: myResourceGroup
    name: server_name

- name: List instances of PostgreSQL Flexible Server
  azure_rm_postgresqlflexibleserver_info:
    resource_group: myResourceGroup
    tags:
      - key

Значения возврата

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

Ключ

Описание

серверы

сложный

Список словарей, содержащих данные о серверах PostgreSQL Flexible.

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

логин_администратора

строка

Имя пользователя администратора сервера.

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

Пример: "azureuser"

зона_доступности

строка

Информация о зоне доступности сервера.

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

Пример: "1"

резервное_копирование

сложный

Свойства резервного копирования сервера.

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

дни_сохранения_резервных_копий

целое

Дни сохранения резервных копий для сервера.

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

Пример: 7

географически_дублируемое_резервное_копирование

строка

Значение, указывающее, включено ли географически дублируемое резервное копирование на сервере.

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

Пример: "Disabled"

полное_имя_домена

строка

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

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

Пример: "postflexiblefredpgsqlflexible.postgres.database.azure.com"

высокая_доступность

сложный

Свойства высокой доступности сервера.

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

режим

строка

Режим высокой доступности для сервера.

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

Пример: "Disabled"

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

строка

Информация о зоне доступности резервного сервера.

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

идентификатор

строка

Идентификатор ресурса гибкого сервера postgresql.

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

Пример: "/subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/flexibleservers/postgresql3"

идентичность

сложный

Идентичность сервера.

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

тип

строка

Тип управляемой идентичности

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

Пример: "UserAssigned"

пользовательские_присвоенные_идентичности

сложный

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

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

идентификатор

словарь

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

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

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

строка

Расположение, где находится ресурс.

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

Пример: "eastus"

период_технического_обслуживания

сложный

Свойства периода технического обслуживания сервера.

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

пользовательский_период

строка

Указывает, включен ли пользовательский период или выключен.

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

Пример: "Enabled"

day_of_week

integer

День недели для окна обслуживания.

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

Пример: 0

start_hour

integer

Начальный час для окна обслуживания.

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

Пример: 8

start_minute

integer

Начальная минута для окна обслуживания.

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

Пример: 0

name

string

Имя ресурса.

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

Пример: "postgreabdud1223"

network

complex

Свойства сети сервера.

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

delegated_subnet_resource_id

string

ID ресурса делегированной подсети.

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

private_dns_zone_arm_resource_id

string

ID ресурса частной зоны DNS.

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

public_network_access

string

Включен или нет общедоступный доступ к сети.

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

Пример: "Enabled"

point_in_time_utc

string

Время создания точки восстановления (формат ISO8601).

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

resource_group

string

Имя группы ресурсов.

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

Пример: "myResourceGroup"

sku

complex

SKU сервера.

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

name

string

Имя SKU.

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

Пример: "Standard_B1ms"

tier

string

Уровень конкретного SKU.

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

Пример: "Burstable"

source_server_resource_id

string

ID ресурса исходного сервера для восстановления.

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

storage

complex

Максимальный объем хранилища, разрешенный для сервера.

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

storage_size_gb

integer

Максимальный объем хранилища, разрешенный для сервера.

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

Пример: 128

system_data

complex

Системные метаданные, относящиеся к этому ресурсу.

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

created_at

string

Метка времени создания ресурса (UTC).

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

created_by

string

Субъект, создавший ресурс.

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

created_by_type

string

Тип идентификатора, создавшего ресурс.

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

last_modified_at

string

Отметка времени последнего изменения ресурса (UTC).

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

last_modified_by

string

Идентификатор, последний изменивший ресурс.

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

last_modified_by_type

string

Тип идентификатора, последний изменившего ресурс.

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

tags

dictionary

Теги, назначенные ресурсу. Словарь пар строка:строка.

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

Пример: {"tag1": "abc"}

version

string

Версия Flexible Server.

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

Пример: "12"

Авторы

  • xuzhang3 (@xuzhang3)
  • Fred-sun (@Fred-sun)

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

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

© 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_postgresqlflexibleserver_info_module.html

Spec-Zone.ru

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