Skip to content
This repository was archived by the owner on Feb 23, 2024. It is now read-only.

Commit b1c045e

Browse files
committed
extractor readme
1 parent 65a5665 commit b1c045e

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

src/APIM_ARMTemplate/README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -262,13 +262,22 @@ Below are the steps to run the Extractor from the source code:
262262
az login
263263
az account set --subscription <subscription_id>
264264
```
265-
- Run the Extractor with the following command to extract a single API:
266-
```
267-
dotnet run extract --name <name_of_the_APIM_instance> --resourceGroup <name_of_resource_group> --fileFolder <path_to_folder> --apiName <api_name>
268-
```
269-
- Or run the Extractor with the following command to extract all APIs:
265+
266+
#### Extractor Arguments
267+
268+
| Property | Required | Value |
269+
|-----------------------|-----------------------|---------------------------------------------------|
270+
| sourceApimName | Yes | Name of the source APIM instance. |
271+
| destinationApimName | Yes | Name of the destination APIM instance. |
272+
| resourceGroup | Yes | Name of the resource group. |
273+
| fileFolder | Yes | Path to output folder |
274+
| apiName | No | Name of API. If provided, Extractor executes single API extraction. Otherwise, Extractor executes full extraction. |
275+
| linkedTemplatesBaseUrl| No | Linked templates remote location. If provided, Extractor generates master template and requires linked templates pushed to remote location. |
276+
| policyXMLBaseUrl | No | Policy XML files remote location. If provided, Extractor generates policies folder with xml files, and requires they be pushed to remote location. |
277+
278+
To run the Extractor with all arguments (executing a single API extraction with linked templates and policy file generation), use the following command:
270279
```
271-
dotnet run extract --name <name_of_the_APIM_instance> --resourceGroup <name_of_resource_group> --fileFolder <path_to_folder>
280+
dotnet run extract --sourceApimName <name_of_the_source_APIM_instance> --destinationApimName <name_of_the_destination_APIM_instance> --resourceGroup <name_of_resource_group> --fileFolder <path_to_folder> --apiName <api_name> --linkedTemplatesBaseUrl <linked_templates_remote_location> --policyXMLBaseUrl <policies_remote_location>
272281
```
273282

274283
You can also run it directly from the [releases](https://github.com/Azure/azure-api-management-devops-resource-kit/releases).

0 commit comments

Comments
 (0)