Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Module [API Management] #322

Merged
merged 21 commits into from
May 21, 2021
Merged

Conversation

sakar97
Copy link
Contributor

@sakar97 sakar97 commented Nov 13, 2020

SUMMARY

This module introduces a wide variety of configurations for creating an API instance on Azure.

  • Create API instances on an API management service on Azure.
  • Update API instances on an API management service on Azure.
  • Delete API instances on an API management service on Azure.
  • Get API instances on an API management service on Azure.

Fixes #209

ISSUE TYPE
  • New Module Pull Request
COMPONENT NAME

azure_rm_apimanagement

ADDITIONAL INFORMATION

This module allows user to create/update or delete the api management instance. It also provides all the parameters given by Microsoft.ApiManagement service/apis
More information: https://docs.microsoft.com/en-us/azure/templates/microsoft.apimanagement/service/apis


    - 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

@Fred-sun
Copy link
Collaborator

Hi @Fred-sun Can you review this PR and provide your important feedback? Thanks!

@sakar97 Thanks for your contribution. I will review and push for merge!

plugins/modules/azure_rm_apimanagement.py Outdated Show resolved Hide resolved
plugins/modules/azure_rm_apimanagement.py Show resolved Hide resolved
plugins/modules/azure_rm_apimanagement.py Show resolved Hide resolved
plugins/modules/azure_rm_apimanagement.py Outdated Show resolved Hide resolved
plugins/modules/azure_rm_apimanagement_info.py Outdated Show resolved Hide resolved
plugins/modules/azure_rm_apimanagement_info.py Outdated Show resolved Hide resolved
plugins/modules/azure_rm_apimanagement_info.py Outdated Show resolved Hide resolved
plugins/modules/azure_rm_apimanagement_info.py Outdated Show resolved Hide resolved
@Fred-sun
Copy link
Collaborator

@sakar97 After you update, you can follow the link below to do sanity verification to verify that the format is correct!

https://docs.ansible.com/ansible/latest/dev_guide/testing_sanity.html

@Fred-sun Fred-sun added medium_priority Medium priority new_module_pr Add new modules work in In trying to solve, or in working with contributors labels Nov 17, 2020
@paultaiton
Copy link
Contributor

@sakar97
Why did you choose to use generic Azure rest api client used for these modules instead of the purpose built azure.mgmt.apimanagement client ?

@nikhilpatne
Copy link
Contributor

Hi @paultaiton We thought it would be better to use predefined generic Azure rest api client instead of any other method.
imported from https://github.com/ansible-collections/azure/blob/dev/plugins/module_utils/azure_rm_common_rest.py

@paultaiton
Copy link
Contributor

Hello @nikhilpatne .
I would argue that it is not a better method. The generic Azure rest api client is a last resort and only a recommended pattern when there does not exist a more specific management client in the Azure python SDK for the resource needing to be managed.

The vast majority of modules in this collection follow the pattern of using a '@Property' decorated method located in azure_rm_common.py to contain an azure.mgmt.XYZ client, and to use it in module code to manage the resources. Done this way it leads to code that is more pythonic, more robust ( the specific use case is better tested by upstream Azure-python-sdk team,) cleaner code that is more concise and follows patterns better in regards to naming, and MUCH more maintainable long term.

I appreciate everyone who contributes free code for all to use and am grateful you and @sakar97 have taken the time, but I think rewriting this module to follow the standard practice used almost everywhere else in the collection will produce a better product in the long term that is much easier to maintain by the community going forward. That's only my opinion of course, and the decision would be down to the project maintainers ( if I'm not mistaken @Fred-sun and @haiyuazhang .)

Thanks everyone,
Paul

@nikhilpatne
Copy link
Contributor

Thanks @paultaiton for your valuable feedback, will work on it

@sakar97
Copy link
Contributor Author

sakar97 commented Dec 10, 2020

