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

Commit 53806c5

Browse files
authored
Update README.md (#330)
1 parent 287051b commit 53806c5

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

src/APIM_ARMTemplate/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ The utility requires one argument, --configFile, which points to a yaml file tha
3535
| linkedTemplatesUrlQueryString| string | No | Query string appended to linked templates uris that enables retrieval from private storage. |
3636
| tags | Array<[TagConfiguration](#tagConfiguration)> | No | List of Tags configurations. |
3737
| subscriptionKeyParameterNames | APITemplateSubscriptionKeyParameterNames | No | subscription key parameter name. |
38+
| baseFileName | string | No | base file name for the templates file |
3839

3940
#### APIConfiguration
4041

@@ -257,6 +258,7 @@ outputLocation: C:\Users\myUsername\GeneratedTemplates
257258
linked: false
258259
linkedTemplatesBaseUrl : https://mystorageaccount.blob.core.windows.net/mycontainer
259260
linkedTemplatesUrlQueryString : ?sv=2018-03-28&ss=bfqt&srt=sco&sp=rwdlacup&se=2019-12-22T23:12:53Z&st=2019-09-09T14:12:53Z&spr=https&sig=uFTldJEYPH888QVzKb7q7eLq0Xt%2Bu35UTqpFGUYo6uc%3D
261+
baseFileName: baseName
260262
```
261263

262264
<a name="creator2"></a>
@@ -315,6 +317,7 @@ You have two choices when specifying your settings:
315317
| 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 |
316318
| 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 |
317319
| 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 |
320+
| baseFileName | No | Specify base file name of the templates file |
318321

319322

320323
#### Note
@@ -397,6 +400,19 @@ Extract **multiple APIs**, use the following parameters:
397400
"mutipleAPIs": "api1, api2, api3"
398401
}
399402
```
403+
Extract **single API with baseFileName**, use the following parameters:
404+
```
405+
{
406+
"sourceApimName": "<source-apim-name>",
407+
"destinationApimName": "<destination-apim-name>",
408+
"resourceGroup": "<resource-group>",
409+
"fileFolder": "<destination-file-folder>",
410+
"linkedTemplatesBaseUrl": "<linked_templates_remote_location>",
411+
"policyXMLBaseUrl": "<policies_remote_location>",
412+
"apiName": "<api_name>",
413+
"baseFileName": "<base_file_name>"
414+
}
415+
```
400416

401417
#### Run the extractor
402418
```

0 commit comments

Comments
 (0)