[APIM] Add product / productapi / namedValue entity commands && migrate sdk version (Azure#14780)

Author: RupengLiu

src/azure-cli/azure/cli/command_modules/apim/_client_factory.py

@@ -16,3 +16,27 @@ def cf_service(cli_ctx, *_):
 
 def cf_api(cli_ctx, *_):
     return cf_apim(cli_ctx).api
+
+
+def cf_product(cli_ctx, *_):
+    return cf_apim(cli_ctx).product
+
+
+def cf_nv(cli_ctx, *_):
+    return cf_apim(cli_ctx).named_value
+
+
+def cf_apiops(cli_ctx, *_):
+    return cf_apim(cli_ctx).api_operation
+
+
+def cf_apirelease(cli_ctx, *_):
+    return cf_apim(cli_ctx).api_release
+
+
+def cf_apirevision(cli_ctx, *_):
+    return cf_apim(cli_ctx).api_revision
+
+
+def cf_apiversionset(cli_ctx, *_):
+    return cf_apim(cli_ctx).api_version_set

src/azure-cli/azure/cli/command_modules/apim/_help.py

@@ -17,6 +17,41 @@
 short-summary: Manage Azure API Management API's.
 """
 
+helps['apim product api'] = """
+type: group
+short-summary: Manage Azure API Management Product's APIs.
+"""
+
+helps['apim product'] = """
+type: group
+short-summary: Manage Azure API Management Product's.
+"""
+
+helps['apim nv'] = """
+type: group
+short-summary: Manage Azure API Management Named Values.
+"""
+
+helps['apim api operation'] = """
+type: group
+short-summary: Manage Azure API Management API Operations.
+"""
+
+helps['apim api release'] = """
+type: group
+short-summary: Manage Azure API Management API Release.
+"""
+
+helps['apim api revision'] = """
+type: group
+short-summary: Manage Azure API Management API Revision.
+"""
+
+helps['apim api versionset'] = """
+type: group
+short-summary: Manage Azure API Management API Version Set.
+"""
+
 helps['apim backup'] = """
 type: command
 short-summary: Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
@@ -147,3 +182,302 @@
 type: command
 short-summary: Import an API Management service instance.
 """
+
+helps['apim product api list'] = """
+type: command
+short-summary: Lists a collection of the APIs associated with a product.
+examples:
+  - name: List all APIs associated with a product.
+    text: |-
+        az apim product api list --resource-group MyResourceGroup  --service-name MyServiceName  --product-id MyProductID
+"""
+
+helps['apim product api check'] = """
+type: command
+short-summary: Checks that API entity specified by identifier is associated with the Product entity.
+examples:
+  - name: Check if the API is associated with the Product.
+    text: |-
+        az apim product api check --resource-group MyResourceGroup  --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID
+"""
+
+helps['apim product api add'] = """
+type: command
+short-summary: Add an API to the specified product.
+examples:
+  - name: Add an API to the specified product.
+    text: |-
+        az apim product api add --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID
+"""
+
+helps['apim product api delete'] = """
+type: command
+short-summary: Deletes the specified API from the specified product.
+examples:
+  - name: Deletes the specified API from the specified product.
+    text: |-
+        az apim product api delete --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID
+"""
+
+helps['apim product list'] = """
+type: command
+short-summary: Lists a collection of products in the specified service instance.
+examples:
+  - name: List all products for this APIM instance.
+    text: |-
+        az apim product list --resource-group MyResourceGroup --service-name MyServiceName
+"""
+
+helps['apim product show'] = """
+type: command
+short-summary: Gets the details of the product specified by its identifier.
+examples:
+  - name: Gets the details of the product specified by its identifier.
+    text: |-
+        az apim product show --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID
+"""
+
+helps['apim product create'] = """
+type: command
+short-summary: Creates a product.
+examples:
+  - name: Creates a product.
+    text: |-
+        az apim product create --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyProductName --description MyDescription --legal-terms MyTerms --subscription-required true --approval-required true --subscriptions-limit 8 --state "published"
+"""
+
+helps['apim product update'] = """
+type: command
+short-summary: Update existing product details.
+examples:
+  - name: Update existing product details.
+    text: |-
+        az apim product update --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyNewProductName --description MyNewDescription --legal-terms MyNewTerms --subscription-required false --state "notPublished"
+"""
+
+helps['apim product delete'] = """
+type: command
+short-summary: Delete product.
+examples:
+  - name: Delete product with all subscriptions to this product.
+    text: |-
+        az apim product delete --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --delete-subscriptions true
+"""
+
+helps['apim nv list'] = """
+type: command
+short-summary: List API Management Named Values.
+"""
+
+helps['apim nv show'] = """
+type: command
+short-summary: Show details of an API Management Named Value.
+"""
+
+helps['apim nv show-secret'] = """
+type: command
+short-summary: Gets the secret of an API Management Named Value.
+"""
+
+helps['apim nv delete'] = """
+type: command
+short-summary: Delete an API Management Named Value.
+"""
+
+helps['apim nv create'] = """
+type: command
+short-summary: Create an API Management Named Value.
+parameters:
+  - name: --named-value-id
+    type: string
+    short-summary: unique name for the Named Value to be created
+    long-summary: |
+        Must be unique in the current API Management service instance.
+  - name: --display-name
+    type: string
+    short-summary: The Display name of the Named Value.
+  - name: --value
+    type: string
+    short-summary: The value of the Named Value.
+examples:
+  - name: Create a Named Value.
+    text: |-
+        az apim nv create --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --display-name 'My Named Value' --value 'foo'
+"""
+
+helps['apim nv update'] = """
+type: command
+short-summary: Update an API Management Named Value.
+parameters:
+  - name: --named-value-id
+    type: string
+    short-summary: unique name of the api to be created
+    long-summary: |
+        Must be unique in the current API Management service instance.
+  - name: --value
+    type: string
+    short-summary: The value of the Named Value.
+examples:
+  - name: Create a basic API.
+    text: |-
+        az apim nv update --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --value foo
+"""
+
+helps['apim api operation list'] = """
+type: command
+short-summary: List a collection of the operations for the specified API.
+examples:
+  - name: List a collection of the operations for the specified API.
+    text: |-
+        az apim api operation list --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId
+"""
+
+helps['apim api operation show'] = """
+type: command
+short-summary: Gets the details of the API Operation specified by its identifier.
+examples:
+  - name: Gets the details of the API Operation specified by its identifier.
+    text: |-
+        az apim api operation show --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId
+"""
+
+helps['apim api operation create'] = """
+type: command
+short-summary: Creates a new operation in the API
+examples:
+  - name: Creates a new operation in the API with several parameters
+    text: |-
+        az apim api operation create --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --url-template "/session/{param1}/{param2}" --method "GET" --display-name MyOperationName --description MyDescription --template-parameters name=param1 description=descriptionContent type=paramType required="true" --template-parameters name=param2 required="false" type="string"
+"""
+
+helps['apim api operation update'] = """
+type: command
+short-summary: Updates the details of the operation in the API specified by its identifier.
+examples:
+  - name: Updates method, displayname, description of the operation in the API specified by its identifier.
+    text: |-
+        az apim api operation update --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId --method "PUT" --display-name NewDisplayName --description NewDescription
+"""
+
+helps['apim api operation delete'] = """
+type: command
+short-summary: Deletes the specified operation in the API.
+examples:
+  - name: Deletes the specified operation in the API.
+    text: |-
+        az apim api operation delete --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId
+"""
+
+helps['apim api release list'] = """
+type: command
+short-summary: Lists all releases of an API.
+examples:
+  - name: Lists all releases of an API.
+    text: |-
+        az apim api release list --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId
+"""
+
+helps['apim api release show'] = """
+type: command
+short-summary: Returns the details of an API release.
+examples:
+  - name: Returns the details of an API release.
+    text: |-
+        az apim api release show --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId
+"""
+
+helps['apim api release create'] = """
+type: command
+short-summary: Creates a new Release for the API.
+examples:
+  - name: Creates a new Release for the API.
+    text: |-
+        az apim api release create --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId --api-revision 2 --notes MyNotes
+"""
+
+helps['apim api release update'] = """
+type: command
+short-summary: Updates the details of the release of the API specified by its identifier.
+examples:
+  - name: Updates the notes of the release of the API specified by its identifier.
+    text: |-
+        az apim api release update --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId --notes MyNewNotes
+"""
+
+helps['apim api release delete'] = """
+type: command
+short-summary: Deletes the specified release in the API.
+examples:
+  - name: Deletes the specified release in the API.
+    text: |-
+        az apim api release delete --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId
+"""
+
+helps['apim api revision list'] = """
+type: command
+short-summary: Lists all revisions of an API.
+examples:
+  - name: Lists all revisions of an API.
+    text: |-
+        az apim api revision list --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId
+"""
+
+helps['apim api revision create'] = """
+type: command
+short-summary: Create API revision.
+examples:
+  - name: Create a revision for the specfic API.
+    text: |-
+        az apim api revision create --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --api-revision RevisionNumber --api-revision-description RevisionDescription
+"""
+
+helps['apim api versionset list'] = """
+type: command
+short-summary: Lists a collection of API Version Sets in the specified service instance.
+examples:
+  - name: Lists a collection of API Version Sets in the specified service instance.
+    text: |-
+        az apim api versionset list --resource-group MyResourceGroup --service-name MyServiceName
+"""
+
+helps['apim api versionset show'] = """
+type: command
+short-summary: Gets the details of the Api Version Set specified by its identifier.
+examples:
+  - name: Gets the details of the Api Version Set specified by its identifier.
+    text: |-
+        az apim api versionset show --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId
+"""
+
+helps['apim api versionset create'] = """
+type: command
+short-summary: Creates a Api Version Set.
+examples:
+  - name: Creates a Api Version Set with version schema as header.
+    text: |-
+        az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Header" --description MyDescription --version-header-name MyHeaderName
+  - name: Creates a Api Version Set with version schema as query.
+    text: |-
+        az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Query" --description MyDescription --version-query-name MyQueryName
+"""
+
+helps['apim api versionset update'] = """
+type: command
+short-summary: Updates the details of the Api VersionSet specified by its identifier.
+examples:
+  - name: Updates the description, display-name of the Api VersionSet specified by its identifier.
+    text: |-
+        az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyNewDisplayName --description MyNewDescription
+  - name: Updates the version schema of the Api VersionSet specified by its identifier.
+    text: |-
+        az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --versioning-scheme "Query" --version-query-name MyNewQueryName
+"""
+
+helps['apim api versionset delete'] = """
+type: command
+short-summary: Deletes specific Api Version Set.
+examples:
+  - name: Deletes specific Api Version Set.
+    text: |-
+        az apim api versionset delete --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId
+"""