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

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.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 строка	Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.
adfs_authority_url строка добавлено в azure.azcollection 0.0.1	URL-адрес службы авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной службой ADFS.
api_profile строка добавлено в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для публичных облаков; будущие значения позволят использовать с Azure Stack. По умолчанию: `"latest"`
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` могут использоваться для определения идентификатора подписки, если их несколько, иначе используется стандартная подписка az cli. При значении `msi`, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, иначе выбирается первая подписка. `msi` добавлено в Ansible 2.6. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`

actions словарь / обязательно	Объект, определяющий набор действий.
base_blob словарь	Действие политики управления для базового объекта blob.
delete словарь	Функция удаления объекта blob.
days_after_last_access_time_greater_than вещественное число	Это свойство можно использовать только совместно с политикой отслеживания времени последнего доступа.
days_after_modification_greater_than вещественное число	Значение, указывающее возраст в днях после последнего изменения.
enable_auto_tier_to_hot_from_cool логическое	Это свойство включает автоматическое перемещение объекта blob из уровня Cool на Hot при доступе к нему. Варианты: `false` `true`
tier_to_archive словарь	Функция перемещения объектов blob на архивное хранилище. Поддерживает объекты blob, находящиеся на уровне Hot или Cool.
days_after_last_access_time_greater_than вещественное число	Это свойство можно использовать только совместно с политикой отслеживания времени последнего доступа.
... (rest of the table)

END_OF_DOCUMENT_MARKER

days_after_creation_greater_than float / обязательно	Значение, указывающее возраст в днях после создания.
tier_to_archive словарь	Функция для перемещения версии BLOB в архивное хранилище. Поддерживаются версии BLOB, которые в настоящее время находятся на уровне «Hot» или «Cool».
days_after_creation_greater_than float / обязательно	Значение, указывающее возраст в днях после создания.
tier_to_cool словарь	Функция для перемещения версии BLOB в хранилище «Cool». Поддерживаются версии BLOB, которые в настоящее время находятся на уровне «Hot».
days_after_creation_greater_than float / обязательно	Значение, указывающее возраст в днях после создания.
filters словарь	Объект, определяющий набор фильтров.
blob_index_match список / элементы=словарь	Массив фильтров на основе тегов индексов BLOB, максимальное количество теговых фильтров — 10.
name строка / обязательно	Имя тега фильтра, может содержать от 1 до 128 символов.
op строка / обязательно	Оператор сравнения, используемый для сравнения и фильтрации объектов. В настоящее время поддерживается только `==` (оператор равенства).
value строка / обязательно	Поле значения тега фильтра, используемое для фильтрации на основе тегов. Может содержать от 0 до 256 символов.
blob_types список / элементы=строка / обязательно	Массив предопределенных значений перечисления. В настоящее время для blockBlob поддерживаются все действия по перемещению и удалению. Для `appendBlob` поддерживаются только действия по удалению. Варианты: `"blockBlob"` `"appendBlob"`
prefix_match список / элементы=строка	Массив строк для сопоставления префиксов.
enabled логический	Включить правило Варианты: `false` `true`
name строка / обязательно	Имя правила политики. Имя правила может содержать любую комбинацию буквенно-цифровых символов.
type строка / обязательно	Тип правила политики. Варианты: `"Lifecycle"`
secret строка	Секретный ключ Azure. Используется при аутентификации с помощью Служебного принципа.
state строка	Состояние политики управляемого хранилища. Используйте `present` для добавления или обновления правила политики. Используйте `absent` для удаления всех правил политики. Варианты: `"absent"` `"present"` ← (по умолчанию)
storage_account_name строка / обязательно	Имя учетной записи хранилища.
subscription_id строка	Ваш идентификатор подписки Azure.
tenant строка	Идентификатор Azure-аренды. Используется при аутентификации с помощью Служебного принципа.

END_OF_DOCUMENT_MARKER

Отпечаток_ключа строка добавлено в azure.azcollection 1.14.0	Отпечаток частного ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью службы Принципала. Обязательно, если определен x509_certificate_path.
x509_certificate_path путь добавлено в 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: 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

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

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

Ключ	Описание
состояние сложное	Правила политики управления данными, связанные с указанной учетной записью хранилища. Возвращается: всегда
id строка	Идентификатор политики управления данными. Возвращается: всегда Пример: `"/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.Storage/storageAccounts/sttest/managementPolicies/default"`
время_последнего_изменения строка	Возвращает дату и время последнего изменения политики управления. Возвращается: всегда Пример: `"2024-04-12T11:40:10.376465+00:00"`
имя строка	Имя ресурса. Возвращается: всегда Пример: `"DefaultManagementPolicy"`
политика сложное	Политика управления учетной записью хранилища. Возвращается: всегда
правила список / элементы=строка	Правила политики управления учетной записью хранилища. Возвращается: всегда Пример: [{"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"}]
группа_ресурсов строка	Имя группы ресурсов. Возвращается: всегда Пример: `"testRG"`
имя_учетной_записи_хранилища строка	Имя учетной записи хранилища. Возвращается: всегда Пример: `"teststname"`
тип строка	Тип ресурса. Возвращается: всегда Пример: `"Microsoft.Storage/storageAccounts/managementPolicies"`

Авторы

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