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

Commit b6b9073

Browse files
authored
Update README.md (#331)
1 parent 53806c5 commit b6b9073

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

src/APIM_ARMTemplate/README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,11 @@ You have two choices when specifying your settings:
317317
| 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 |
318318
| 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 |
319319
| 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 |
320+
| baseFileName | No | Specify base file name of the template files |
321+
| policyXMLSasToken | No | Specify sasToken for fetching policy files |
322+
| linkedTemplatesSasToken | No | Specify sasToken for fetching linkedTemplate files |
323+
| serviceUrlParameters | No | Parameterize service url in advance (you can replace serviceUrl afterwards as well, you can refer example for more information). |
324+
| paramServiceUrl | No | Set to "true" will parameterize all serviceUrl for each api and generate serviceUrl parameter in apiTemplate/parameter/masterTemplate files |
321325

322326

323327
#### Note
@@ -413,6 +417,39 @@ Extract **single API with baseFileName**, use the following parameters:
413417
"baseFileName": "<base_file_name>"
414418
}
415419
```
420+
Extract **all APIs with serviceUrlParameters**, use the following parameters:
421+
```
422+
{
423+
"sourceApimName": "<source-apim-name>",
424+
"destinationApimName": "<destination-apim-name>",
425+
"resourceGroup": "<resource-group>",
426+
"fileFolder": "<destination-file-folder>",
427+
"linkedTemplatesBaseUrl": "<linked_templates_remote_location>",
428+
"policyXMLBaseUrl": "<policies_remote_location>",
429+
"serviceUrlParameters": [
430+
{
431+
"apiName": "test",
432+
"serviceUrl": "http://url.com"
433+
},
434+
{
435+
"apiName": "api2",
436+
"serviceUrl": "http://url2.com"
437+
}
438+
]
439+
}
440+
```
441+
Extract **all APIs within parameterServiceUrl**, use the following parameters:
442+
```
443+
{
444+
"sourceApimName": "<source-apim-name>",
445+
"destinationApimName": "<destination-apim-name>",
446+
"resourceGroup": "<resource-group>",
447+
"fileFolder": "<destination-file-folder>",
448+
"linkedTemplatesBaseUrl": "<linked_templates_remote_location>",
449+
"policyXMLBaseUrl": "<policies_remote_location>",
450+
"paramServiceUrl": "true"
451+
}
452+
```
416453

417454
#### Run the extractor
418455
```

0 commit comments

Comments
 (0)