Note

Ce plugin fait partie de la collection azure.azcollection (version 1.4.0).

Pour l'installer, utilisez : ansible-galaxy collection install azure.azcollection.

Pour l'utiliser dans un playbook, spécifiez : azure.azcollection.azure_rm_appgateway.

Nouveau dans la version 0.1.2 : de azure.azcollection

  • Synopsis
  • Exigences
  • Paramètres
  • Notes
  • Voir aussi
  • Exemples
  • Valeurs de retour

Synopsis

  • Crée, met à jour et supprime l'instance de la passerelle d'application.

Exigences

Les exigences ci-dessous sont nécessaires sur l'hôte qui exécute ce module.

  • python >= 2.7
  • azure >= 2.0.0

Paramètres

Paramètre Choix/Par défaut Commentaires
ad_userchaîne de caractères Nom d'utilisateur Active Directory. A utiliser lors de l'authentification avec un utilisateur Active Directory plutôt qu'avec un principal de service.
adfs_authority_urlchaîne de caractères ajouté dans la version 0.0.1 de azure.azcollection Url de l'autorité Azure AD. A utiliser lors de l'authentification avec nom d'utilisateur/mot de passe, et a votre propre autorité ADFS.
api_profilechaîne de caractères ajouté dans la version 0.0.1 de azure.azcollection Par défaut :
"dernier"
Sélectionne un profil d'API à utiliser lors de la communication avec les services Azure. Valeur par défaut de latest est appropriée pour les clouds publics ; les valeurs futures permettront une utilisation avec Azure Stack.
append_tagsbooléen
    Choix :

  • pas de
  • oui
Utiliser pour contrôler si le champ tags est canonique ou s'ajoute simplement aux tags existants.Lorsqu'il est canonique, tous les tags non trouvés dans le paramètre tags seront supprimés des métadonnées de l'objet.
auth_sourcechaîne de caractères ajouté dans la version 0.0.1 de azure.azcollection
    Choix :

  • auto
  • cli
  • fichier d'identification
  • env
  • msi
Contrôle la source des informations d'identification à utiliser pour l'authentification.Peut également être défini via le paramètre ANSIBLE_AZURE_AUTH_SOURCE Lorsqu'elle est définie sur auto (la valeur par défaut), la priorité est accordée aux paramètres du module ->... env -> credential_file -> cliLorsqu'il est réglé sur env, les informations d'identification seront lues à partir des variables d'environnement.Lorsqu'il est défini sur credential_file, le profil sera lu à partir de ~/.azure/credentials.Lorsqu'il est défini sur cli, les informations d'identification seront des sources du profil Azure CLI. subscription_id ou la variable d'environnement AZURE_SUBSCRIPTION_ID peut être utilisée pour identifier l'ID de l'abonnement si plus d'un est présent sinon l'abonnement az cli par défaut est utilisé.Lorsqu'elle est définie sur msi, la machine hôte doit être une ressource azure avec une extension MSI activée. subscription_id ou la variable d'environnement AZURE_SUBSCRIPTION_ID peut être utilisée pour identifier l'ID de l'abonnement si la ressource a accès à plus d'un abonnement, sinon le premier abonnement est choisi.L'option msi a été ajouté dans Ansible 2.6.
certificats d'authentificationchaîne de caractères Certificats d'authentification de la ressource de la passerelle d'application.
donnéeschaîne de caractères Données publiques du certificat - pfx codé en base64.
nomchaîne de caractères Nom de la ressource qui est unique au sein d'un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
backend_address_poolschaîne de caractères Liste des pools d'adresses backend de la ressource de la passerelle d'application.
adresses_d'arrière-planchaîne de caractères Liste des adresses de backend.
fqdnchaîne de caractères Nom de domaine entièrement qualifié (FQDN).
adresse_ipchaîne de caractères Adresse IP.
nomchaîne de caractères Ressource qui est unique au sein d'un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
backend_http_settings_collectionchaîne de caractères Paramètres http backend de la ressource de la passerelle d'application.
nom_cookie_affinitéchaîne de caractères Nom du cookie à utiliser pour le cookie d'affinité.
certificats d'authentificationchaîne de caractères Liste de références aux certificats d'authentification de la passerelle d'application.Applicable uniquement lorsque cookie_based_affinity est activé, sinon ignorée discrètement.
idchaîne de caractères ID de la ressource.
affinité_basée_sur_cookiechaîne de caractères
    Choix :

  • activé
  • désactivé
