azure / azure.rm / 0.0.6 / module / apimanagementapiversionset Manage Azure ApiVersionSet instance. | "added in version" 2.9 of azure.rm" Authors: Zim Kalinowski (@zikalino) preview | supported by communityazure.rm.apimanagementapiversionset (0.0.6) — module
Install with ansible-galaxy collection install azure.rm:==0.0.6
collections: - name: azure.rm version: 0.0.6
Create, update and delete instance of Azure ApiVersionSet.
- name: ApiManagementCreateApiVersionSet azure.rm.apimanagementapiversionset: resource_group: myResourceGroup service_name: myService version_set_id: myApiVersionSet description: Version configuration display_name: "api set 1" versioning_scheme: Segment
- name: ApiManagementUpdateApiVersionSet azure.rm.apimanagementapiversionset: resource_group: myResourceGroup service_name: myService version_set_id: myApiVersionSet description: Version configuration display_name: "api set 1" versioning_scheme: Segment
- name: ApiManagementDeleteApiVersionSet azure.rm.apimanagementapiversionset: resource_group: myResourceGroup service_name: myService version_set_id: myApiVersionSet state: absent
state: choices: - absent - present default: present description: - Assert the state of the ApiVersionSet. - Use C(present) to create or update an ApiVersionSet and C(absent) to delete it. 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 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 description: description: - Description of API Version Set. type: str display_name: description: - Name of API Version Set required: true 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 version_set_id: description: - Api Version Set identifier. Must be unique in the current API Management service instance. 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 versioning_scheme: description: - An value that determines where the API Version identifer will be located in a HTTP request. required: true 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 version_query_name: description: - Name of query parameter that indicates the API Version if versioningScheme is set to `query`. type: str version_header_name: description: - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. 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
id: description: - Resource ID. returned: always sample: null type: str name: description: - Resource name. returned: always sample: null type: str properties: contains: description: description: - Description of API Version Set. returned: always sample: null type: str display_name: description: - Name of API Version Set returned: always sample: null type: str version_header_name: description: - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. returned: always sample: null type: str version_query_name: description: - Name of query parameter that indicates the API Version if versioningScheme is set to `query`. returned: always sample: null type: str versioning_scheme: description: - An value that determines where the API Version identifer will be located in a HTTP request. returned: always sample: null type: str description: - Api VersionSet contract properties. returned: always sample: null type: dict type: description: - Resource type for API Management resource. returned: always sample: null type: str