Merge pull request #198282 from schaffererin/acrp-reference-docs

Edits to ACRP docs - Reference

Author: tamarakhader

articles/azure-resource-manager/custom-providers/proxy-cache-resource-endpoint-reference.md

@@ -4,18 +4,18 @@ description: Custom resource cache reference for Azure Custom Resource Providers
 ms.topic: conceptual
 ms.author: jobreen
 author: jjbfour
-ms.date: 06/20/2019
+ms.date: 05/13/2022
 ---
 
-# Custom Resource Cache Reference
+# Custom resource cache reference
 
-This article will go through the requirements for endpoints implementing cache custom resources. If you are unfamiliar with Azure Custom Resource Providers, see [the overview on custom resource providers](overview.md).
+This article will go through the requirements for endpoints implementing cache custom resources. If you're unfamiliar with Azure Custom Resource Providers, see [the overview on custom resource providers](overview.md).
 
-## How to define a cache resource endpoint
+## Define a cache resource endpoint
 
-A proxy resource can be created by specifying the **routingType** to "Proxy, Cache".
+A proxy resource can be created by specifying the `routingType` to "Proxy, Cache".
 
-Sample custom resource provider:
+**Sample custom resource provider**:
 
 ```JSON
 {
@@ -35,17 +35,17 @@ Sample custom resource provider:
 }
 ```
 
-## Building proxy resource endpoint
+## Build a proxy resource endpoint
 
-An **endpoint** that implements a "Proxy, Cache" resource **endpoint** must handle the request and response for the new API in Azure. In this case, the **resourceType** will generate a new Azure resource API for `PUT`, `GET`, and `DELETE` to perform CRUD on a single resource, as well as `GET` to retrieve all existing resources:
+An endpoint that implements a "Proxy, Cache" resource endpoint must handle the request and response for the new API in Azure. In this case, the **resourceType** will generate a new Azure resource API for `PUT`, `GET`, and `DELETE` to perform CRUD on a single resource, as well as `GET` to retrieve all existing resources.
 
 > [!NOTE]
-> The Azure API will generate the request methods `PUT`, `GET`, and `DELETE`, but the cache **endpoint** only needs to handle `PUT` and `DELETE`.
-> We recommended that the **endpoint** also implements `GET`.
+> The Azure API will generate the request methods `PUT`, `GET`, and `DELETE`, but the cache endpoint only needs to handle `PUT` and `DELETE`.
+> We recommended that the endpoint also implements `GET`.
 
 ### Create a custom resource
 
-Azure API Incoming Request:
+**Azure API incoming request**:
 
 ``` HTTP
 PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}?api-version=2018-09-01-preview
@@ -62,7 +62,7 @@ Content-Type: application/json
 }
 ```
 
-This request will then be forwarded to the **endpoint** in the form:
+This request will then be forwarded to the endpoint in the form:
 
 ``` HTTP
 PUT https://{endpointURL}/?api-version=2018-09-01-preview
@@ -79,14 +79,14 @@ X-MS-CustomProviders-RequestPath: /subscriptions/{subscriptionId}/resourceGroups
 }
 ```
 
-Similarly, the response from the **endpoint** is then forwarded back to the customer. The response from the endpoint should return:
+The response from the endpoint is then forwarded back to the customer. The response should return:
 
 - A valid JSON object document. All arrays and strings should be nested under a top object.
 - The `Content-Type` header should be set to "application/json; charset=utf-8".
 - The custom resource provider will overwrite the `name`, `type`, and `id` fields for the request.
 - The custom resource provider will only return fields under the `properties` object for a cache endpoint.
 
-**Endpoint** Response:
+**Endpoint response**:
 
 ``` HTTP
 HTTP/1.1 200 OK
@@ -104,7 +104,7 @@ Content-Type: application/json; charset=utf-8
 
 The `name`, `id`, and `type` fields will automatically be generated for the custom resource by the custom resource provider.
 
-Azure Custom Resource Provider Response:
+**Azure Custom Resource Provider response**:
 
 ``` HTTP
 HTTP/1.1 200 OK
@@ -125,36 +125,36 @@ Content-Type: application/json; charset=utf-8
 
 ### Remove a custom resource
 
-Azure API Incoming Request:
+**Azure API incoming request**:
 
 ``` HTTP
 Delete https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}?api-version=2018-09-01-preview
 Authorization: Bearer eyJ0e...
 Content-Type: application/json
 ```
 
-This request will then be forwarded to the **endpoint** in the form:
+This request will then be forwarded to the endpoint in the form:
 
 ``` HTTP
 Delete https://{endpointURL}/?api-version=2018-09-01-preview
 Content-Type: application/json
 X-MS-CustomProviders-RequestPath: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}
 ```
 
-Similarly ,the response from the **endpoint** is then forwarded back to the customer. The response from the endpoint should return:
+The response from the endpoint is then forwarded back to the customer. The response should return:
 
 - A valid JSON object document. All arrays and strings should be nested under a top object.
 - The `Content-Type` header should be set to "application/json; charset=utf-8".
