Merge pull request #279653 from dlepow/cliext

denrea · web-flow · commit ceee11af7ab2 · 2024-07-03T11:25:02.000-07:00
[APIC] CLI updates
diff --git a/articles/api-center/enable-api-analysis-linting.md b/articles/api-center/enable-api-analysis-linting.md
@@ -3,7 +3,7 @@ title: Perform API linting and analysis - Azure API Center
 description: Configure linting of API definitions in your API center to analyze compliance of APIs with the organization's API style guide.
 ms.service: api-center
 ms.topic: how-to
-ms.date: 04/22/2024
+ms.date: 06/29/2024
 ms.author: danlep
 author: dlepow
 ms.custom: devx-track-azurecli
@@ -169,13 +169,13 @@ Now that the managed identity is enabled, assign it the Azure API Center Complia
 
     ```azurecli
     #! /bin/bash
-    apicID=$(az apic service show --name <apic-name> --resource-group <resource-group-name> \
+    apicID=$(az apic show --name <apic-name> --resource-group <resource-group-name> \
         --query "id" --output tsv)
     ```
 
     ```azurecli
     # PowerShell syntax
-    $apicID=$(az apic service show --name <apic-name> --resource-group <resource-group-name> `
+    $apicID=$(az apic show --name <apic-name> --resource-group <resource-group-name> `
         --query "id" --output tsv)
     ```
 
@@ -231,13 +231,13 @@ Now create an event subscription in your API center to trigger the function app
 
     ```azurecli
     #! /bin/bash
-    apicID=$(az apic service show --name <apic-name> --resource-group <resource-group-name> \
+    apicID=$(az apic show --name <apic-name> --resource-group <resource-group-name> \
         --query "id" --output tsv)
     ```
 
     ```azurecli
     # PowerShell syntax
-    $apicID=$(az apic service show --name <apic-name> --resource-group <resource-group-name> `
+    $apicID=$(az apic show --name <apic-name> --resource-group <resource-group-name> `
         --query "id" --output tsv)
     ```
 1. Get the resource ID of the function in the function app. In this example, the function name is *apicenter-analyzer*. Substitute `<function-app-name>` and `<resource-group-name>` with your function app name and resource group name.
diff --git a/articles/api-center/import-api-management-apis.md b/articles/api-center/import-api-management-apis.md
@@ -4,7 +4,7 @@ description: Add APIs to your Azure API center inventory from your API Managemen
 author: dlepow
 ms.service: api-center
 ms.topic: how-to
-ms.date: 04/30/2024
+ms.date: 06/28/2024
 ms.author: danlep 
 ms.custom: devx-track-azurecli
 # Customer intent: As an API program manager, I want to add APIs that are managed in my Azure API Management instance to my API center.
@@ -22,12 +22,10 @@ This article shows two options for using the Azure CLI to add APIs to your API c
     * Run [az apic api register](/cli/azure/apic/api#az-apic-api-register) to register a new API in your API center.
     * Run [az apic api definition import-specification](/cli/azure/apic/api/definition#az-apic-api-definition-import-specification) to import the API definition to an existing API.
 
-* **Option 2** - Import APIs directly from API Management to your API center using the [az apic service import-from-apim](/cli/azure/apic/service#az-apic-service-import-from-apim) command.
+* **Option 2** - Import APIs directly from API Management to your API center using the [az apic import-from-apim](/cli/azure/apic/az-apic-import-from-apim) command.
     
 After importing API definitions or APIs from API Management, you can add metadata and documentation in your API center to help stakeholders discover, understand, and consume the API.
 
-> [!VIDEO https://www.youtube.com/embed/SuGkhuBUV5k]
-
 ## Prerequisites
 
 * An API center in your Azure subscription. If you haven't created one, see [Quickstart: Create your API center](set-up-api-center.md).
@@ -50,7 +48,7 @@ First, export an API from your API Management instance to an API definition usin
 
 ### Export API to a local API definition file
 
-The following example command exports the API with identifier *my-api* in the *myAPIManagement* instance of API. The API is exported in OpenApiJson format to a local OpenAPI definition file named *specificationFile.json*. 
+The following example command exports the API with identifier *my-api* in the *myAPIManagement* instance of API. The API is exported in OpenApiJson format to a local OpenAPI definition file at the path you specify. 
 
 ```azurecli
 #! /bin/bash
@@ -90,7 +88,7 @@ You can register a new API in your API center from the exported definition by us
 The following example registers an API in the *myAPICenter* API center from a local OpenAPI definition file named *definitionFile.json*.
 
 ```azurecli
-az apic api register --resource-group myResourceGroup --service myAPICenter --api-location "/path/to/definitionFile.json"
+az apic api register --resource-group myResourceGroup --service-name myAPICenter --api-location "/path/to/definitionFile.json"
 ```
 
 ### Import API definition to an existing API in your API center
@@ -102,7 +100,7 @@ This example assumes you have an API named *my-api* and an associated API versio
 ```azurecli
 #! /bin/bash
 az apic api definition import-specification \
-    --resource-group myResourceGroup --service myAPICenter \
+    --resource-group myResourceGroup --service-name myAPICenter \
     --api-id my-api --version-id v1-0-0 \
     --definition-id openapi --format "link" --value '$link' \
     --specification '{"name":"openapi","version":"3.0.2"}'
@@ -111,17 +109,17 @@ az apic api definition import-specification \
 ```azurecli
 # PowerShell syntax
 az apic api definition import-specification `
-    --resource-group myResourceGroup --service myAPICenter `
+    --resource-group myResourceGroup --service-name myAPICenter `
     --api-id my-api --version-id v1-0-0 `
     --definition-id openapi --format "link" --value '$link' `
     --specification '{"name":"openapi","version":"3.0.2"}'
 ```
 
 ## Option 2: Import APIs directly from your API Management instance
 
-The following are steps to import APIs from your API Management instance to your API center using the [az apic service import-from-apim](/cli/azure/apic/service#az-apic-service-import-from-apim) command. This command is useful when you want to import multiple APIs from API Management to your API center, but you can also use it to import a single API.
+The following are steps to import APIs from your API Management instance to your API center using the [az apic import-from-apim](/cli/azure/apic#az-apic-service-import-from-apim) command. This command is useful when you want to import multiple APIs from API Management to your API center, but you can also use it to import a single API.
 
-When you add APIs from an API Management instance to your API center using `az apic service import-from-apim`, the following happens automatically:
+When you add APIs from an API Management instance to your API center using `az apic import-from-apim`, the following happens automatically:
     
 * Each API's [versions](key-concepts.md#api-version), [definitions](key-concepts.md#api-definition), and [deployment](key-concepts.md#deployment) information are copied to your API center.
 * The API receives a system-generated API name in your API center. It retains its display name (title) from API Management.
@@ -143,10 +141,10 @@ The following examples show how to configure a system-assigned managed identity
 
 #### [Azure CLI](#tab/cli)
 
-Set the system-assigned identity in your API center using the following [az apic service update](/cli/azure/apic/service#az-apic-service-update) command. Substitute the names of your API center and resource group:
+Set the system-assigned identity in your API center using the following [az apic update](/cli/azure/apic#az-apic-update) command. Substitute the names of your API center and resource group:
 
 ```azurecli 
-az apic service update --name <api-center-name> --resource-group <resource-group-name> --identity '{"type": "SystemAssigned"}'
+az apic update --name <api-center-name> --resource-group <resource-group-name> --identity '{"type": "SystemAssigned"}'
 ```
 ---
 
@@ -167,18 +165,18 @@ To allow import of APIs, assign your API center's managed identity the **API Man
 
 #### [Azure CLI](#tab/cli)
 
-1. Get the principal ID of the identity. For a system-assigned identity, use the [az apic service show](/cli/azure/apic/service#az-apic-service-show) command. 
+1. Get the principal ID of the identity. For a system-assigned identity, use the [az apic show](/cli/azure/apic#az-apic-show) command. 
 
     ```azurecli
     #! /bin/bash
-    apicObjID=$(az apic service show --name <api-center-name> \
+    apicObjID=$(az apic show --name <api-center-name> \
         --resource-group <resource-group-name> \
         --query "identity.principalId" --output tsv)
     ```
 
     ```azurecli
     # PowerShell syntax
-    $apicObjID=$(az apic service show --name <api-center-name> `
+    $apicObjID=$(az apic show --name <api-center-name> `
         --resource-group <resource-group-name> `
         --query "identity.principalId" --output tsv)
     ```
@@ -221,7 +219,7 @@ To allow import of APIs, assign your API center's managed identity the **API Man
 
 ### Import APIs from API Management
 
-Use the [az apic service import-from-apim](/cli/azure/apic/service#az-apic-service-import-from-apim) command to import one or more APIs from your API Management instance to your API center. 
+Use the [az apic import-from-apim](/cli/azure/apic#az-apic-import-from-apim) command to import one or more APIs from your API Management instance to your API center. 
 
 > [!NOTE]
 > * This command depends on a managed identity configured in your API center that has read permissions to the API Management instance. If you haven't added or configured a managed identity, see [Add a managed identity in your API center](#add-a-managed-identity-in-your-api-center) earlier in this article.
@@ -230,53 +228,48 @@ Use the [az apic service import-from-apim](/cli/azure/apic/service#az-apic-servi
 
 #### Import all APIs from an API Management instance
 
-Use a wildcard (`*`) to specify all APIs from the API Management instance. 
-
-1. Get the resource ID of your API Management instance using the [az apim show](/cli/azure/apim#az-apim-show) command.
+In the following command, substitute the names of your API center, your API center's resource group, your API Management instance, and your instance's resource group. Use `*` to specify all APIs from the API Management instance.
 
-    ```azurecli
-    #! /bin/bash
-    apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query id --output tsv)
-    ```
-
-    ```azurecli
-    # PowerShell syntax
-    $apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query id --output tsv)
-    ```
-    
-1. Use the `az apic service import-from-apim` command to import the APIs. Substitute the names of your API center and resource group, and use `*` to specify all APIs from the API Management instance.
+```azurecli
+#! /bin/bash
+az apic import-from-apim --service-name <api-center-name> --resource-group <resource-group-name> \
+    --apim-name <api-management-name> --apim-resource-group <api-management-resource-group-name> \
+    --apim-apis '*'  
+```
 
-    ```azurecli
-    az apic service import-from-apim --service-name <api-center-name> --resource-group <resource-group-name> --source-resource-ids $apimID/apis/*  
-    ```
+```azurecli
+# PowerShell syntax
+az apic import-from-apim --service-name <api-center-name> --resource-group <resource-group-name> `
+    --apim-name <api-management-name> --apim-resource-group <api-management-resource-group-name> `
+    --apim-apis '*'  
+```
 
-    > [!NOTE]
-    > If your API Management instance has a large number of APIs, import to your API center might take some time.
+> [!NOTE]
+> If your API Management instance has a large number of APIs, import to your API center might take some time.
     
 #### Import a specific API from an API Management instance
 
 Specify an API to import using its name from the API Management instance. 
 
-1. Get the resource ID of your API Management instance using the [az apim show](/cli/azure/apim#az-apim-show) command.
+In the following command, substitute the names of your API center, your API center's resource group, your API Management instance, and your instance's resource group. Pass an API name such as `petstore-api` using the `--apim-apis` parameter. 
 
-    ```azurecli
-    #! /bin/bash
-    apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query id --output tsv)
-    ```
+```azurecli
+#! /bin/bash
+import-from-apim --service-name <api-center-name> --resource-group <resource-group-name> \
+    --apim-name <api-management-name> --apim-resource-group <api-management-resource-group-name> \
+    --apim-apis 'petstore-api'        
+```
 
-    ```azurecli
-    # PowerShell syntax
-    $apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query id --output tsv)
-    ```
-    
-1. Use the `az apic service import-from-apim` command to import the API. Substitute the names of your API center and resource group, and specify an API name from the API Management instance.
 
-    ```azurecli
-    az apic service import-from-apim --service-name <api-center-name> --resource-group <resource-group-name> --source-resource-ids $apimID/apis/<api-name>    
-    ```
-    
-    > [!NOTE]
-    > Specify `<api-name>` using the API resource name in the API Management instance, not the display name. Example: `petstore-api` instead of `Petstore API`.
+```azurecli
+# PowerShell syntax
+import-from-apim --service-name <api-center-name> --resource-group <resource-group-name> `
+    --apim-name <api-management-name> --apim-resource-group <api-management-resource-group-name> `
+    --apim-apis 'petstore-api'    
+```
+
+> [!NOTE]
+> Specify an API name using the API resource name in the API Management instance, not the display name. Example: `petstore-api` instead of `Petstore API`.
     
 After importing APIs from API Management, you can view and manage the imported APIs in your API center.
 
diff --git a/articles/api-center/includes/install-apic-extension.md b/articles/api-center/includes/install-apic-extension.md
@@ -13,3 +13,5 @@ ms.custom: Include file
 
 > [!NOTE]
 > `az apic` commands require the `apic-extension` Azure CLI extension. If you haven't used `az apic` commands, the extension can be installed dynamically when you run your first `az apic` command, or you can install the extension manually. Learn more about [Azure CLI extensions](/cli/azure/azure-cli-extensions-overview).
+>
+> See the [release notes](https://github.com/Azure/azure-cli-extensions/blob/main/src/apic-extension/HISTORY.rst) for the latest changes and updates in the `apic-extension`.
diff --git a/articles/api-center/manage-apis-azure-cli.md b/articles/api-center/manage-apis-azure-cli.md
@@ -5,7 +5,7 @@ author: dlepow
 ms.service: api-center
 ms.custom: devx-track-azurecli
 ms.topic: how-to
-ms.date: 04/30/2024
+ms. date: 06/28/2024
 ms.author: danlep 
 # Customer intent: As an API program manager, I want to automate processes to register and update APIs in my Azure API center.
 ---
@@ -14,8 +14,6 @@ ms.author: danlep
 
 This article shows how to use [`az apic api`](/cli/azure/apic/api) commands in the Azure CLI to add and configure APIs in your [API center](overview.md) inventory. Use commands in the Azure CLI to script operations to manage your API inventory and other aspects of your API center.  
 
-> [!VIDEO https://www.youtube.com/embed/Dvar8Dg25s0]
-
 ## Prerequisites
 
 * An API center in your Azure subscription. If you haven't created one already, see [Quickstart: Create your API center](set-up-api-center.md).
@@ -37,7 +35,7 @@ The following example creates an API named *Petstore API* in the *myResourceGrou
 
 ```azurecli-interactive
 az apic api create  --resource-group myResourceGroup \
-    --service myAPICenter --api-id petstore-api \
+    --service-name myAPICenter --api-id petstore-api \
     --title "Petstore API" --type "rest"
 ```
 
@@ -53,7 +51,7 @@ The following example creates an API version named *v1-0-0* for the *petstore-ap
 
 ```azurecli-interactive
 az apic api version create --resource-group myResourceGroup \
-    --service myAPICenter --api-id petstore-api \
+    --service-name myAPICenter --api-id petstore-api \
     --version-id v1-0-0 --title "v1-0-0" --lifecycle-stage "testing"
 ```
 
@@ -67,7 +65,7 @@ The following example uses the [az apic api definition create](/cli/azure/apic/a
 
 ```azurecli-interactive
 az apic api definition create --resource-group myResourceGroup \
-    --service myAPICenter --api-id petstore-api \
+    --service-name myAPICenter --api-id petstore-api \
     --version-id v1-0-0 --definition-id openapi --title "OpenAPI"
 ```
 
@@ -80,7 +78,7 @@ The following example imports an OpenAPI specification file from a publicly acce
 
 ```azurecli-interactive
 az apic api definition import-specification \
-    --resource-group myResourceGroup --service myAPICenter \
+    --resource-group myResourceGroup --service-name myAPICenter \
     --api-id petstore-api --version-id v1-0-0 \
     --definition-id openapi --format "link" \
     --value 'https://petstore3.swagger.io/api/v3/openapi.json' \
@@ -98,7 +96,7 @@ The following example exports the specification file from the *openapi* definiti
 
 ```azurecli-interactive
 az apic api definition export-specification \
-    --resource-group myResourceGroup --service myAPICenter \
+    --resource-group myResourceGroup --service-name myAPICenter \
     --api-id petstore-api --version-id v1-0-0 \
     --definition-id openapi --file-name "/Path/to/specificationFile.json"
 ```
@@ -112,7 +110,7 @@ The following example registers an API in the *myAPICenter* API center from a lo
 
 ```azurecli-interactive
 az apic api register --resource-group myResourceGroup \
-    --service myAPICenter --api-location "/Path/to/specificationFile.json"
+    --service-name myAPICenter --api-location "/Path/to/specificationFile.json"
 ```
 
 * The command sets the API properties such as name and type from values in the definition file. 
@@ -127,7 +125,7 @@ Use the [az apic api delete](/cli/azure/apic/api#az_apic_api_delete) command to
 
 ```azurecli-interactive
 az apic api delete \
-    --resource-group myResoureGroup --service myAPICenter \
+    --resource-group myResoureGroup --service-name myAPICenter \
     --api-id petstore-api
 ```
 
diff --git a/articles/api-center/set-up-api-center-azure-cli.md b/articles/api-center/set-up-api-center-azure-cli.md
@@ -5,7 +5,7 @@ author: dlepow
 ms.service: api-center
 ms.custom: devx-track-azurecli
 ms.topic: quickstart
-ms.date: 04/19/2024
+ms.daate: 06/27/2024
 ms.author: danlep 
 ---
 
@@ -48,12 +48,12 @@ az group create --name MyGroup --location eastus
 
 ## Create an API center
 
-Create an API center using the [`az apic service create`](/cli/azure/apic/service#az-apic-service-create) command. 
+Create an API center using the [`az apic create`](/cli/azure/apic/#az-apic-create) command. 
 
 The following example creates an API center called *MyApiCenter* in the *MyGroup* resource group. In this example, the API center is deployed in the *West Europe* location. Substitute an API center name of your choice and enter one of the [available locations](overview.md#available-regions) for your API center.
 
 ```azurecli-interactive
-az apic service create --name MyApiCenter --resource-group MyGroup --location westeurope
+az apic create --name MyApiCenter --resource-group MyGroup --location westeurope
 ```
 
 Output from the command looks similar to the following. By default, the API center is created in the Free plan.
@@ -65,9 +65,12 @@ Output from the command looks similar to the following. By default, the API cent
   "location": "westeurope",
   "name": "myapicenter",
   "resourceGroup": "mygroup",
+  "sku": {
+    "name": "Free"
+  },
   "systemData": {
-    "createdAt": "2024-04-22T21:40:35.2541624Z",
-    "lastModifiedAt": "2024-04-22T21:40:35.2541624Z"
+    "createdAt": "2024-06-22T21:40:35.2541624Z",
+    "lastModifiedAt": "2024-06-22T21:40:35.2541624Z"
   },
   "tags": {},
   "type": "Microsoft.ApiCenter/services"
