azure / azure.rm / 0.0.6 / module / apimanagementproduct_info Get Product info. | "added in version" 2.9 of azure.rm" Authors: Zim Kalinowski (@zikalino) preview | supported by communityazure.rm.apimanagementproduct_info (0.0.6) — module
Install with ansible-galaxy collection install azure.rm:==0.0.6
collections: - name: azure.rm version: 0.0.6
Get info of Product.
- name: ApiManagementListProducts azure.rm.apimanagementproduct_info: resource_group: myResourceGroup service_name: myService
- name: ApiManagementListProductsByTags azure.rm.apimanagementproduct_info: resource_group: myResourceGroup service_name: myService
- name: ApiManagementGetProduct azure.rm.apimanagementproduct_info: resource_group: myResourceGroup service_name: myService product_id: myProduct
id: description: - Resource ID. type: str name: description: - Resource name. type: str type: description: - Resource type for API Management resource. type: str state: description: - whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. type: str terms: description: - Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process. 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 product_id: description: - Product identifier. Must be unique in the current 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 description: description: - Product description. May include HTML formatting tags. type: str display_name: description: - Product name. required: true type: str service_name: description: - The name of the API Management service. required: true type: str expand_groups: description: - When set to true, the response contains an array of groups that have visibility to the product. The default is false. type: boolean resource_group: description: - The name of the resource group. required: true type: str subscription_id: description: - Your Azure subscription Id. type: str approval_required: description: - "whether subscription approval is required. If false, new subscriptions will be\ \ approved automatically enabling developers to call the product\u2019s APIs immediately\ \ after subscribing. If true, administrators must manually approve the subscription\ \ before the developer can any of the product\u2019s APIs. Can be present only if\ \ subscriptionRequired property is present and has a value of false." type: boolean 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 subscriptions_limit: description: - Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false. type: number 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: - Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. type: boolean include_not_tagged_products: description: - Include not tagged Products. type: boolean
product: contains: product_name: contains: id: description: - Resource ID. returned: always sample: null type: str name: description: - Resource name. returned: always sample: null type: str properties: description: - Product 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 Product and the values are the facts for that Product. returned: always type: complex