-- The Azure Custom Resource Provider will only remove the item from its cache if a 200-level response is returned. Even if the resource does not exist, the **endpoint** should return 204.
+- The Azure Custom Resource Provider will only remove the item from its cache if a 200-level response is returned. Even if the resource doesn't exist, the endpoint should return 204.
 
-**Endpoint** Response:
+**Endpoint response**:
 
 ``` HTTP
 HTTP/1.1 200 OK
 Content-Type: application/json; charset=utf-8
 ```
 
-Azure Custom Resource Provider Response:
+**Azure Custom Resource Provider response**:
 
 ``` HTTP
 HTTP/1.1 200 OK
@@ -163,17 +163,17 @@ Content-Type: application/json; charset=utf-8
 
 ### Retrieve a custom resource
 
-Azure API Incoming Request:
+**Azure API incoming request**:
 
 ``` HTTP
 GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}?api-version=2018-09-01-preview
 Authorization: Bearer eyJ0e...
 Content-Type: application/json
 ```
 
-The request will **not** be forwarded to the **endpoint**.
+The request will **not** be forwarded to the endpoint.
 
-Azure Custom Resource Provider Response:
+Azure Custom Resource Provider response:
 
 ``` HTTP
 HTTP/1.1 200 OK
@@ -194,17 +194,17 @@ Content-Type: application/json; charset=utf-8
 
 ### Enumerate all custom resources
 
-Azure API Incoming Request:
+**Azure API incoming request**:
 
 ``` HTTP
 GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources?api-version=2018-09-01-preview
 Authorization: Bearer eyJ0e...
 Content-Type: application/json
 ```
 
-This request will **not** be forwarded to the **endpoint**.
+The request will **not** be forwarded to the endpoint.
 
-Azure Custom Resource Provider Response:
+**Azure Custom Resource Provider response**:
 
 ``` HTTP
 HTTP/1.1 200 OK

articles/azure-resource-manager/custom-providers/proxy-resource-endpoint-reference.md

@@ -4,18 +4,18 @@ description: Custom resource proxy reference for Azure Custom Resource Providers
 ms.topic: conceptual
 ms.author: jobreen
 author: jjbfour
-ms.date: 06/20/2019
+ms.date: 05/13/2022
 ---
 
-# Custom Resource Proxy Reference
+# Custom resource proxy reference
 
-This article will go through the requirements for endpoints implementing proxy custom resources. If you are unfamiliar with Azure Custom Resource Providers, see [the overview on custom resource providers](overview.md).
+This article will go through the requirements for endpoints implementing proxy custom resources. If you're unfamiliar with Azure Custom Resource Providers, see [the overview on custom resource providers](overview.md).
 
-## How to define a proxy resource endpoint
+## Define a proxy resource endpoint
 
-A proxy resource can be created by specifying the **routingType** to "Proxy".
+A proxy resource can be created by specifying the `routingType` to "Proxy".
 
-Sample custom resource provider:
+### Sample custom resource provider:
 
 ```JSON
 {
@@ -35,14 +35,14 @@ Sample custom resource provider:
 }
 ```
 
-## Building proxy resource endpoint
+## Build a proxy resource endpoint
 
-An **endpoint** that implements a "Proxy" resource **endpoint** must handle the request and response for the new API in Azure. In this case, the **resourceType** will generate a new Azure resource API for `PUT`, `GET`, and `DELETE` to perform CRUD on a single resource, as well as `GET` to retrieve all existing resources.
+An endpoint that implements a "Proxy" resource endpoint must handle the request and response for the new API in Azure. In this case, the #*resourceType** will generate a new Azure resource API for `PUT`, `GET`, and `DELETE` to perform CRUD on a single resource, as well as `GET` to retrieve all existing resources.
 
 > [!NOTE]
-> The `id`, `name`, and `type` fields are not required, but are needed to integrate the custom resource with existing Azure ecosystem.
+> The `id`, `name`, and `type` fields are not required, but they're needed to integrate the custom resource with an existing Azure ecosystem.
 
-Sample resource:
+**Sample resource**:
 
 ``` JSON
 {
@@ -58,7 +58,7 @@ Sample resource:
 }
 ```
 
-Parameter reference:
+**Parameter reference**:
 
 Property | Sample | Description
 ---|---|---
@@ -68,7 +68,7 @@ id | '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/<br>pro
 
 ### Create a custom resource
 
-Azure API Incoming Request:
+**Azure API incoming request**:
 
 ``` HTTP
 PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resource-provider-name}/myCustomResources/{myCustomResourceName}?api-version=2018-09-01-preview
@@ -85,7 +85,7 @@ Content-Type: application/json
 }
 ```
 
-This request will then be forwarded to the **endpoint** in the form:
+This request will then be forwarded to the endpoint in the form:
 
 ``` HTTP
 PUT https://{endpointURL}/?api-version=2018-09-01-preview
