Try SpotterManage Azure Backend 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 Backend.
tls:
description:
- Backend TLS Properties
suboptions:
validate_certificate_chain:
description:
- Flag indicating whether SSL certificate chain validation should be done when
using self-signed certificates for this backend host.
type: bool
validate_certificate_name:
description:
- Flag indicating whether SSL certificate name validation should be done when
using self-signed certificates for this backend host.
type: bool
type: dict
url:
description:
- Runtime Url of the Backend.
required: true
type: str
proxy:
description:
- Backend Proxy Contract Properties
suboptions:
password:
description:
- Password to connect to the WebProxy Server
type: str
url:
description:
- WebProxy Server AbsoluteUri property which includes the entire URI stored in
the Uri instance, including all fragments and query strings.
required: true
type: str
username:
description:
- Username to connect to the WebProxy server
type: str
type: dict
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the Backend.
- Use C(present) to create or update an Backend and C(absent) to delete it.
title:
description:
- Backend Title.
type: str
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
protocol:
description:
- Backend communication protocol.
required: true
type: str
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal.
type: str
backend_id:
description:
- Identifier of the Backend entity. Must be unique in the current API Management service
instance.
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
credentials:
description:
- Backend Credentials Contract Properties
suboptions:
authorization:
description:
- Authorization header authentication
suboptions:
parameter:
description:
- Authentication Parameter value.
required: true
type: str
scheme:
description:
- Authentication Scheme name.
required: true
type: str
type: dict
certificate:
description:
- List of Client Certificate Thumbprint.
type: list
header:
description:
- Header Parameter description.
type: unknown[DictionaryType {"$id":"1855","$type":"DictionaryType","valueType":{"$id":"1856","$type":"SequenceType","elementType":{"$id":"1857","$type":"PrimaryType","knownPrimaryType":"string","name":{"$id":"1858","fixed":false,"raw":"String"},"deprecated":false},"name":{"$id":"1859","fixed":false},"deprecated":false},"supportsAdditionalProperties":false,"name":{"$id":"1860","fixed":false},"deprecated":false}]
query:
description:
- Query Parameter description.
type: unknown[DictionaryType {"$id":"1845","$type":"DictionaryType","valueType":{"$id":"1846","$type":"SequenceType","elementType":{"$id":"1847","$type":"PrimaryType","knownPrimaryType":"string","name":{"$id":"1848","fixed":false,"raw":"String"},"deprecated":false},"name":{"$id":"1849","fixed":false},"deprecated":false},"supportsAdditionalProperties":false,"name":{"$id":"1850","fixed":false},"deprecated":false}]
type: dict
description:
description:
- Backend Description.
type: str
resource_id:
description:
- Management Uri of the Resource in External System. This url can be the Arm Resource
Id of Logic Apps, Function Apps or Api Apps.
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
service_fabric_cluster:
description:
- Backend Service Fabric Cluster Properties
suboptions:
client_certificatethumbprint:
description:
- The client certificate thumbprint for the management endpoint.
required: true
type: str
management_endpoints:
description:
- The cluster management endpoint.
required: true
type: list
max_partition_resolution_retries:
description:
- Maximum number of retries while attempting resolve the partition.
type: str
server_certificate_thumbprints:
description:
- Thumbprints of certificates cluster management service uses for tls communication
type: list
server_x509names:
description:
- Server X509 Certificate Names Collection
suboptions:
issuer_certificate_thumbprint:
description:
- Thumbprint for the Issuer of the Certificate.
type: str
name:
description:
- Common Name of the Certificate.
type: str
type: list
type: dict
id:
description:
- Resource ID.
returned: always
sample: null
type: str
name:
description:
- Resource name.
returned: always
sample: null
type: str
properties:
contains:
credentials:
contains:
authorization:
contains:
parameter:
description:
- Authentication Parameter value.
returned: always
sample: null
type: str
scheme:
description:
- Authentication Scheme name.
returned: always
sample: null
type: str
description:
- Authorization header authentication
returned: always
sample: null
type: dict
certificate:
description:
- List of Client Certificate Thumbprint.
returned: always
sample: null
type: str
header:
description:
- Header Parameter description.
returned: always
sample: null
type: str
query:
description:
- Query Parameter description.
returned: always
sample: null
type: str
description:
- Backend Credentials Contract Properties
returned: always
sample: null
type: dict
description:
description:
- Backend Description.
returned: always
sample: null
type: str
properties:
contains:
service_fabric_cluster:
contains:
client_certificatethumbprint:
description:
- The client certificate thumbprint for the management endpoint.
returned: always
sample: null
type: str
management_endpoints:
description:
- The cluster management endpoint.
returned: always
sample: null
type: str
max_partition_resolution_retries:
description:
- Maximum number of retries while attempting resolve the partition.
returned: always
sample: null
type: str
server_certificate_thumbprints:
description:
- Thumbprints of certificates cluster management service uses for tls
communication
returned: always
sample: null
type: str
server_x509names:
contains:
issuer_certificate_thumbprint:
description:
- Thumbprint for the Issuer of the Certificate.
returned: always
sample: null
type: str
name:
description:
- Common Name of the Certificate.
returned: always
sample: null
type: str
description:
- Server X509 Certificate Names Collection
returned: always
sample: null
type: dict
description:
- Backend Service Fabric Cluster Properties
returned: always
sample: null
type: dict
description:
- Backend Properties contract
returned: always
sample: null
type: dict
protocol:
description:
- Backend communication protocol.
returned: always
sample: null
type: str
proxy:
contains:
password:
description:
- Password to connect to the WebProxy Server
returned: always
sample: null
type: str
url:
description:
- WebProxy Server AbsoluteUri property which includes the entire URI stored
in the Uri instance, including all fragments and query strings.
returned: always
sample: null
type: str
username:
description:
- Username to connect to the WebProxy server
returned: always
sample: null
type: str
description:
- Backend Proxy Contract Properties
returned: always
sample: null
type: dict
resource_id:
description:
- Management Uri of the Resource in External System. This url can be the Arm
Resource Id of Logic Apps, Function Apps or Api Apps.
returned: always
sample: null
type: str
title:
description:
- Backend Title.
returned: always
sample: null
type: str
tls:
contains:
validate_certificate_chain:
description:
- Flag indicating whether SSL certificate chain validation should be done
when using self-signed certificates for this backend host.
returned: always
sample: null
type: bool
validate_certificate_name:
description:
- Flag indicating whether SSL certificate name validation should be done
when using self-signed certificates for this backend host.
returned: always
sample: null
type: bool
description:
- Backend TLS Properties
returned: always
sample: null
type: dict
url:
description:
- Runtime Url of the Backend.
returned: always
sample: null
type: str
description:
- Backend entity contract properties.
returned: always
sample: null
type: dict
type:
description:
- Resource type for API Management resource.
returned: always
sample: null
type: str