Skip to content

Commit 2efc204

Browse files
committed
[APIM] Policy usage updates
1 parent 4b5eea9 commit 2efc204

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+91
-53
lines changed

articles/api-management/authentication-basic-policy.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,13 @@ Use the `authentication-basic` policy to authenticate with a backend service usi
3535
## Usage
3636

3737
- [**Policy sections:**](./api-management-howto-policies.md#sections) inbound
38-
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, product, API, operation
38+
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, workspace, product, API, operation
3939
- [**Gateways:**](api-management-gateways-overview.md) dedicated, consumption, self-hosted
4040

41+
### Usage notes
42+
43+
- This policy can only be used once in a policy section.
44+
4145
## Example
4246

4347
```xml

articles/api-management/authentication-certificate-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ ms.author: danlep
3838
## Usage
3939

4040
- [**Policy sections:**](./api-management-howto-policies.md#sections) inbound
41-
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, product, API, operation
41+
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, workspace, product, API, operation
4242
- [**Gateways:**](api-management-gateways-overview.md) dedicated, consumption, self-hosted
4343

4444
## Examples

articles/api-management/authentication-managed-identity-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Both system-assigned identity and any of the multiple user-assigned identities c
3737
## Usage
3838

3939
- [**Policy sections:**](./api-management-howto-policies.md#sections) inbound
40-
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, product, API, operation
40+
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, workspace, product, API, operation
4141
- [**Gateways:**](api-management-gateways-overview.md) dedicated, consumption, self-hosted
4242

4343
## Examples

articles/api-management/cache-lookup-policy.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,14 @@ Use the `cache-lookup` policy to perform cache lookup and return a valid cached
6161

6262

6363
- [**Policy sections:**](./api-management-howto-policies.md#sections) inbound
64-
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, product, API, operation
64+
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, workspace, product, API, operation
6565
- [**Gateways:**](api-management-gateways-overview.md) dedicated, consumption, self-hosted
6666

6767
### Usage notes
6868

69-
When using `vary-by-query-parameter`, you might want to declare the parameters in the rewrite-uri template or set the attribute `copy-unmatched-params` to `false`. By deactivating this flag, parameters that aren't declared are sent to the backend.
69+
* When using `vary-by-query-parameter`, you might want to declare the parameters in the rewrite-uri template or set the attribute `copy-unmatched-params` to `false`. By deactivating this flag, parameters that aren't declared are sent to the backend.
70+
- This policy can only be used once in a policy section.
71+
7072

7173
## Examples
7274

articles/api-management/cache-lookup-value-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Use the `cache-lookup-value` policy to perform cache lookup by key and return a
4343
## Usage
4444

4545
- [**Policy sections:**](./api-management-howto-policies.md#sections) inbound, outbound, backend, on-error
46-
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, product, API, operation
46+
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, workspace, product, API, operation
4747
- [**Gateways:**](api-management-gateways-overview.md) dedicated, consumption, self-hosted
4848

4949
## Example

articles/api-management/cache-remove-value-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The `cache-remove-value` deletes a cached item identified by its key. The key ca
3232

3333

3434
- [**Policy sections:**](./api-management-howto-policies.md#sections) inbound, outbound, backend, on-error
35-
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, product, API, operation
35+
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, workspace, product, API, operation
3636
- [**Gateways:**](api-management-gateways-overview.md) dedicated, consumption, self-hosted
3737

3838
## Example

articles/api-management/cache-store-policy.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,14 @@ The `cache-store` policy caches responses according to the specified cache setti
3939
## Usage
4040

4141
- [**Policy sections:**](./api-management-howto-policies.md#sections) outbound
42-
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, product, API, operation
42+
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, workspace, product, API, operation
4343
- [**Gateways:**](api-management-gateways-overview.md) dedicated, consumption, self-hosted
4444

45+
### Usage notes
46+
47+
- This policy can only be used once in a policy section.
48+
49+
4550
## Examples
4651

4752
### Example with corresponding cache-lookup policy

articles/api-management/cache-store-value-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The `cache-store-value` performs cache storage by key. The key can have an arbit
4040

4141

4242
- [**Policy sections:**](./api-management-howto-policies.md#sections) inbound, outbound, backend, on-error
43-
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, product, API, operation
43+
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, workspace, product, API, operation
4444
- [**Gateways:**](api-management-gateways-overview.md) dedicated, consumption, self-hosted
4545

4646
## Example

articles/api-management/choose-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The `choose` policy must contain at least one `<when/>` element. The `<otherwise
5151
## Usage
5252

5353
- [**Policy sections:**](./api-management-howto-policies.md#sections) inbound, outbound, backend, on-error
54-
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, product, API, operation
54+
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, workspace, product, API, operation
5555
- [**Gateways:**](api-management-gateways-overview.md) dedicated, consumption, self-hosted
5656

5757
## Examples

articles/api-management/cors-policy.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,12 +89,13 @@ The `cors` policy adds cross-origin resource sharing (CORS) support to an operat
8989
## Usage
9090

9191
- [**Policy sections:**](./api-management-howto-policies.md#sections) inbound
92-
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, product, API, operation
92+
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, workspace, product, API, operation
9393
- [**Gateways:**](api-management-gateways-overview.md) dedicated, consumption, self-hosted
9494

9595
### Usage notes
9696
* You may configure the `cors` policy at more than one scope (for example, at the product scope and the global scope). Ensure that the `base` element is configured at the operation, API, and product scopes to inherit needed policies at the parent scopes.
9797
* Only the `cors` policy is evaluated on the `OPTIONS` request during preflight. Remaining configured policies are evaluated on the approved request.
98+
- This policy can only be used once in a policy section.
9899

99100
## About CORS
100101

0 commit comments

Comments
 (0)