Affinité basée sur les cookies.
nom_hôtechaîne de caractères En-tête d'hôte à envoyer aux serveurs backend.
nomchaîne de caractères Nom de la ressource qui est unique au sein d'un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
chemin d'accèschaîne de caractères Chemin d'accès qui doit être utilisé comme préfixe pour tous les éléments du système. http Null signifie qu'aucun chemin ne sera préfixé. La valeur par défaut est null.
pick_host_name_from_backend_addresschaîne de caractères Si l'en-tête host doit être choisi à partir du nom d'hôte du serveur backend. La valeur par défaut est false.
portchaîne de caractères Le port de destination sur le backend.
sondechaîne de caractères Ressource de sonde d'une passerelle d'application.
protocolechaîne de caractères
    Choix :

  • http
  • https
Le protocole utilisé pour communiquer avec le backend.
request_timeoutchaîne de caractères Délai d'attente de la demande en secondes.Application Gateway échouera la demande si la réponse n'est pas reçue dans RequestTimeout.Les valeurs acceptables sont de 1 seconde à 86400 secondes.
cert_validation_modechaîne de caractères ajouté dans la version 0.0.1 de azure.azcollection
    Choix :

  • ignorer
  • valider
Contrôle le comportement de validation du certificat pour les points de terminaison Azure. Par défaut, tous les modules valideront le certificat du serveur, mais lorsqu'un proxy HTTPS est utilisé, ou contre Azure Stack, il peut être nécessaire de désactiver ce comportement en passant le paramètre ignore. Peut également être défini via le profil du fichier d'accréditation ou l'attribut AZURE_CERT_VALIDATION variable d'environnement.
client_idchaîne de caractères ID du client Azure. À utiliser lors de l'authentification avec un principal de service.
cloud_environnementchaîne de caractères ajouté dans la version 0.0.1 de azure.azcollection Par défaut :
"AzureCloud"
Pour les environnements de cloud autres que le cloud public américain, le nom de l'environnement (tel que défini par Azure Python SDK, par ex, AzureChinaCloud, AzureUSGovernment), ou une URL de point de terminaison de découverte de métadonnées (nécessaire pour Azure Stack). Peut également être défini via le profil du fichier d'accréditation ou le profil de l'utilisateur. AZURE_CLOUD_ENVIRONMENT variable d'environnement.
frontend_ip_configurationschaîne de caractères Adresses IP frontales de la ressource de la passerelle d'application.
nomchaîne de caractères Nom de la ressource qui est unique au sein d'un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
adresse_ip_privéechaîne de caractères PrivateIPAddress de l'interface réseau Configuration IP.
private_ip_allocation_methodchaîne de caractères
    Choix :

  • statique
  • dynamique
Méthode d'allocation de PrivateIP.
adresse_ip_publiquechaîne de caractères Référence de la ressource PublicIP.
sous-réseauchaîne de caractères Référence de la ressource de sous-réseau.
front-end_portschaîne de caractères Liste des ports frontaux de la ressource de la passerelle d'application.
nomchaîne de caractères Nom de la ressource qui est unique au sein d'un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
portchaîne de caractères Port du frontal.
passerelle_ip_configurationschaîne de caractères Liste des sous-réseaux utilisés par la passerelle d'application.
nomchaîne de caractères Nom de la ressource qui est unique au sein d'un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
sous-réseauchaîne de caractères Référence de la ressource de sous-réseau. Un sous-réseau d'où la passerelle d'application obtient son adresse privée.
http_listenerschaîne de caractères Liste des listeners HTTP de la ressource de la passerelle d'application.
frontend_ip_configurationchaîne de caractères Ressource de configuration de l'IP frontale d'une passerelle d'application.
frontend_portchaîne de caractères Ressource du port frontal d'une passerelle d'application.
nom_hôtechaîne de caractères Nom d'hôte de http l'auditeur.
nomchaîne de caractères Nom de la ressource qui est unique au sein d'un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
protocolechaîne de caractères
    Choix :

  • http
  • https
Protocole du http l'auditeur.
indication_du_nom_du_serveur requischaîne de caractères Applicable uniquement si protocole est https. Active le SNI pour le multi-hosting.
ssl_certificatchaîne de caractères Ressource de certificat SSL d'une passerelle d'application.
emplacementchaîne de caractères Emplacement de la ressource. S'il n'est pas défini, l'emplacement du groupe de ressources sera utilisé par défaut.
nomchaîne de caractères / obligatoire Le nom de la passerelle d'application.
mot de passechaîne de caractères Mot de passe de l'utilisateur Active Directory. A utiliser lors de l'authentification avec un utilisateur Active Directory plutôt qu'avec un principal de service.
sondeschaîne de caractères Sondes disponibles pour la ressource de la passerelle d'application.
hôtechaîne de caractères Nom de l'hôte pour envoyer le sonde à.
intervallechaîne de caractères L'intervalle de sondage en secondes.Il s'agit de l'intervalle de temps entre deux sondages consécutifs.Les valeurs acceptables vont de 1 seconde à 86400 secondes.
nomchaîne de caractères Nom de la sonde qui est unique au sein d'une passerelle d'application.
chemin d'accèschaîne de caractères Chemin relatif de sonde Le chemin valide commence à '/'. La sonde est envoyée à ://:.
protocolechaîne de caractères
    Choix :

  • http
  • https
