azure / azure.azcollection / 2.3.0 / module / azure_rm_apimanagement Manage Azure api instances | "added in version" 1.6.0 of azure.azcollection" Authors: Sakar Mehra (@sakar97), Nikhil Patne (@nikhilpatne)azure.azcollection.azure_rm_apimanagement (2.3.0) — module
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections: - name: azure.azcollection version: 2.3.0
Create azure api instance.
Update the existing azure api instance.
Delete azure api instance.
- name: Create a new API instance azure_rm_apimanagement: resource_group: 'myResourceGroup' service_name: myService api_id: testApi description: testDescription display_name: TestAPI service_url: 'http://testapi.example.net/api' path: myapiPath protocols: - https
- name: Update an existing API instance. azure_rm_apimanagement: resource_group: myResourceGroup service_name: myService api_id: testApi display_name: newTestAPI service_url: 'http://testapi.example.net/api' path: myapiPath protocols: - https
- name: ApiManagementDeleteApi azure_rm_apimanagement: resource_group: myResourceGroup service_name: myService api_id: testApi state: absent
path: description: - Relative URL uniquely identifying this API. type: str 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 type: choices: - http - soap description: - Type of API type: str state: choices: - absent - present default: present description: - State of the Api. - Use C(present) to create or update an Api and C(absent) to delete it. type: str value: description: - Content value when Importing an API. type: str api_id: description: - API revision identifier. It must be unique in the current API Management service instance. required: true type: str format: choices: - wadl-xml - wadl-link-json - swagger-json - swagger-link-json - wsdl - wsdl-link - openapi - openapi+json - openapi-link description: - Format of the Content in which the API is getting imported. 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 api_type: choices: - soap - http description: - Type of Api to create. - C(http) creates a SOAP to REST API. - C(soap) creates a SOAP pass-through API. 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 or Managed Identity (msi). - Can also be set via the C(AZURE_CLIENT_ID) environment variable. type: str protocols: choices: - http - https description: - Describes on which protocols the operations in this API can be invoked. elements: str type: list is_current: description: - Indicates if API revision is current api revision. type: bool thumbprint: description: - The thumbprint of the private key specified in I(x509_certificate_path). - Use when authenticating with a Service Principal. - Required if I(x509_certificate_path) is defined. type: str version_added: 1.14.0 version_added_collection: azure.azcollection 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 api_version: description: - Indicates the Version identifier of the API if the API is versioned type: str 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 description: description: - Description of the API. type: str service_url: description: - Absolute URL of the backend service implementing this API - Cannot be more than 2000 characters long. type: str api_revision: description: - Describes the Revision of the Api. - If no value is provided, default revision 1 is created type: str display_name: description: - API Name to be displayed. It must be 1 to 300 characters long. type: str service_name: description: - The name of the API Management service. required: true type: str source_api_id: description: - API identifier of the source API. type: str wsdl_selector: description: - Criteria to limit import of WSDL to a subset of the document. suboptions: wsdl_endpoint_name: description: - Name of endpoint(port) to import from WSDL. type: str wsdl_service_name: description: - Name of service to import from WSDL. type: str type: dict resource_group: description: - The name of the resource group. required: true type: str api_version_set: description: - Version set details suboptions: description: description: - Description of API Version Set. type: str id: description: - Identifier for existing API Version Set - Omit this value to create a new Version Set. type: str name: description: - The display Name of the API Version Set. type: str version_header_name: description: - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. type: str version_query_name: description: - Name of query parameter that indicates the API Version if versioningScheme is set to `query`. type: str versioning_scheme: choices: - Segment - Query - Header description: - An value that determines where the API Version identifer will be located in a HTTP request. type: str type: dict 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 api_version_set_id: description: - A resource identifier for the related ApiVersionSet. type: str 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 subscription_required: description: - Specifies whether an API or Product subscription is required for accessing the API. type: bool x509_certificate_path: description: - Path to the X509 certificate used to create the service principal in PEM format. - The certificate must be appended to the private key. - Use when authenticating with a Service Principal. type: path version_added: 1.14.0 version_added_collection: azure.azcollection api_version_description: description: - Description of the Api Version. type: str authentication_settings: description: - Collection of authentication settings included into this API. suboptions: o_auth2: description: - OAuth2 Authentication settings suboptions: authorization_server_id: description: - OAuth authorization server identifier. type: str scope: description: - operations scope. type: str type: dict openid: description: - OpenID Connect Authentication Settings suboptions: bearer_token_sending_methods: choices: - authorizationHeader - query description: - How to send token to the server. elements: str type: list openid_provider_id: description: - OAuth authorization server identifier. type: str type: dict type: dict api_revision_description: description: - Description of the Api Revision. type: str disable_instance_discovery: default: false description: - Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. - Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable. type: bool version_added: 2.3.0 version_added_collection: azure.azcollection subscription_key_parameter_names: description: - Protocols over which API is made available. suboptions: header: description: - Subscription key header name. type: str query: description: - Subscription key query string parameter name. type: str type: dict
id: description: - Resource ID. returned: always sample: null type: str