Spec-Zone.ru › Ansible

azure.azcollection.azure_rm_storageaccountmanagementpolicy module – Управление политиками управления учетными записями хранения

Примечание

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

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

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

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

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

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

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

  • Создание, обновление или удаление политик управления учетными записями хранения.

Требования

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

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

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

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.

resource_group

псевдонимы: resource_group_name

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

Имя используемой группы ресурсов.

rules

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

Правила политик управления учетной записью хранения.

definition

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

Следует ли включить правило.

actions

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

Объект, определяющий набор действий.

base_blob

dictionary

Действие политики управления для базового большого двоичного объекта.

delete

dictionary

Функция удаления большого двоичного объекта.

days_after_last_access_time_greater_than

float

Это свойство можно использовать только совместно с политикой отслеживания времени последнего доступа.

days_after_modification_greater_than

float

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

enable_auto_tier_to_hot_from_cool

boolean

Это свойство включает автоматический перевод большого двоичного объекта с уровня Cool на уровень Hot при обращении к нему.

Варианты:

  • false
  • true

tier_to_archive

dictionary

Функция перевода больших двоичных объектов на архивный уровень хранилища.

Поддерживаются большие двоичные объекты, находящиеся на уровне Hot или Cool.

days_after_last_access_time_greater_than

float

Это свойство можно использовать только совместно с политикой отслеживания времени последнего доступа.

days_after_modification_greater_than

float

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

tier_to_cool

dictionary

Функция перевода больших двоичных объектов на холодный уровень хранилища.

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

days_after_last_access_time_greater_than

float

Это свойство можно использовать только совместно с политикой отслеживания времени последнего доступа.

days_after_modification_greater_than

float

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

snapshot

dictionary

Действие политики управления для моментального снимка.

delete

dictionary

Функция удаления моментального снимка большого двоичного объекта.

days_after_creation_greater_than

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

Значение, указывающее возраст в днях с момента создания.

tier_to_archive

dictionary

Функция перевода моментального снимка большого двоичного объекта на архивный уровень хранилища.

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

days_after_creation_greater_than

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

Значение, указывающее возраст в днях с момента создания.

tier_to_cool

dictionary

Функция перевода моментального снимка большого двоичного объекта на холодный уровень хранилища.

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

days_after_creation_greater_than

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

Значение, указывающее возраст в днях с момента создания.

version

dictionary

Действие политики управления для версии.

delete

dictionary

Функция удаления версии большого двоичного объекта.

days_after_creation_greater_than

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

Значение, указывающее возраст в днях с момента создания.

tier_to_archive

dictionary

Функция перевода версии большого двоичного объекта на архивный уровень хранилища.

Поддерживаются версии больших двоичных объектов, находящиеся на уровне Hot или Cool.

days_after_creation_greater_than

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

Значение, указывающее возраст в днях с момента создания.

tier_to_cool

dictionary

Функция перевода версии большого двоичного объекта на холодный уровень хранилища.

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

days_after_creation_greater_than

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

Значение, указывающее возраст в днях с момента создания.

filters

dictionary

Объект, определяющий набор фильтров.

blob_index_match

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

Массив фильтров на основе тегов индекса больших двоичных объектов; допускается не более 10 фильтров тегов.

name

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

Имя тега фильтра; длина может составлять от 1 до 128 символов.

op

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

Оператор сравнения, используемый для сравнения и фильтрации объектов.

В настоящее время поддерживается только == (оператор равенства).

value

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

Значение тега фильтра, используемое для фильтрации по тегам.

Длина может составлять от 0 до 256 символов.

blob_types

list / элементы=string / обязательный

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

В настоящее время для blockBlob поддерживаются все действия по изменению уровня хранения и удалению. Для appendBlob поддерживаются только действия удаления.

Варианты:

  • "blockBlob"
  • "appendBlob"

prefix_match

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

Массив строк с префиксами для сопоставления.

enabled

boolean

Включать ли правило

Варианты:

  • false
  • true

name

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