Le protocole utilisé pour le sonde.
timeoutchaîne de caractères Le délai d'attente de la sonde en secondes.La sonde est marquée comme échouée si une réponse valide n'est pas reçue avec cette période de délai d'attente.Les valeurs acceptables sont de 1 seconde à 86400 secondes.
seuil_malsainchaîne de caractères Le site sonde retry count.Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold.Acceptable values are from 1 second to 20.
profilchaîne de caractères Profil de sécurité trouvé dans le fichier ~/.azure/credentials.
redirect_configurationschaîne de caractères Configurations de redirection de la ressource de la passerelle d'application.
include_pathchaîne de caractères Chemin d'inclusion dans l'url redirigée.
include_query_stringchaîne de caractères Inclure la chaîne de requête dans l'url redirigée.
nomchaîne de caractères Nom de la ressource qui est unique au sein d'un groupe de ressources.
type_redirectionchaîne de caractères
    Choix :

  • permanent
  • trouvé
  • voir_autre
  • temporaire
Type de redirection.
target_listenerchaîne de caractères Référence à un écouteur vers lequel rediriger la requête.
request_routing_ruleschaîne de caractères Liste des règles de routage des demandes de la ressource de la passerelle d'application.
backend_address_poolchaîne de caractères Ressource du pool d'adresses backend de la passerelle d'application.
backend_http_settingschaîne de caractères Backend http ressource de paramétrage de la passerelle d'application.
http_listenerchaîne de caractères Ressource de l'écouteur http de la passerelle d'application.
nomchaîne de caractères Nom de la ressource qui est unique au sein d'un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
redirect_configurationchaîne de caractères Ressource de configuration de redirection de la passerelle d'application.
règle_typechaîne de caractères
    Choix :

  • de base
  • routage_basé_sur_le_chemin
