Skip to content

Commit

Permalink
[Utilities] Ported 2 AVM Updates back to CARML (#4263)
Browse files Browse the repository at this point in the history
* Performance Update 1

* ReadMe Recursion Update

* Generated KeyVault ReadMes for review

* Regenerated docs
  • Loading branch information
AlexanderSehr authored Nov 27, 2023
1 parent 80ff2b7 commit 761f360
Show file tree
Hide file tree
Showing 370 changed files with 26,756 additions and 17,983 deletions.
230 changes: 135 additions & 95 deletions modules/aad/domain-service/README.md

Large diffs are not rendered by default.

203 changes: 108 additions & 95 deletions modules/analysis-services/server/README.md

Large diffs are not rendered by default.

266 changes: 153 additions & 113 deletions modules/api-management/service/README.md

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions modules/api-management/service/api-version-set/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,26 +34,30 @@ This module deploys an API Management Service API Version Set.
### Parameter: `apiManagementServiceName`

The name of the parent API Management service. Required if the template is used in a standalone deployment.

- Required: Yes
- Type: string

### Parameter: `enableDefaultTelemetry`

Enable telemetry via a Globally Unique Identifier (GUID).

- Required: No
- Type: bool
- Default: `True`

### Parameter: `name`

API Version set name.

- Required: No
- Type: string
- Default: `'default'`

### Parameter: `properties`

API Version set properties.

- Required: No
- Type: object
- Default: `{}`
Expand Down
68 changes: 46 additions & 22 deletions modules/api-management/service/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,36 +57,62 @@ This module deploys an API Management Service API.
| [`value`](#parameter-value) | string | Content value when Importing an API. |
| [`wsdlSelector`](#parameter-wsdlselector) | object | Criteria to limit import of WSDL to a subset of the document. |

### Parameter: `apiDescription`
### Parameter: `displayName`

Description of the API. May include HTML formatting tags.
- Required: No
API name. Must be 1 to 300 characters long.

- Required: Yes
- Type: string

### Parameter: `name`

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

- Required: Yes
- Type: string

### Parameter: `path`

Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.

- Required: Yes
- Type: string
- Default: `''`

### Parameter: `apiManagementServiceName`

The name of the parent API Management service. Required if the template is used in a standalone deployment.

- Required: Yes
- Type: string

### Parameter: `apiDescription`

Description of the API. May include HTML formatting tags.

- Required: No
- Type: string
- Default: `''`

### Parameter: `apiRevision`

Describes the Revision of the API. If no value is provided, default revision 1 is created.

- Required: No
- Type: string
- Default: `''`

### Parameter: `apiRevisionDescription`

Description of the API Revision.

- Required: No
- Type: string
- Default: `''`

### Parameter: `apiType`

Type of API to create. * http creates a REST API * soap creates a SOAP pass-through API * websocket creates websocket API * graphql creates GraphQL API.

- Required: No
- Type: string
- Default: `'http'`
Expand All @@ -103,47 +129,47 @@ Type of API to create. * http creates a REST API * soap creates a SOAP pass-thro
### Parameter: `apiVersion`

Indicates the Version identifier of the API if the API is versioned.

- Required: No
- Type: string
- Default: `''`

### Parameter: `apiVersionDescription`

Description of the API Version.

- Required: No
- Type: string
- Default: `''`

### Parameter: `apiVersionSetId`

Indicates the Version identifier of the API version set.

- Required: No
- Type: string
- Default: `''`

### Parameter: `authenticationSettings`

Collection of authentication settings included into this API.

- Required: No
- Type: object
- Default: `{}`

### Parameter: `displayName`

API name. Must be 1 to 300 characters long.
- Required: Yes
- Type: string

### Parameter: `enableDefaultTelemetry`

Enable telemetry via a Globally Unique Identifier (GUID).

- Required: No
- Type: bool
- Default: `True`

### Parameter: `format`

Format of the Content in which the API is getting imported.

- Required: No
- Type: string
- Default: `'openapi'`
Expand All @@ -166,32 +192,23 @@ Format of the Content in which the API is getting imported.
### Parameter: `isCurrent`

Indicates if API revision is current API revision.

- Required: No
- Type: bool
- Default: `True`

### Parameter: `name`

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- Required: Yes
- Type: string

### Parameter: `path`

Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
- Required: Yes
- Type: string

### Parameter: `policies`

Array of Policies to apply to the Service API.

- Required: No
- Type: array
- Default: `[]`

### Parameter: `protocols`

Describes on which protocols the operations in this API can be invoked. - HTTP or HTTPS.

- Required: No
- Type: array
- Default:
Expand All @@ -204,34 +221,39 @@ Describes on which protocols the operations in this API can be invoked. - HTTP o
### Parameter: `serviceUrl`

Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.

- Required: No
- Type: string
- Default: `''`

### Parameter: `sourceApiId`

API identifier of the source API.

- Required: No
- Type: string
- Default: `''`

### Parameter: `subscriptionKeyParameterNames`

Protocols over which API is made available.

- Required: No
- Type: object
- Default: `{}`

### Parameter: `subscriptionRequired`

Specifies whether an API or Product subscription is required for accessing the API.

- Required: No
- Type: bool
- Default: `False`

### Parameter: `type`

Type of API.

- Required: No
- Type: string
- Default: `'http'`
Expand All @@ -248,13 +270,15 @@ Type of API.
### Parameter: `value`

Content value when Importing an API.

- Required: No
- Type: string
- Default: `''`

### Parameter: `wsdlSelector`

Criteria to limit import of WSDL to a subset of the document.

- Required: No
- Type: object
- Default: `{}`
Expand Down
18 changes: 12 additions & 6 deletions modules/api-management/service/api/policy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,28 +38,39 @@ This module deploys an API Management Service API Policy.
| [`format`](#parameter-format) | string | Format of the policyContent. |
| [`name`](#parameter-name) | string | The name of the policy. |

### Parameter: `value`

Contents of the Policy as defined by the format.

- Required: Yes
- Type: string

### Parameter: `apiManagementServiceName`

The name of the parent API Management service. Required if the template is used in a standalone deployment.

- Required: Yes
- Type: string

### Parameter: `apiName`

The name of the parent API. Required if the template is used in a standalone deployment.

- Required: Yes
- Type: string

### Parameter: `enableDefaultTelemetry`

Enable telemetry via a Globally Unique Identifier (GUID).

- Required: No
- Type: bool
- Default: `True`

### Parameter: `format`

Format of the policyContent.

- Required: No
- Type: string
- Default: `'xml'`
Expand All @@ -76,16 +87,11 @@ Format of the policyContent.
### Parameter: `name`

The name of the policy.

- Required: No
- Type: string
- Default: `'policy'`

### Parameter: `value`

Contents of the Policy as defined by the format.
- Required: Yes
- Type: string


## Outputs

Expand Down
Loading

0 comments on commit 761f360

Please sign in to comment.