Hi, @paultaiton I am trying to use azure-mgmt-apimanagement, specifically the api-operations class. When I am using the create_or_update function then the SDK gives an error of API not found. Instead of creating a new API instance, the function is trying to update the value. Can you help me with this? sdk link: https://azuresdkdocs.blob.core.windows.net/$web/python/azure-mgmt-apimanagement/0.1.0/azure.mgmt.apimanagement.operations.html#azure.mgmt.apimanagement.operations.ApiOperations

@paultaiton
Copy link
Contributor

Hi, @paultaiton I am trying to use azure-mgmt-apimanagement, specifically the api-operations class. When I am using the create_or_update function then the SDK gives an error of API not found. Instead of creating a new API instance, the function is trying to update the value. Can you help me with this? sdk link: https://azuresdkdocs.blob.core.windows.net/$web/python/azure-mgmt-apimanagement/0.1.0/azure.mgmt.apimanagement.operations.html#azure.mgmt.apimanagement.operations.ApiOperations

Hello @sakar97 . Have you updated the code in this PR with what you're asking for? I'm not understanding exactly what you're asking, and would need to see the code giving your problems to really understand.

The general pattern for the management clients is to have a @Property decorated function in the azure_rm_common.py file in module_utils that corresponds to something like apimanagement_client that instantiates the management client class. Then one of the methods of that class will be apimanagement_client.api_management_service.create_or_update() .

Below is a very rough outline of what you would do outside of Ansible to use the python SDK to create (or update) an apim service:

#!/usr/bin/env python
from azure.common.client_factory import get_client_from_cli_profile
from azure.mgmt.apimanagement import ApiManagementClient
from azure.mgmt.apimanagement.models import ApiManagementServiceUpdateParameters

resource_group_name = ''
service_name = ''

if __name__ == "__main__":
    apimanagement_client = get_client_from_cli_profile(ApiManagementClient)

    apim_service_parameters = ApiManagementServiceUpdateParameters(
        # PARAMETER-DOCS-IN-PYTHONVENV/azure/mgmt/apimanagement/models/_models.py
    )

    apimanagement_client.api_management_service.create_or_update(resource_group_name,
                                                              service_name,
                                                              apim_create_parameters)


I hope that helps. Shoot me any other questions you have.

@sakar97
Copy link
Contributor Author

sakar97 commented Dec 12, 2020

Hi, @paultaiton I am trying to use azure-mgmt-apimanagement, specifically the api-operations class. When I am using the create_or_update function then the SDK gives an error of API not found. Instead of creating a new API instance, the function is trying to update the value. Can you help me with this? sdk link: https://azuresdkdocs.blob.core.windows.net/$web/python/azure-mgmt-apimanagement/0.1.0/azure.mgmt.apimanagement.operations.html#azure.mgmt.apimanagement.operations.ApiOperations

Hello @sakar97 . Have you updated the code in this PR with what you're asking for? I'm not understanding exactly what you're asking, and would need to see the code giving your problems to really understand.

The general pattern for the management clients is to have a @Property decorated function in the azure_rm_common.py file in module_utils that corresponds to something like apimanagement_client that instantiates the management client class. Then one of the methods of that class will be apimanagement_client.api_management_service.create_or_update() .

Below is a very rough outline of what you would do outside of Ansible to use the python SDK to create (or update) an apim service:

#!/usr/bin/env python
from azure.common.client_factory import get_client_from_cli_profile
from azure.mgmt.apimanagement import ApiManagementClient
from azure.mgmt.apimanagement.models import ApiManagementServiceUpdateParameters

resource_group_name = ''
service_name = ''

if __name__ == "__main__":
    apimanagement_client = get_client_from_cli_profile(ApiManagementClient)

    apim_service_parameters = ApiManagementServiceUpdateParameters(
        # PARAMETER-DOCS-IN-PYTHONVENV/azure/mgmt/apimanagement/models/_models.py
    )

    apimanagement_client.api_management_service.create_or_update(resource_group_name,
                                                              service_name,
                                                              apim_create_parameters)

I hope that helps. Shoot me any other questions you have.

