Try SpotterManage Azure ProductApi 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 ProductApi.
- name: ApiManagementCreateProductApi
azure.rm.apimanagementproductapi:
resource_group: myResourceGroup
service_name: myService
product_id: myProduct
api_id: myApi
path: newapiPath
- name: ApiManagementDeleteProductApi
azure.rm.apimanagementproductapi:
resource_group: myResourceGroup
service_name: myService
product_id: myProduct
api_id: myApi
state: absent
path:
description:
- Relative URL uniquely identifying this API and all of its resource paths within
the API Management service instance. It is appended to the API endpoint base URL
specified during the service instance creation to form a public URL for this API.
type: str
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the ProductApi.
- Use C(present) to create or update an ProductApi and C(absent) to delete it.
api_id:
description:
- API revision identifier. Must be unique in the current API Management service instance.
Non-current revision has ;rev=n as a suffix where n is the revision number.
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
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
is_online:
description:
- Indicates if API revision is accessible via the gateway.
type: boolean
protocols:
description:
- Describes on which protocols the operations in this API can be invoked.
type: list
is_current:
description:
- Indicates if API revision is current api revision.
type: boolean
product_id:
description:
- Product identifier. 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
api_version:
description:
- Indicates the Version identifier of the API if the API is versioned
type: str
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. May include HTML formatting tags.
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. 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
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:
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: boolean
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:
description:
- How to send token to the server.
type: list
openid_provider_id:
description:
- OAuth authorization server identifier.
type: str
type: dict
subscription_key_required:
description:
- Specifies whether subscription key is required during call to this API, true
- API is included into closed products only, false - API is included into open
products alone, null - there is a mix of products.
type: boolean
type: dict
api_revision_description:
description:
- Description of the Api Revision.
type: str
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 name: description: - Resource name. returned: always sample: null type: str properties: description: - Api entity contract properties. returned: always sample: null type: dict type: description: - Resource type for API Management resource. returned: always sample: null type: str