azure.rm.apimanagementlogger_info (0.0.6) — module

Get Logger info.

| "added in version" 2.9 of azure.rm"

Authors: Zim Kalinowski (@zikalino)

preview | supported by community

Install collection

Install with ansible-galaxy collection install azure.rm:==0.0.6


Add to requirements.yml

  collections:
    - name: azure.rm
      version: 0.0.6

Description

Get info of Logger.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: ApiManagementListLoggers
  azure.rm.apimanagementlogger_info:
    resource_group: myResourceGroup
    service_name: myService
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: ApiManagementGetLogger
  azure.rm.apimanagementlogger_info:
    resource_group: myResourceGroup
    service_name: myService
    logger_id: myLogger

Inputs

    
id:
    description:
    - Resource ID.
    type: str

name:
    description:
    - Resource name.
    type: str

type:
    description:
    - Resource type for API Management resource.
    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

client_id:
    description:
    - Azure client ID. Use when authenticating with a Service Principal.
    type: str

logger_id:
    description:
    - Logger identifier. Must be unique in the API Management service instance.
    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:
    - The name and SendRule connection string of the event hub for azureEventHub logger.<br>Instrumentation
      key for applicationInsights logger.
    required: true
    type: str

description:
    description:
    - Logger description.
    type: str

is_buffered:
    description:
    - Whether records are buffered in the logger before publishing. Default is assumed
      to be true.
    type: boolean

logger_type:
    description:
    - Logger type.
    required: true
    type: str

resource_id:
    description:
    - Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application
      Insights resource).
    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

Outputs

logger:
  contains:
    logger_name:
      contains:
        id:
          description:
          - Resource ID.
          returned: always
          sample: null
          type: str
        name:
          description:
          - Resource name.
          returned: always
          sample: null
          type: str
        properties:
          description:
          - Logger entity contract properties.
          returned: always
          sample: null
          type: dict
        type:
          description:
          - Resource type for API Management resource.
          returned: always
          sample: null
          type: str
      description: The key is the name of the server that the values relate to.
      type: complex
  description: A list of dict results where the key is the name of the Logger and
    the values are the facts for that Logger.
  returned: always
  type: complex

See also