Hi @paultaiton, I have understood the process you have explained, and to be more precise with the problem I have changed azure_rm_apimanagement.py and requirements-azure.txt file. Using this method, update, delete and get functions are properly working but the create function is giving API Not Found error. I am not sure what I am doing wrong here. Thanks

@paultaiton
Copy link
Contributor

@sakar97
Is your intent with this module to provision and manage the apim service resource, or the individual APIs that exist inside an apim service resource? Because I think the method that you're calling is to create or update individual APIs, not the apim resource itself.

@sakar97
Copy link
Contributor Author

sakar97 commented Dec 13, 2020

@paultaiton Yes, this module is for Individual API in apim services. Module for individual apim services are open in #333.

@sakar97
Copy link
Contributor Author

sakar97 commented Dec 17, 2020

Hi @paultaiton Did you find the issue which I was referring. Thanks

@paultaiton
Copy link
Contributor

I apologize for my delay in response, I haven't had a chance to look into this. I will try and take a look this weekend. I'm not an expert in API management at all, so I'm having to make assumptions based on the standard usage pattern of the Azure python SDK's management clients.

Copy link
Collaborator

@Fred-sun Fred-sun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sakar97 The content of the document and the return value, the indentation between the upper and lower levels should be 4 characters, thank you!

plugins/modules/azure_rm_apimanagement.py Outdated Show resolved Hide resolved
plugins/modules/azure_rm_apimanagement.py Outdated Show resolved Hide resolved
plugins/modules/azure_rm_apimanagement.py Outdated Show resolved Hide resolved
plugins/modules/azure_rm_apimanagement.py Outdated Show resolved Hide resolved
plugins/modules/azure_rm_apimanagement.py Outdated Show resolved Hide resolved
plugins/modules/azure_rm_apimanagement.py Outdated Show resolved Hide resolved
plugins/modules/azure_rm_apimanagement.py Outdated Show resolved Hide resolved
plugins/modules/azure_rm_apimanagement.py Outdated Show resolved Hide resolved
plugins/modules/azure_rm_apimanagement.py Outdated Show resolved Hide resolved


if __name__ == '__main__':
main()
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no newline at end of file

@Fred-sun
Copy link
Collaborator

@sakar97 You can check the module through the link below。 link: https://docs.ansible.com/ansible/devel/dev_guide/testing_sanity.html#testing-sanity
In addition, please execute your task/main.yml to ensure that the submitted Case can be run, and add idempotency testing. Thank you!

@sakar97 sakar97 requested a review from Fred-sun January 13, 2021 14:53
@Fred-sun
Copy link
Collaborator

