azure / azure.rm / 0.0.6 / module / apimanagementcache Manage Azure Cache instance. | "added in version" 2.9 of azure.rm" Authors: Zim Kalinowski (@zikalino) preview | supported by communityazure.rm.apimanagementcache (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 Cache.
- name: ApiManagementCreateCache azure.rm.apimanagementcache: resource_group: myResourceGroup service_name: myService cache_id: myCache description: Redis cache instances in West India connection_string: 'contoso5.redis.cache.windows.net,ssl=true,password=...' resource_id: >- /subscriptions/{{ subscription_id }}/resourceGroups/{{ resource_group }}/providers/Microsoft.Cache/Redis/{{ redis_name }}
- name: ApiManagementDeleteCache azure.rm.apimanagementcache: resource_group: myResourceGroup service_name: myService cache_id: myCache state: absent
state: choices: - absent - present default: present description: - Assert the state of the Cache. - Use C(present) to create or update an Cache 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 cache_id: description: - Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier). required: true 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 client_id: description: - Azure client ID. Use when authenticating with a Service Principal. 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 description: description: - Cache description type: str resource_id: description: - Original uri of entity in external system cache points to type: str service_name: description: - The name of the API Management service. required: true type: str resource_group: description: - The name of the resource group. required: true type: str 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 connection_string: description: - Runtime connection string to cache required: true type: str 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 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
id: description: - Resource ID. returned: always sample: null type: str name: description: - Resource name. returned: always sample: null type: str properties: contains: connection_string: description: - Runtime connection string to cache returned: always sample: null type: str description: description: - Cache description returned: always sample: null type: str resource_id: description: - Original uri of entity in external system cache points to returned: always sample: null type: str description: - Cache properties details. returned: always sample: null type: dict type: description: - Resource type for API Management resource. returned: always sample: null type: str