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

Commit 79b6ab0

Browse files
committed
add global policy and query string to readme
1 parent 744cc82 commit 79b6ab0

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
@@ -22,6 +22,7 @@ The utility requires one argument, --configFile, which points to a yaml file tha
2222
|-----------------------|-----------------------|-----------------------|--------------------------------------------------|
2323
| version | string | Yes | Configuration version. |
2424
| apimServiceName | string | Yes | Name of the APIM service to deploy resources into. |
25+
| policy | string | No | Location of the global service policy XML file. Can be url or local file. |
2526
| apiVersionSets | Array<[APIVersionSetConfiguration](#APIVersionSetConfiguration)> | No | List of API Version Set configurations. |
2627
| apis | Array<[APIConfiguration](#APIConfiguration)> | Yes | List of API configurations. |
2728
| products | Array<[ProductConfiguration](#ProductConfiguration)> | No | List of Product configurations. |
@@ -31,6 +32,7 @@ The utility requires one argument, --configFile, which points to a yaml file tha
3132
| outputLocation | string | Yes | Local folder the utility will write templates to. |
3233
| linked | boolean | No | Determines whether the utility should create a master template that links to all generated templates. |
3334
| linkedTemplatesBaseUrl| string | No | Location that stores linked templates. Required if 'linked' is set to true. |
35+
| linkedTemplatesUrlQueryString| string | No | Query string appended to linked templates uris that enables retrieval from private storage. |
3436

3537
#### APIConfiguration
3638

@@ -101,6 +103,7 @@ The following is a full config.yml file with each property listed:
101103
```
102104
version: 0.0.1
103105
apimServiceName: myAPIMService
106+
policy: C:\Users\myUsername\Projects\azure-api-management-devops-example\src\APIM_ARMTemplate\apimtemplate\Creator\ExampleFiles\XMLPolicies\globalServicePolicy.xml
104107
apiVersionSets:
105108
- id: myAPIVersionSetID
106109
displayName: swaggerPetstoreVersionSetLinked
@@ -227,6 +230,7 @@ backends:
227230
outputLocation: C:\Users\myUsername\GeneratedTemplates
228231
linked: false
229232
linkedTemplatesBaseUrl : https://mystorageaccount.blob.core.windows.net/mycontainer
233+
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
230234
```
231235

232236
<a name="creator2"></a>
@@ -273,6 +277,7 @@ az account set --subscription <subscription_id>
273277
| fileFolder | Yes | Path to output folder |
274278
| apiName | No | Name of API. If provided, Extractor executes single API extraction. Otherwise, Extractor executes full extraction. Note: This is the "Name" value as seen in the API settings, not "Display Name" and is case sensitive. |
275279
| linkedTemplatesBaseUrl| No | Linked templates remote location. If provided, Extractor generates master template and requires linked templates pushed to remote location. |
280+
| linkedTemplatesUrlQueryString | string | No | Query string appended to linked templates uris that enables retrieval from private storage. |
276281
| policyXMLBaseUrl | No | Policy XML files remote location. If provided, Extractor generates policies folder with xml files, and requires they be pushed to remote location. |
277282

278283
To run the Extractor with all arguments (executing a single API extraction with linked templates and policy file generation), use the following command:

0 commit comments

Comments
 (0)