Fred-sun commented Jan 14, 2021

ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: deprecation-mismatch: "meta/runtime.yml" and DOCUMENTATION.deprecation do not agree.
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: doc-choices-do-not-match-spec: Argument 'api_type' in argument_spec defines choices as (['http', 'soap']) but documentation defines choices as ([])
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: doc-choices-do-not-match-spec: Argument 'auth_source' in argument_spec defines choices as (['auto', 'cli', 'env', 'credential_file', 'msi']) but documentation defines choices as ([])
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: doc-choices-do-not-match-spec: Argument 'bearer_token_sending_methods' in argument_spec found in authentication_settings -> openid defines choices as ([['authorizationHeader'], ['query']]) but documentation defines choices as ([])
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: doc-choices-do-not-match-spec: Argument 'cert_validation_mode' in argument_spec defines choices as (['validate', 'ignore']) but documentation defines choices as ([])
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: doc-choices-do-not-match-spec: Argument 'format' in argument_spec defines choices as (['wadl-xml', 'wadl-link-json', 'swagger-json', 'swagger-link-json', 'wsdl', 'wsdl-link', 'openapi', 'openapi+json', 'openapi-link']) but documentation defines choices as ([])
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: doc-choices-do-not-match-spec: Argument 'protocols' in argument_spec defines choices as ([['http'], ['https']]) but documentation defines choices as ([])
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: doc-choices-do-not-match-spec: Argument 'state' in argument_spec defines choices as (['present', 'absent']) but documentation defines choices as ([])
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: doc-choices-do-not-match-spec: Argument 'type' in argument_spec defines choices as (['http', 'soap']) but documentation defines choices as ([])
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: doc-choices-do-not-match-spec: Argument 'versioning_scheme' in argument_spec found in api_version_set defines choices as (['Segment', 'Query', 'Header']) but documentation defines choices as ([])
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: doc-default-does-not-match-spec: Argument 'api_profile' in argument_spec defines default as ('latest') but documentation defines default as (None)
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: doc-default-does-not-match-spec: Argument 'append_tags' in argument_spec defines default as (True) but documentation defines default as (None)
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: doc-default-does-not-match-spec: Argument 'auth_source' in argument_spec defines default as ('auto') but documentation defines default as (None)
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: doc-default-does-not-match-spec: Argument 'cloud_environment' in argument_spec defines default as ('AzureCloud') but documentation defines default as (None)
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: doc-default-does-not-match-spec: Argument 'state' in argument_spec defines default as ('present') but documentation defines default as (None)
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: doc-required-mismatch: Argument 'api_id' in argument_spec is required, but is not documented as being required
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: doc-required-mismatch: Argument 'path' in argument_spec is required, but is not documented as being required
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: doc-required-mismatch: Argument 'resource_group' in argument_spec is required, but is not documented as being required
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: doc-required-mismatch: Argument 'service_name' in argument_spec is required, but is not documented as being required
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: missing-suboption-docs: Argument 'api_version_set' in argument_spec has sub-options but documentation does not define it
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: missing-suboption-docs: Argument 'authentication_settings' in argument_spec has sub-options but documentation does not define it
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: missing-suboption-docs: Argument 'o_auth2' in argument_spec found in authentication_settings has sub-options but documentation does not define it
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: missing-suboption-docs: Argument 'openid' in argument_spec found in authentication_settings has sub-options but documentation does not define it
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: missing-suboption-docs: Argument 'subscription_key_parameter_names' in argument_spec has sub-options but documentation does not define it
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: missing-suboption-docs: Argument 'wsdl_selector' in argument_spec has sub-options but documentation does not define it
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-list-no-elements: Argument 'bearer_token_sending_methods' in argument_spec found in authentication_settings -> openid defines type as list but elements is not defined
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-list-no-elements: Argument 'protocols' in argument_spec defines type as list but elements is not defined
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'ad_user' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'adfs_authority_url' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'api_id' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'api_profile' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'api_revision' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'api_revision_description' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'api_type' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'api_version' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'api_version_description' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'api_version_set' in argument_spec defines type as 'dict' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'api_version_set_id' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'append_tags' in argument_spec defines type as 'bool' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'auth_source' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'authentication_settings' in argument_spec defines type as 'dict' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'authorization_server_id' in argument_spec found in authentication_settings -> o_auth2 defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'bearer_token_sending_methods' in argument_spec found in authentication_settings -> openid defines type as 'list' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'cert_validation_mode' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'client_id' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'cloud_environment' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'description' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'description' in argument_spec found in api_version_set defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'display_name' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'format' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'header' in argument_spec found in subscription_key_parameter_names defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'id' in argument_spec found in api_version_set defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'is_current' in argument_spec defines type as 'bool' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'name' in argument_spec found in api_version_set defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'o_auth2' in argument_spec found in authentication_settings defines type as 'dict' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'openid' in argument_spec found in authentication_settings defines type as 'dict' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'openid_provider_id' in argument_spec found in authentication_settings -> openid defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'password' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'path' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'profile' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'protocols' in argument_spec defines type as 'list' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'query' in argument_spec found in subscription_key_parameter_names defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'resource_group' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'scope' in argument_spec found in authentication_settings -> o_auth2 defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'secret' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'service_name' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'service_url' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'source_api_id' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'state' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'subscription_id' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'subscription_key_parameter_names' in argument_spec defines type as 'dict' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'subscription_required' in argument_spec defines type as 'bool' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'tags' in argument_spec defines type as 'dict' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'tenant' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'type' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'value' in argument_spec defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'version_header_name' in argument_spec found in api_version_set defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'version_query_name' in argument_spec found in api_version_set defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'versioning_scheme' in argument_spec found in api_version_set defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'wsdl_endpoint_name' in argument_spec found in wsdl_selector defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'wsdl_selector' in argument_spec defines type as 'dict' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: parameter-type-not-in-doc: Argument 'wsdl_service_name' in argument_spec found in wsdl_selector defines type as 'str' but documentation doesn't define type
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: undocumented-parameter: Argument 'authorization_server_id' found in authentication_settings -> o_auth2 is listed in the argument_spec, but not documented in the module documentation
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: undocumented-parameter: Argument 'bearer_token_sending_methods' found in authentication_settings -> openid is listed in the argument_spec, but not documented in the module documentation
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: undocumented-parameter: Argument 'description' found in api_version_set is listed in the argument_spec, but not documented in the module documentation
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: undocumented-parameter: Argument 'header' found in subscription_key_parameter_names is listed in the argument_spec, but not documented in the module documentation
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: undocumented-parameter: Argument 'id' found in api_version_set is listed in the argument_spec, but not documented in the module documentation
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: undocumented-parameter: Argument 'name' found in api_version_set is listed in the argument_spec, but not documented in the module documentation
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: undocumented-parameter: Argument 'o_auth2' found in authentication_settings is listed in the argument_spec, but not documented in the module documentation
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: undocumented-parameter: Argument 'openid' found in authentication_settings is listed in the argument_spec, but not documented in the module documentation
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: undocumented-parameter: Argument 'openid_provider_id' found in authentication_settings -> openid is listed in the argument_spec, but not documented in the module documentation
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: undocumented-parameter: Argument 'query' found in subscription_key_parameter_names is listed in the argument_spec, but not documented in the module documentation
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: undocumented-parameter: Argument 'scope' found in authentication_settings -> o_auth2 is listed in the argument_spec, but not documented in the module documentation
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: undocumented-parameter: Argument 'version_header_name' found in api_version_set is listed in the argument_spec, but not documented in the module documentation
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: undocumented-parameter: Argument 'version_query_name' found in api_version_set is listed in the argument_spec, but not documented in the module documentation
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: undocumented-parameter: Argument 'versioning_scheme' found in api_version_set is listed in the argument_spec, but not documented in the module documentation
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: undocumented-parameter: Argument 'wsdl_endpoint_name' found in wsdl_selector is listed in the argument_spec, but not documented in the module documentation
ERROR: plugins/modules/azure_rm_apimanagement.py:0:0: undocumented-parameter: Argument 'wsdl_service_name' found in wsdl_selector is listed in the argument_spec, but not documented in the module documentation


@sakar97
Copy link
Contributor Author

sakar97 commented Mar 20, 2021

Hello @Fred-sun Could you help me figure out the error? This module is open since quite a lot of time now. Thanks

@Fred-sun
Copy link
Collaborator

@sakar97 There are a lot of Sanity errors, can you authorize me to make some updates in your branch? Thank you very much!

@sakar97
Copy link
Contributor Author

sakar97 commented Mar 22, 2021

Hi, @Fred-sun I have given you the permission. Kindly approve. Thanks

@Ompragash
Copy link
Member

@Fred-sun Could you take a look at it?

@Fred-sun
Copy link
Collaborator

Fred-sun commented Apr 6, 2021

@Fred-sun Could you take a look at it?

@Ompragash I'm working in this! Thank you very much!

@Fred-sun Fred-sun added ready_for_review The PR has been modified and can be reviewed and merged and removed work in In trying to solve, or in working with contributors labels May 21, 2021
@haiyuazhang haiyuazhang merged commit 1cd1bdd into ansible-collections:dev May 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
medium_priority Medium priority new_module_pr Add new modules ready_for_review The PR has been modified and can be reviewed and merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cloud Module for Azure API Management
6 participants