Try SpotterManage Azure Property instance.
| "added in version" 2.9 of azure.rm"
Authors: Zim Kalinowski (@zikalino)
preview | supported by community
Install with ansible-galaxy collection install azure.rm:==0.0.6
collections:
- name: azure.rm
version: 0.0.6Create, update and delete instance of Azure Property.
- name: ApiManagementCreateProperty
azure.rm.apimanagementproperty:
resource_group: myResourceGroup
service_name: myService
prop_id: myProperty
secret: true
display_name: prop3name
value: propValue
- name: ApiManagementUpdateProperty
azure.rm.apimanagementproperty:
resource_group: myResourceGroup
service_name: myService
prop_id: myProperty
secret: true
- name: ApiManagementDeleteProperty
azure.rm.apimanagementproperty:
resource_group: myResourceGroup
service_name: myService
prop_id: myProperty
state: absent
tags:
description:
- Dictionary of string:string pairs to assign as metadata to the object.
- Metadata tags on the object will be updated with any provided values.
- To remove tags set append_tags option to false.
- Currently, Azure DNS zones and Traffic Manager services also don't allow the use
of spaces in the tag.
- Azure Front Door doesn't support the use of
- Azure Automation and Azure CDN only support 15 tags on resources.
type: dict
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the Property.
- Use C(present) to create or update an Property and C(absent) to delete it.
value:
description:
- Value of the property. Can contain policy expressions. It may not be empty or consist
only of whitespace.
required: true
type: strs
secret:
description:
- Determines whether the value is a secret and should be encrypted or not. Default
value is false.
type: bool
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
prop_id:
description:
- Identifier of the property.
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
append_tags:
default: true
description:
- Use to control if tags field is canonical or just appends to existing tags.
- When canonical, any tags not found in the tags parameter will be removed from the
object's metadata.
type: bool
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
display_name:
description:
- Unique name of Property. It may contain only letters, digits, period, dash, and
underscore characters.
required: true
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
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:
display_name:
description:
- Unique name of Property. It may contain only letters, digits, period, dash,
and underscore characters.
returned: always
sample: null
type: str
secret:
description:
- Determines whether the value is a secret and should be encrypted or not. Default
value is false.
returned: always
sample: null
type: bool
tags:
description:
- Optional tags that when provided can be used to filter the property list.
returned: always
sample: null
type: list
value:
description:
- Value of the property. Can contain policy expressions. It may not be empty
or consist only of whitespace.
returned: always
sample: null
type: str
description:
- Property entity contract properties.
returned: always
sample: null
type: dict
type:
description:
- Resource type for API Management resource.
returned: always
sample: null
type: str