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

Commit 440fb9f

Browse files
authored
Add "--apiVersionSetName" option to extractor (#275)
1 parent 11d0495 commit 440fb9f

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/APIM_ARMTemplate/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -293,6 +293,7 @@ az account set --subscription <subscription_id>
293293
| linkedTemplatesUrlQueryString | No | String | Query string appended to linked templates uris that enables retrieval from private storage. |
294294
| policyXMLBaseUrl | No | Policy XML files remote location. If provided, Extractor generates policies folder with xml files, and requires they be pushed to remote location. |
295295
| splitAPIs | No | If set to "true", then generate multiple api folders, each api will have a seperate folder, with a separate master template to deploy this api. If this single api has a version set, then a version set folder will generate instead, then all apis that belongs to this version set will be included in the version set folder, apis in this version set can be deployed separately using every api's master template, or they can be deployed together using the master template in "VersionSetMasterFolder" folder |
296+
| apiVersionSetName | No | Name of the APIVersionSet. If provided, extract all apis within this apiversionset. It will generate seperate folder for each api and also a master folder to link all apis in this apiversionset |
296297

297298
#### Note
298299
* You can not use "--splitAPIs" and "--apiName" at the same time, since using "--apiName" only extract one API
@@ -309,5 +310,9 @@ Extract **all APIs with seperated api folders**, use the following command:
309310
```
310311
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> --linkedTemplatesBaseUrl <linked_templates_remote_location> --policyXMLBaseUrl <policies_remote_location> --splitAPIs true
311312
```
313+
Extract **all APIs within an apiversionset**, use the following command:
314+
```
315+
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> --linkedTemplatesBaseUrl <linked_templates_remote_location> --policyXMLBaseUrl <policies_remote_location> --apiVersionSetName "Echo API"
316+
```
312317

313318
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)