Модуль azure.azcollection.azure_rm_privateendpoint — управление частной конечной точкой Azure

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"

append_tags

boolean

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

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

Варианты:

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

application_security_groups

list / elements=dictionary

Группа безопасности приложений в группе ресурсов.

id

string

Идентификатор группы безопасности приложений.

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"

custom_dns_configs

list / elements=dictionary

Массив пользовательских конфигураций DNS.

fqdn

string

FQDN, разрешающийся в IP-адрес частной конечной точки.

ip_addresses

list / elements=string

Список частных IP-адресов частной конечной точки.

custom_network_interface_name

string

Пользовательское имя сетевого интерфейса, подключенного к частной конечной точке.

disable_instance_discovery

boolean

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

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

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

Варианты:

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

ip_configurations

list / elements=dictionary

Список конфигураций IP-адресов частной конечной точки.

Используется для сопоставления с конечными точками службы первой стороны.

group_id

string

Идентификатор группы, полученный от удаленного ресурса, к которому должна подключаться эта частная конечная точка.

member_name

string

Имя участника группы, полученное от удаленного ресурса, к которому должна подключаться эта частная конечная точка.

name

string

Имя ресурса, уникальное в пределах группы ресурсов.

private_ip_address

string

Частный IP-адрес, полученный из подсети частной конечной точки.

location

string

Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов.

log_mode

string

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

log_path

string

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

manual_private_link_service_connections

list / elements=dictionary

Набор сведений о подключении к удаленному ресурсу.

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

group_ids

list / elements=string

Идентификатор или идентификаторы группы или групп, полученные от удаленного ресурса, к которому должна подключаться эта частная конечная точка.

name

string

Имя ресурса, уникальное в пределах группы ресурсов.

private_link_service_id

string

Идентификатор ресурса частной конечной точки, к которой требуется подключиться.

name

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, а не субъекта-службы.

private_link_service_connections

list / elements=dictionary

Набор сведений о подключении к удаленному ресурсу.

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

group_ids

list / elements=string

Идентификатор или идентификаторы группы или групп, полученные от удаленного ресурса, к которому должна подключаться эта частная конечная точка.

name

string

Имя ресурса, уникальное в пределах группы ресурсов.

private_link_service_id

string

Идентификатор ресурса частной конечной точки, к которой требуется подключиться.

profile

string

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

resource_group

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

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

secret

string

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

state

string

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

Варианты:

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

subnet

dictionary

Идентификатор подсети, из которой будет выделен частный IP-адрес.

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

id

string

Идентификатор подсети, из которой будет выделен частный IP-адрес.

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, используемому для создания субъекта-службы.

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

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

state

complex

Список словарей частных конечных точек в том же формате, что и параметр модуля azure.azcollection.azure_rm_privateendpoint.

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

application_security_groups

complex

Группа безопасности приложений в группе ресурсов.

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

id

string

Идентификатор группы безопасности приложений.

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

Пример: "/subscriptions/xxx/resourceGroups/testRG/providers/Microsoft.Network/applicationSecurityGroups/app01"

custom_dns_configs

complex

Массив пользовательских конфигураций DNS.

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

fqdn

string

FQDN, разрешающийся в IP-адрес частной конечной точки.

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

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

ip_addresses

complex

Список частных IP-адресов частной конечной точки.

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

Пример: ["10.1.0.9"]

custom_network_interface_name

string

Пользовательское имя сетевого интерфейса, подключённого к частной конечной точке.

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

Пример: "nic01"

etag

string

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

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

Пример: "W/\"20803842-7d51-46b2-a790-ded8971b4d8a"

id

string

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

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

Пример: "/subscriptions/xxx-xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/testprivateendpoint"

ip_configurations

complex

Список конфигураций IP-адресов частной конечной точки.

Используется для сопоставления с конечными точками службы First Party.

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

group_id

string

Идентификатор группы, полученный от удалённого ресурса, к которому должна подключаться эта частная конечная точка.

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

Пример: "postgresqlServer"

member_name

string

Имя участника группы, полученное от удалённого ресурса, к которому должна подключаться эта частная конечная точка.

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

Пример: "postgresqlServer"

name

string

Имя ресурса, уникальное в пределах группы ресурсов.

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

Пример: "ipc01"

private_ip_address

string

Частный IP-адрес, полученный из подсети частной конечной точки.

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

Пример: "10.1.0.9"

location

string

Допустимое расположение Azure.

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

Пример: "eastus"

manual_private_link_service_connections

list / elements=string

Идентификатор ресурса частной конечной точки, к которой нужно подключиться.

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

Пример: ["/subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/point/privateLinkServiceConnections/point02"]

name

string

Имя частной конечной точки.

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

Пример: "estprivateendpoint"

network_interfaces

list / elements=string

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

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

Пример: ["/subscriptions/xxx-xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/fredprivateendpoint002.nic"]

private_link_service_connections

list / elements=string

Идентификатор ресурса частной конечной точки, к которой нужно подключиться.

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

Пример: ["/subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/point/privateLinkServiceConnections/point"]

provisioning_state

string

Состояние подготовки ресурса.

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

Пример: "Succeeded"

subnets_id

string

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

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

Пример: "/subscriptions/xxx-xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/fredtestRG-vnet/subnets/default"

tags

dictionary

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

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

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

type

string

Тип ресурса.

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

Пример: "Microsoft.Network/privateEndpoints"