@@ -102,12 +102,12 @@ X-MS-CustomProviders-RequestPath: /subscriptions/{subscriptionId}/resourceGroups
 }
 ```
 
-Similarly, the response from the **endpoint** is then forwarded back to the customer. The response from the endpoint should return:
+The response from the endpoint is then forwarded back to the customer. The response should return:
 
 - A valid JSON object document. All arrays and strings should be nested under a top object.
 - The `Content-Type` header should be set to "application/json; charset=utf-8".
 
-**Endpoint** Response:
+**Endpoint response**:
 
 ``` HTTP
 HTTP/1.1 200 OK
@@ -126,7 +126,7 @@ Content-Type: application/json; charset=utf-8
 }
 ```
 
-Azure Custom Resource Provider Response:
+**Azure Custom Resource Provider response**:
 
 ``` HTTP
 HTTP/1.1 200 OK
@@ -147,35 +147,35 @@ Content-Type: application/json; charset=utf-8
 
 ### Remove a custom resource
 
-Azure API Incoming Request:
+**Azure API incoming request**:
 
 ``` HTTP
 Delete https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}?api-version=2018-09-01-preview
 Authorization: Bearer eyJ0e...
 Content-Type: application/json
 ```
 
-This request will then be forwarded to the **endpoint** in the form:
+This request will then be forwarded to the endpoint in the form:
 
 ``` HTTP
 Delete https://{endpointURL}/?api-version=2018-09-01-preview
 Content-Type: application/json
 X-MS-CustomProviders-RequestPath: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}
 ```
 
-Similarly the response from the **endpoint** is then forwarded back to the customer. The response from the endpoint should return:
+The response from the endpoint is then forwarded back to the customer. The response should return:
 
 - Valid JSON object document. All arrays and strings should be nested under a top object.
 - The `Content-Type` header should be set to "application/json; charset=utf-8".
 
-**Endpoint** Response:
+**Endpoint response**:
 
 ``` HTTP
 HTTP/1.1 200 OK
 Content-Type: application/json; charset=utf-8
 ```
 
-Azure Custom Resource Provider Response:
+**Azure Custom Resource Provider response**:
 
 ``` HTTP
 HTTP/1.1 200 OK
@@ -184,28 +184,28 @@ Content-Type: application/json; charset=utf-8
 
 ### Retrieve a custom resource
 
-Azure API Incoming Request:
+**Azure API incoming request**:
 
 ``` HTTP
 GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}?api-version=2018-09-01-preview
 Authorization: Bearer eyJ0e...
 Content-Type: application/json
 ```
 
-This request will then be forwarded to the **endpoint** in the form:
+This request will then be forwarded to the endpoint in the form:
 
 ``` HTTP
 GET https://{endpointURL}/?api-version=2018-09-01-preview
 Content-Type: application/json
 X-MS-CustomProviders-RequestPath: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}
 ```
 
-Similarly, the response from the **endpoint** is then forwarded back to the customer. The response from the endpoint should return:
+The response from the endpoint is then forwarded back to the customer. The response should return:
 
 - A valid JSON object document. All arrays and strings should be nested under a top object.
 - The `Content-Type` header should be set to "application/json; charset=utf-8".
 
-**Endpoint** Response:
+**Endpoint response**:
 
 ``` HTTP
 HTTP/1.1 200 OK
@@ -224,7 +224,7 @@ Content-Type: application/json; charset=utf-8
 }
 ```
 
-Azure Custom Resource Provider Response:
+**Azure Custom Resource Provider response**:
 
 ``` HTTP
 HTTP/1.1 200 OK
@@ -245,29 +245,29 @@ Content-Type: application/json; charset=utf-8
 
 ### Enumerate all custom resources
 
-Azure API Incoming Request:
+**Azure API incoming request**:
 
 ``` HTTP
 GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources?api-version=2018-09-01-preview
 Authorization: Bearer eyJ0e...
 Content-Type: application/json
 ```
 
-This request will then be forwarded to the **endpoint** in the form:
+This request will then be forwarded to the endpoint in the form:
 
 ``` HTTP
 GET https://{endpointURL}/?api-version=2018-09-01-preview
 Content-Type: application/json
 X-MS-CustomProviders-RequestPath: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources
 ```
 
-Similarly, the response from the **endpoint** is then forwarded back to the customer. The response from the endpoint should return:
+The response from the endpoint is then forwarded back to the customer. The response should return:
 
 - A valid JSON object document. All arrays and strings should be nested under a top object.
 - The `Content-Type` header should be set to "application/json; charset=utf-8".
 - The list of resources should be placed under the top-level `value` property.
 
-**Endpoint** Response:
+**Endpoint response**:
 
 ``` HTTP
 HTTP/1.1 200 OK
@@ -290,7 +290,7 @@ Content-Type: application/json; charset=utf-8
 }
 ```
 
-Azure Custom Resource Provider Response:
+**Azure Custom Resource Provider response**:
 
 ``` HTTP
 HTTP/1.1 200 OK

articles/azure-resource-manager/custom-providers/reference-custom-providers-csharp-endpoint.md

@@ -5,7 +5,7 @@ ms.topic: conceptual
 ms.custom: devx-track-csharp
 ms.author: jobreen
 author: jjbfour
-ms.date: 01/14/2021
+ms.date: 05/15/2022
 ---
 
 # Custom provider C# RESTful endpoint reference