Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_appconfiguration — управление хранилищами Azure App Configuration.

Примечание

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

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

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

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

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

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

Краткое описание

  • Создание, обновление и удаление хранилищ Azure App Configuration.

Требования

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

  • 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

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

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

api_profile

string

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

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

По умолчанию: "latest"

appconfig_name

string / обязательный

Имя хранилища App Configuration.

append_tags

boolean

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

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

Варианты:

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

auth_source

string

добавлено в 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; в противном случае используется подписка Azure CLI по умолчанию.

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

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

Варианты:

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

cert_validation_mode

string

добавлено в 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

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

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

По умолчанию: "AzureCloud"

disable_instance_discovery

boolean

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

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

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

Варианты:

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

disable_local_auth

boolean

Свойство, указывающее, включена ли для хранилища локальная аутентификация (ключи доступа).

Варианты:

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

enable_purge_protection

boolean

Свойство, указывающее, включена ли для этого хранилища защита от окончательного удаления.

Варианты:

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

identity

dictionary

Конфигурация управляемого удостоверения для хранилища.

type

string / обязательный

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

Варианты:

  • "SystemAssigned"
  • "UserAssigned"
  • "SystemAssigned, UserAssigned"

user_assigned_identity_ids

list / элементы=string

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

is_purge_deleted

boolean

Определяет, следует ли окончательно удалить указанное хранилище, то есть очистить удаленное хранилище Azure App Configuration.

Если указан параметр is_purge_deleted, необходимо настроить location.

Если расположение не задано, будет использоваться расположение группы ресурсов по умолчанию.

Варианты:

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

location

string

Расположение ресурса. Если не задано, по умолчанию используется расположение группы ресурсов.

log_mode

string

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

log_path

string

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

oidc_token

string

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

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации рабочей нагрузки по удостоверению.

Этот токен обменивается с Azure AD с помощью федеративного удостоверения OIDC.

Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

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

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации рабочей нагрузки по удостоверению.

Файл должен содержать только токен в исходном виде.

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

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN_FILE.

password

string

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

profile

string

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

public_network_access

string

Параметр доступа к общедоступной сети для хранилища.

Если параметр не указан при создании, Azure считает его равным Automatic. После установки значения Enabled или Disabled вернуть значение Automatic нельзя; при обновлении не указывайте это свойство, чтобы оставить его без изменений.

Варианты:

  • "Disabled"
  • "Enabled"

replicas

list / элементы=dictionary

Список реплик, которыми нужно управлять для этого хранилища.

location

string / обязательный

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

name

string / обязательный

Имя реплики.

resource_group

string / обязательный

Имя группы ресурсов, которой принадлежит хранилище App Configuration.

secret

string

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

sku

string

Уровень SKU хранилища.

Варианты:

  • "free"
  • "developer"
  • "standard"
  • "premium"

soft_delete_retention_in_days

integer

Свойство, указывающее количество дней хранения удаленного хранилища.

state

string

Задает требуемое состояние хранилища App Configuration. Используйте present для создания или обновления хранилища App Configuration и absent для его удаления.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

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

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

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

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

Обязателен, если задан x509_certificate_path.

x509_certificate_path

path

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

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

Сертификат необходимо добавить после закрытого ключа.

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

Примечания

Примечание

  • Для аутентификации в Azure можно передать параметры, задать переменные среды, использовать профиль из ~/.azure/credentials или войти в систему перед запуском задач или плейбука с помощью az login.
  • Также возможна аутентификация с помощью субъекта-службы или пользователя Active Directory.
  • Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
  • Для аутентификации через субъект-службу передайте 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 a Standard App Configuration store with system-assigned identity
  azure.azcollection.azure_rm_appconfiguration:
    resource_group: myResourceGroup
    appconfig_name: myAppConfigStore
    location: eastus
    sku: standard
    identity:
      type: SystemAssigned
    enable_local_auth: true
    tags:
      env: prod
    state: present

- name: Assign a user-assigned identity and enable purge protection
  azure.azcollection.azure_rm_appconfiguration:
    resource_group: myResourceGroup
    appconfig_name: myAppConfigStore
    identity:
      type: UserAssigned
      user_assigned_identity_ids:
        - /subscriptions/xxxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity
    enable_purge_protection: true
    soft_delete_retention_in_days: 7
    state: present

- name: Delete an App Configuration store
  azure.azcollection.azure_rm_appconfiguration:
    resource_group: myRG
    appconfig_name: my-appconf-legacy
    state: absent

- name: Purge a soft-deleted App Configuration store (subscription-level permission required)
  azure.azcollection.azure_rm_appconfiguration:
    resource_group: myRG
    appconfig_name: my-appconf-legacy
    location: eastus
    is_purge_deleted: true
    state: absent

- name: Create store with two replicas
  azure.azcollection.azure_rm_appconfiguration:
    resource_group: myRG
    appconfig_name: myappconf
    location: eastus
    sku: standard
    replicas:
      - name: r1
        location: westus
      - name: r2
        location: northeurope
    state: present

Возвращаемые значения

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

Ключ

Описание

id

string

Идентификатор ресурса хранилища App Configuration в Azure Resource Manager.

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

Пример: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.AppConfiguration/configurationStores/myAppConfigStore"

Авторы

  • Zun Yang (@zunyangc)

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

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

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

Spec-Zone.ru

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