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

Commit c027e14

Browse files
authored
[Readme] Add "mutipleAPIs", "includeAllRevisions" (#294)
1 parent b7f4bed commit c027e14

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

src/APIM_ARMTemplate/README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,9 +308,14 @@ az account set --subscription <subscription_id>
308308
| policyXMLBaseUrl | No | Policy XML files remote location. If provided, Extractor generates policies folder with xml files, and requires they be pushed to remote location. |
309309
| 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 |
310310
| 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 |
311+
| mutipleAPIs | No | Specify multiple APIs to extract. Generate templates for each API, also generate an aggregated templates folder to deploy these APIs together at a time |
312+
| includeAllRevisions | No | Set to "true" will extract all revisions for the single API. Will work only with "apiName" paramter, where you specify which API's revisions to extract. Generate templates for each revision, also generate an aggregated master folder to deploy these revisions together at one time. Note: there are many complicated issues with deploying revisions, make sure your deployment won't overwrite or break the existing ones |
313+
311314

312315
#### Note
313-
* You can not use "splitAPIs" and "apiName" at the same time, since using "apiName" only extract one API
316+
* Can not use "splitAPIs" and "apiName" at the same time, since using "apiName" only extract one API
317+
* Can not use "apiName" and "mutipleAPIs" at the same time
318+
* Can only "includeAllRevisions" with "apiName"
314319
### Extractor Parameter Example
315320
In **extractorparams.json** file (path: src/APIM_ARMTemplate/extractorparams.json) <br />
316321
Executing **a single API extraction with linked templates and policy file** generation, use the following parameters:
@@ -360,6 +365,31 @@ Extract **all APIs within an apiversionset**, use the following parameters:
360365
"apiVersionSetName": "<api-version-set-name>"
361366
}
362367
```
368+
Extract **single API with all revisions**, use the following parameters:
369+
```
370+
{
371+
"sourceApimName": "<source-apim-name>",
372+
"destinationApimName": "<destination-apim-name>",
373+
"resourceGroup": "<resource-group>",
374+
"fileFolder": "<destination-file-folder>",
375+
"linkedTemplatesBaseUrl": "<linked_templates_remote_location>",
376+
"policyXMLBaseUrl": "<policies_remote_location>",
377+
"apiName": "<api_name>",
378+
"includeAllRevisions": "true"
379+
}
380+
```
381+
Extract **multiple APIs**, use the following parameters:
382+
```
383+
{
384+
"sourceApimName": "<source-apim-name>",
385+
"destinationApimName": "<destination-apim-name>",
386+
"resourceGroup": "<resource-group>",
387+
"fileFolder": "<destination-file-folder>",
388+
"linkedTemplatesBaseUrl": "<linked_templates_remote_location>",
389+
"policyXMLBaseUrl": "<policies_remote_location>",
390+
"mutipleAPIs": "api1, api2, api3"
391+
}
392+
```
363393

364394
#### Run the extractor
365395
```

0 commit comments

Comments
 (0)