azure / azure.rm / 0.0.6 / module / apimanagementidentityprovider Manage Azure IdentityProvider instance. | "added in version" 2.9 of azure.rm" Authors: Zim Kalinowski (@zikalino) preview | supported by communityazure.rm.apimanagementidentityprovider (0.0.6) — module
Install with ansible-galaxy collection install azure.rm:==0.0.6
collections: - name: azure.rm version: 0.0.6
Create, update and delete instance of Azure IdentityProvider.
- name: ApiManagementCreateIdentityProvider azure.rm.apimanagementidentityprovider: resource_group: myResourceGroup service_name: myService name: microsoft client_id: facebookid client_secret: facebookapplicationsecret
- name: ApiManagementUpdateIdentityProvider azure.rm.apimanagementidentityprovider: resource_group: myResourceGroup service_name: myService name: microsoft client_id: updatedfacebookid client_secret: updatedfacebooksecret
- name: ApiManagementDeleteIdentityProvider azure.rm.apimanagementidentityprovider: resource_group: myResourceGroup service_name: myService name: microsoft state: absent
id: description: - Resource ID. type: str name: description: - Resource name. type: str type: description: - Resource type for API Management resource. type: str state: choices: - absent - present default: present description: - Assert the state of the IdentityProvider. - Use C(present) to create or update an IdentityProvider and C(absent) to delete it. secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str profile: description: - Security profile found in ~/.azure/credentials file. type: str log_mode: description: - Parent argument. type: str log_path: description: - Parent argument. type: str password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str authority: description: - OpenID Connect discovery endpoint hostname for AAD or AAD B2C. type: str client_id: description: - Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. required: true type: str api_profile: default: latest description: - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. type: str version_added: 0.0.1 version_added_collection: azure.azcollection auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. - When set to C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. - The C(msi) was added in Ansible 2.6. type: str version_added: 0.0.1 version_added_collection: azure.azcollection service_name: description: - The name of the API Management service. required: true type: str client_secret: description: - Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. required: true type: str resource_group: description: - The name of the resource group. required: true type: str allowed_tenants: description: - List of Allowed Tenants when configuring Azure Active Directory login. type: list subscription_id: description: - Your Azure subscription Id. type: str cloud_environment: default: AzureCloud description: - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection signin_policy_name: description: - Signin Policy Name. Only applies to AAD B2C Identity Provider. type: str signup_policy_name: description: - Signup Policy Name. Only applies to AAD B2C Identity Provider. type: str cert_validation_mode: choices: - ignore - validate description: - Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection password_reset_policy_name: description: - Password Reset Policy Name. Only applies to AAD B2C Identity Provider. type: str profile_editing_policy_name: description: - Profile Editing Policy Name. Only applies to AAD B2C Identity Provider. type: str
id: description: - Resource ID. returned: always sample: null type: str name: description: - Resource name. returned: always sample: null type: str properties: contains: allowed_tenants: description: - List of Allowed Tenants when configuring Azure Active Directory login. returned: always sample: null type: str authority: description: - OpenID Connect discovery endpoint hostname for AAD or AAD B2C. returned: always sample: null type: str client_id: description: - Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. returned: always sample: null type: str client_secret: description: - Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. returned: always sample: null type: str password_reset_policy_name: description: - Password Reset Policy Name. Only applies to AAD B2C Identity Provider. returned: always sample: null type: str profile_editing_policy_name: description: - Profile Editing Policy Name. Only applies to AAD B2C Identity Provider. returned: always sample: null type: str signin_policy_name: description: - Signin Policy Name. Only applies to AAD B2C Identity Provider. returned: always sample: null type: str signup_policy_name: description: - Signup Policy Name. Only applies to AAD B2C Identity Provider. returned: always sample: null type: str type: description: - Identity Provider Type identifier. returned: always sample: null type: str description: - Identity Provider contract properties. returned: always sample: null type: dict type: description: - Resource type for API Management resource. returned: always sample: null type: str