Имя правила политики.

Имя правила может содержать любую комбинацию буквенно-цифровых символов.

type

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

Тип правила политики.

Варианты:

  • "Lifecycle"

secret

string

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

state

string

Состояние политики управления учетной записью хранения. Используйте present для добавления или обновления правила политики.

Используйте absent для удаления всех правил политики.

Варианты:

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

storage_account_name

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

Имя учетной записи хранения.

subscription_id

string

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

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 storage account management policy with multi parameters
  azure_rm_storageaccountmanagementpolicy:
    resource_group: testRG
    storage_account_name: testaccount
    rules:
      - name: olcmtest5
        type: Lifecycle
        enabled: false
        definition:
          actions:
            base_blob:
              enable_auto_tier_to_hot_from_cool: true
              delete:
                days_after_modification_greater_than: 33
                days_after_last_access_time_greater_than: 33
              tier_to_cool:
                days_after_modification_greater_than: 33
                days_after_last_access_time_greater_than: 33
              tier_to_archive:
                days_after_modification_greater_than: 33
                days_after_last_access_time_greater_than: 33
            snapshot:
              tier_to_cool:
                days_after_creation_greater_than: 33
              tier_to_archive:
                days_after_creation_greater_than: 33
              delete:
                days_after_creation_greater_than: 33
            version:
              tier_to_archive:
                days_after_creation_greater_than: 33
              tier_to_cool:
                days_after_creation_greater_than: 33
              delete:
                days_after_creation_greater_than: 33
          filters:
            prefix_match:
              - olcmtestcontainer2
            blob_types:
              - blockBlob
              - appendBlob
            blob_index_match:
              - name: tags3
                op: '=='
                value: value3

- name: Delete management policy rules
  azure_rm_storageaccountmanagementpolicy:
    resource_group: "{{ resource_group }}"
    storage_account_name: "st{{ rpfx }}"
    state: absent

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

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

Ключ

Описание

state

complex

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

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

id

string

Идентификатор политики данных.

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.Storage/storageAccounts/sttest/managementPolicies/default"

last_modified_time

string

Возвращает дату и время последнего изменения ManagementPolicies.

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

Пример: "2024-04-12T11:40:10.376465+00:00"

name

string

Имя ресурса.

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

Пример: "DefaultManagementPolicy"

policy

complex

ManagementPolicy учетной записи хранения.

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

rules

list / elements=string

Правила ManagementPolicies учетной записи хранения.

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

Пример: [{"definition": {"actions": {"base_blob": {"delete": {"days_after_last_access_time_greater_than": 33.0, "days_after_modification_greater_than": 33.0}, "enable_auto_tier_to_hot_from_cool": true, "tier_to_archive": {"days_after_last_access_time_greater_than": 33.0, "days_after_modification_greater_than": 33.0}, "tier_to_cool": {"days_after_last_access_time_greater_than": 33.0, "days_after_modification_greater_than": 33.0}}, "snapshot": {"delete": {"days_after_creation_greater_than": 33.0}, "tier_to_archive": {"days_after_creation_greater_than": 33.0}, "tier_to_cool": {"days_after_creation_greater_than": 33.0}}, "version": {"delete": {"days_after_creation_greater_than": 33.0}, "tier_to_archive": {"days_after_creation_greater_than": 33.0}, "tier_to_cool": {"days_after_creation_greater_than": 33.0}}}, "filters": {"blob_index_match": [{"name": "tags3", "op": "==", "value": "value3"}], "blob_types": ["blockBlob", "appendBlob"], "prefix_match": ["olcmtestcontainer2"]}}, "enabled": false, "name": "olcmtest5", "type": "Lifecycle"}]

resource_group

string

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

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

Пример: "testRG"

storage_account_name

string

Имя учетной записи хранения.

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

Пример: "teststname"

type

string

Тип ресурса.

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

Пример: "Microsoft.Storage/storageAccounts/managementPolicies"

Авторы

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

Ссылки коллекции

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

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

Spec-Zone.ru

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