azure.rm.apimanagementapirelease (0.0.6) — module

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

Create, update and delete instance of Azure ApiRelease.

Requirements

• python >= 2.7
• The host that executes this module must have the azure.azcollection collection installed via galaxy
• All python packages listed in collection's requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection
• Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: ApiManagementCreateApiRelease
  azure.rm.apimanagementapirelease:
    resource_group: myResourceGroup
    service_name: myService
    api_id: myApi
    papi_id: >-
      /subscriptions/{{ subscription_id }}/resourceGroups/{{ resource_group
      }}/providers/Microsoft.ApiManagement/service/{{ service_name }}/apis/{{
      api_name }}
    release_id: myRelease
    notes: yahooagain

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: ApiManagementDeleteApiRelease
  azure.rm.apimanagementapirelease:
    resource_group: myResourceGroup
    service_name: myService
    api_id: myApi
    release_id: myRelease
    state: absent

Inputs

    
notes:
    description:
    - Release Notes
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Assert the state of the ApiRelease.
    - Use C(present) to create or update an ApiRelease and C(absent) to delete it.

api_id:
    description:
    - Identifier of the API the release belongs to.
    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

release_id:
    description:
    - Release identifier within an API. 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

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

created_date_time:
    description:
    - 'The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ
      as specified by the ISO 8601 standard.'
    type: str

updated_date_time:
    description:
    - The time the API release was updated.
    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

Outputs

id:
  description:
  - Resource ID.
  returned: always
  sample: null
  type: str
name:
  description:
  - Resource name.
  returned: always
  sample: null
  type: str
properties:
  contains:
    api_id:
      description:
      - Identifier of the API the release belongs to.
      returned: always
      sample: null
      type: str
    created_date_time:
      description:
      - 'The time the API was released. The date conforms to the following format:
        yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.'
      returned: always
      sample: null
      type: str
    notes:
      description:
      - Release Notes
      returned: always
      sample: null
      type: str
    updated_date_time:
      description:
      - The time the API release was updated.
      returned: always
      sample: null
      type: str
  description:
  - ApiRelease entity contract properties.
  returned: always
  sample: null
  type: dict
type:
  description:
  - Resource type for API Management resource.
  returned: always
  sample: null
  type: str

See also

• Sign in with Azure CLI: How to authenticate using the C(az login) command. link