Модуль azure.azcollection.azure_rm_privatelinkservice — управляемый ресурс службы Private Link

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

Если поле каноническое, все теги, отсутствующие в параметре 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"

auto_approval

dictionary

Список автоматического утверждения службы Private Link.

subscriptions

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

Список подписок.

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

enable_proxy_protocol

boolean

Определяет, включен ли протокол proxy для службы Private Link.

Варианты:

• false
• true

fqdns

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

Список FQDN.

ip_configurations

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

Массив конфигураций IP-адресов службы Private Link.

name

string

Имя конфигурации IP-адреса службы Private Link.

properties

dictionary

Свойство конфигураций IP-адресов службы Private Link.

primary

boolean

Определяет, является ли конфигурация IP-адреса основной.

Варианты:

• false
• true

private_ip_address_version

string

Определяет, использует ли конкретная конфигурация IP-адреса IPv4 или IPv6.

Варианты:

• "IPv4"
• "IPv6"

private_ip_allocation_method

string

Метод выделения частного IP-адреса.

Варианты:

• "Static"
• "Dynamic"

subnet

dictionary

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

id

string

Идентификатор подсети.

load_balancer_frontend_ip_configurations

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

Массив ссылок на конфигурации IP-адресов балансировщика нагрузки

Для службы Private Link нельзя задать более одной конфигурации IP-адреса интерфейса балансировщика нагрузки.

id

string

Идентификатор IP-адреса интерфейса балансировщика нагрузки.

location

string

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

log_mode

string

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

log_path

string

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

name

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

Имя службы Private Link.

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

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

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

secret

string

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

state

string

Задаёт требуемое состояние службы Private Link.

Используйте state=present для создания или обновления службы Private Link и state=absent для её удаления.

Варианты:

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

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.

visibility

dictionary

Список видимости службы Private Link.

subscriptions

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

Список подписок.

x509_certificate_path

path

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

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

Закрытый ключ должен быть добавлен в конец сертификата.

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

link_service

complex

Список сведений о службе Private Link.

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

alias

string

Псевдоним службы Private Link.

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

Пример: "linkservice.6a244dd8-8416-40cf-8c04-52b353bdd507.eastus.azure.privatelinkservice"

auto_approval

dictionary

Список автоматического утверждения службы Private Link.

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

Пример: {"subscriptions": ["xxxx-xxxx", "yyyy-yyyyy"]}

enable_proxy_protocol

boolean

Включен ли для службы Private Link протокол прокси.

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

Пример: false

etag

string

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

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

Пример: "f7d60f37-ea2b-4091-8546-1327f35468c4"

fqdns

list / elements=string

Список полных доменных имен (FQDN).

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

Пример: ["fqdns1.com", "fqdns2.com"]

id

string

Идентификатор ресурса службы Private Link.

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

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

ip_configurations

complex

Массив конфигураций IP-адресов службы Private Link.

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

name

string

Имя конфигурации IP-адреса

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

Пример: "subnetfredprivate-1"

properties

complex

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

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

primary

boolean

Является ли конфигурация IP-адреса основной.

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

Пример: true

private_ip_address_version

string

Использует ли данная конфигурация IP-адреса IPv4 или IPv6.

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

Пример: "IPv4"

private_ip_allocation_method

string

Метод выделения частного IP-адреса.

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

Пример: "Dynamic"

subnet

dictionary

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

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

Пример: {"id": "/subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnamee"}

load_balancer_frontend_ip_configurations

list / elements=string

Массив ссылок на конфигурации IP-адресов балансировщика нагрузки.

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

Пример: [{"id": "/subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/loadBalancers/testlb/frontendIPConfigurations/front01"}]

location

string

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

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

Пример: "eastus"

name

string

Имя службы Private Link.

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

Пример: "linkservice"

network_interfaces

list / elements=string

Массив ссылок на сетевые интерфейсы, созданные для этой службы Private Link.

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

Пример: [{"id": "/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/testlinkservice.nic.f5"}]

private_endpoint_connections

complex

Массив сведений о подключениях к частной конечной точке.

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

id

string

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

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

Пример: "/subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/privateLinkServices/linkservice/privateEndpointConnections/tes"

private_endpoint

string

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

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

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

provisioning_state

string

Состояние подготовки ресурса службы Private Link.

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

Пример: "Succeeded"

tags

dictionary

Теги ресурса.

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

Пример: {"key1": "value1"}

type

string

Тип ресурса.

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

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

visibility

dictionary

Список видимости службы Private Link.

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

Пример: {"subscriptions": ["xxxx-xxxx", "yyyy-yyyyy"]}