Type de règle.
groupe_ressourceschaîne de caractères / obligatoire Le nom du groupe de ressources.
secretchaîne de caractères Secret du client Azure. À utiliser lors de l'authentification avec un principal de service.
skuchaîne de caractères SKU de la ressource de la passerelle d'application.
capacitéchaîne de caractères Capacité (nombre d'instances) d'une passerelle d'application.
nomchaîne de caractères
    Choix :

  • standard_small
  • standard_moyen
  • standard_large
  • standard_v2
  • waf_moyen
  • waf_large
  • waf_v2
Nom d'une passerelle d'application SKU.
niveauchaîne de caractères
    Choix :

  • standard
  • standard_v2
  • waf
  • waf_v2
Tier d'une passerelle d'application.
ssl_certificatschaîne de caractères Certificats SSL de la ressource de la passerelle d'application.
donnéeschaîne de caractères Certificat pfx encodé en base-64.Applicable uniquement dans la demande PUT.
nomchaîne de caractères Nom de la ressource qui est unique au sein d'un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
mot de passechaîne de caractères Mot de passe pour le fichier pfx spécifié dans données Applicable uniquement dans la demande PUT.
ssl_policychaîne de caractères Politique SSL de la ressource de la passerelle d'application.
cipher_suiteschaîne de caractères
    Choix :

  • tls_ecdhe_rsa_with_aes_256_gcm_sha384
  • tls_ecdhe_rsa_with_aes_128_gcm_sha256
  • tls_ecdhe_rsa_with_aes_256_cbc_sha384
  • tls_ecdhe_rsa_with_aes_128_cbc_sha256
  • tls_ecdhe_rsa_with_aes_256_cbc_sha
  • tls_ecdhe_rsa_with_aes_128_cbc_sha
  • tls_dhe_rsa_with_aes_256_gcm_sha384
  • tls_dhe_rsa_with_aes_128_gcm_sha256
  • tls_dhe_rsa_with_aes_256_cbc_sha
  • tls_dhe_rsa_with_aes_128_cbc_sha
  • tls_rsa_with_aes_256_gcm_sha384
  • tls_rsa_with_aes_128_gcm_sha256
  • tls_rsa_with_aes_256_cbc_sha256
  • tls_rsa_with_aes_128_cbc_sha256
  • tls_rsa_with_aes_256_cbc_sha
  • tls_rsa_with_aes_128_cbc_sha
  • tls_ecdhe_ecdsa_with_aes_256_gcm_sha384
  • tls_ecdhe_ecdsa_with_aes_128_gcm_sha256
  • tls_ecdhe_ecdsa_with_aes_256_cbc_sha384
  • tls_ecdhe_ecdsa_with_aes_128_cbc_sha256
  • tls_ecdhe_ecdsa_with_aes_256_cbc_sha
  • tls_ecdhe_ecdsa_with_aes_128_cbc_sha
  • tls_dhe_dss_with_aes_256_cbc_sha256
  • tls_dhe_dss_with_aes_128_cbc_sha256
  • tls_dhe_dss_with_aes_256_cbc_sha
  • tls_dhe_dss_with_aes_128_cbc_sha
  • tls_rsa_avec_3des_ede_cbc_sha
  • tls_dhe_dss_with_3des_ede_cbc_sha
Liste des suites de chiffrement SSL à activer dans l'ordre spécifié à la passerelle d'application.
disabled_ssl_protocolschaîne de caractères
    Choix :

  • tls_v1_0
  • tls_v1_1
  • tls_v1_2
Liste des protocoles SSL à désactiver sur la passerelle d'application.
min_protocole_versionchaîne de caractères
    Choix :

  • tls_v1_0
  • tls_v1_1
  • tls_v1_2
Version minimale du protocole Ssl à prendre en charge sur la passerelle d'application.
nom_politiquechaîne de caractères
    Choix :

  • ssl_policy20150501
  • ssl_policy20170401
  • ssl_policy20170401_s
Nom du Ssl predefined politique.
type_politiquechaîne de caractères
    Choix :

  • prédéfini
  • personnalisé
Type de politique SSL.
étatchaîne de caractères
    Choix :

  • absent
  • présent
Affirme l'état de l'IP publique. Utilisez present pour créer ou mettre à jour une et absent pour supprimer.
abonnement_idchaîne de caractères Votre identifiant d'abonnement Azure.
balisesdictionnaire Dictionnaire de paires chaîne:chaîne à affecter comme métadonnées à l'objet.Les balises de métadonnées sur l'objet seront mises à jour avec toutes les valeurs fournies.Pour supprimer les balises, définissez l'option append_tags à false.
locatairechaîne de caractères ID du locataire Azure. À utiliser lors de l'authentification avec un principal de service.

Notes

Note

  • Pour l'authentification avec Azure, vous pouvez passer des paramètres, définir des variables d'environnement, utiliser un profil stocké dans ~/.azure/credentials, ou vous connecter avant d'exécuter vos tâches ou votre playbook avec... az login.
  • L'authentification est également possible en utilisant un principal de service ou un utilisateur Active Directory.
  • Pour s'authentifier via un principal de service, passez le subscription_id, le client_id, le secret et le locataire ou définissez les variables d'environnement AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET et AZURE_TENANT.
  • Pour s'authentifier via un utilisateur Active Directory, passez ad_user et password, ou définissez AZURE_AD_USER et AZURE_PASSWORD dans l'environnement.
  • Alternativement, les informations d'identification peuvent être stockées dans ~/.azure/credentials. Il s'agit d'un fichier ini contenant un [default] et les clés suivantes : subscription_id, client_id, secret et tenant ou subscription_id, ad_user et password. Il est également possible d'ajouter des profils supplémentaires. Spécifiez le profil en passant profil ou en définissant AZURE_PROFILE dans l'environnement.

Voir aussi

Voir aussi

Se connecter avec Azure CLI

Comment s'authentifier en utilisant le az login commande.

Exemples

-name: Create instance of Application Gateway
  azure_rm_appgateway:resource_group: myResourceGroup
    name: myAppGateway
    sku:name: standard_small
      tier: standard
      capacity:2gateway_ip_configurations:-subnet:id:"{{ subnet_id }}"name: app_gateway_ip_config
    frontend_ip_configurations:-subnet:id:"{{ subnet_id }}"name: sample_gateway_frontend_ip_config
    frontend_ports:-port:90name: ag_frontend_port
    backend_address_pools:-backend_addresses:-ip_address: 10.0.0.4
        name: test_backend_address_pool
    backend_http_settings_collection:-port:80protocol: http
        cookie_based_affinity: enabled
        name: sample_appgateway_http_settings
    http_listeners:-frontend_ip_configuration: sample_gateway_frontend_ip_config
        frontend_port: ag_frontend_port
        name: sample_http_listener
    request_routing_rules:-rule_type: Basic
        backend_address_pool: test_backend_address_pool
        backend_http_settings: sample_appgateway_http_settings
        http_listener: sample_http_listener
        name: rule1

Valeurs de retour

Les valeurs de retour courantes sont documentées ici, les champs suivants sont uniques à ce module :

Clé Retourné Description
idchaîne de caractères toujours ID de la ressource.
Echantillon : id

Auteurs

  • Zim Kalinowski (@zikalino)