Try SpotterManage Azure ApiDiagnostic 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 ApiDiagnostic.
- name: ApiManagementCreateApiDiagnostic
azure.rm.apimanagementapidiagnostic:
resource_group: myResourceGroup
service_name: myService
api_id: myApi
diagnostic_id: applicationinsights
always_log: allErrors
logger_id: /loggers/applicationinsights
sampling:
sampling_type: fixed
percentage: '50'
frontend:
request:
headers:
- Content-type
body:
bytes: '512'
response:
headers:
- Content-type
body:
bytes: '512'
backend:
request:
headers:
- Content-type
body:
bytes: '512'
response:
headers:
- Content-type
body:
bytes: '512'
- name: ApiManagementUpdateApiDiagnostic
azure.rm.apimanagementapidiagnostic:
resource_group: myResourceGroup
service_name: myService
api_id: myApi
diagnostic_id: myDiagnostic
always_log: allErrors
logger_id: /loggers/applicationinsights
sampling:
sampling_type: fixed
percentage: '50'
frontend:
request:
headers:
- Content-type
body:
bytes: '512'
response:
headers:
- Content-type
body:
bytes: '512'
backend:
request:
headers:
- Content-type
body:
bytes: '512'
response:
headers:
- Content-type
body:
bytes: '512'
- name: ApiManagementDeleteApiDiagnostic
azure.rm.apimanagementapidiagnostic:
resource_group: myResourceGroup
service_name: myService
api_id: myApi
diagnostic_id: myDiagnostic
state: absent
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the ApiDiagnostic.
- Use C(present) to create or update an ApiDiagnostic and C(absent) to delete it.
api_id:
description:
- API identifier. Must be unique in the current API Management service instance.
required: true
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
backend:
description:
- Diagnostic settings for incoming/outgoing HTTP messages to the Backend
suboptions:
request:
description:
- Diagnostic settings for request.
suboptions:
body:
description:
- Body logging settings.
suboptions:
bytes:
description:
- Number of request body bytes to log.
type: int
type: dict
headers:
description:
- Array of HTTP Headers to log.
type: list
type: dict
response:
description:
- Diagnostic settings for response.
suboptions:
body:
description:
- Body logging settings.
suboptions:
bytes:
description:
- Number of request body bytes to log.
type: int
type: dict
headers:
description:
- Array of HTTP Headers to log.
type: list
type: dict
type: dict
profile:
description:
- Security profile found in ~/.azure/credentials file.
type: str
frontend:
description:
- Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
suboptions:
request:
description:
- Diagnostic settings for request.
suboptions:
body:
description:
- Body logging settings.
suboptions:
bytes:
description:
- Number of request body bytes to log.
type: int
type: dict
headers:
description:
- Array of HTTP Headers to log.
type: list
type: dict
response:
description:
- Diagnostic settings for response.
suboptions:
body:
description:
- Body logging settings.
suboptions:
bytes:
description:
- Number of request body bytes to log.
type: int
type: dict
headers:
description:
- Array of HTTP Headers to log.
type: list
type: dict
type: dict
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
sampling:
description:
- Sampling settings for Diagnostic.
suboptions:
percentage:
description:
- Rate of sampling for fixed-rate sampling.
type: int
sampling_type:
description:
- Sampling type.
type: str
type: dict
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal.
type: str
logger_id:
description:
- Resource Id of a target logger.
required: true
type: str
always_log:
description:
- Specifies for what type of messages sampling settings should not apply.
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
diagnostic_id:
description:
- Diagnostic identifier. Must be unique in the current API Management service instance.
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
enable_http_correlation_headers:
description:
- Whether to process Correlation Headers coming to Api Management Service. Only applicable
to Application Insights diagnostics. Default is true.
type: boolean
id:
description:
- Resource ID.
returned: always
sample: null
type: str
name:
description:
- Resource name.
returned: always
sample: null
type: str
properties:
contains:
always_log:
description:
- Specifies for what type of messages sampling settings should not apply.
returned: always
sample: null
type: str
backend:
contains:
request:
contains:
body:
contains:
bytes:
description:
- Number of request body bytes to log.
returned: always
sample: null
type: int
description:
- Body logging settings.
returned: always
sample: null
type: dict
headers:
description:
- Array of HTTP Headers to log.
returned: always
sample: null
type: str
description:
- Diagnostic settings for request.
returned: always
sample: null
type: dict
response:
contains:
body:
contains:
bytes:
description:
- Number of request body bytes to log.
returned: always
sample: null
type: int
description:
- Body logging settings.
returned: always
sample: null
type: dict
headers:
description:
- Array of HTTP Headers to log.
returned: always
sample: null
type: str
description:
- Diagnostic settings for response.
returned: always
sample: null
type: dict
description:
- Diagnostic settings for incoming/outgoing HTTP messages to the Backend
returned: always
sample: null
type: dict
enable_http_correlation_headers:
description:
- Whether to process Correlation Headers coming to Api Management Service. Only
applicable to Application Insights diagnostics. Default is true.
returned: always
sample: null
type: boolean
frontend:
contains:
request:
contains:
body:
contains:
bytes:
description:
- Number of request body bytes to log.
returned: always
sample: null
type: int
description:
- Body logging settings.
returned: always
sample: null
type: dict
headers:
description:
- Array of HTTP Headers to log.
returned: always
sample: null
type: str
description:
- Diagnostic settings for request.
returned: always
sample: null
type: dict
response:
contains:
body:
contains:
bytes:
description:
- Number of request body bytes to log.
returned: always
sample: null
type: int
description:
- Body logging settings.
returned: always
sample: null
type: dict
headers:
description:
- Array of HTTP Headers to log.
returned: always
sample: null
type: str
description:
- Diagnostic settings for response.
returned: always
sample: null
type: dict
description:
- Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
returned: always
sample: null
type: dict
logger_id:
description:
- Resource Id of a target logger.
returned: always
sample: null
type: str
sampling:
contains:
percentage:
description:
- Rate of sampling for fixed-rate sampling.
returned: always
sample: null
type: int
sampling_type:
description:
- Sampling type.
returned: always
sample: null
type: str
description:
- Sampling settings for Diagnostic.
returned: always
sample: null
type: dict
description:
- Diagnostic entity contract properties.
returned: always
sample: null
type: dict
type:
description:
- Resource type for API Management resource.
returned: always
sample: null
type: str