You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Learn about deploying associations for a custom provider using Azure Policy service.
3
+
description: Learn about deploying associations for a custom resource provider using Azure Policy service.
4
4
author: msHich
5
5
ms.topic: conceptual
6
6
ms.date: 09/06/2019
7
7
ms.author: hich
8
8
---
9
9
10
-
# Deploy associations for a custom provider using Azure Policy
10
+
# Deploy associations for a custom resource provider using Azure Policy
11
11
12
-
Azure policies can be used to deploy associations to associate resources to a custom provider. In this article, we describe a built-in policy that deploys associations and how you can use that policy.
12
+
Azure policies can be used to deploy associations to associate resources to a custom resource provider. In this article, we describe a built-in policy that deploys associations and how you can use that policy.
13
13
14
14
## Built-in policy to deploy associations
15
15
16
-
Deploy associations for a custom provider is a built-in policy that can be used to deploy association to associate a resource to a custom provider. The policy accepts three parameters:
16
+
Deploy associations for a custom resource provider is a built-in policy that can be used to deploy association to associate a resource to a custom resource provider. The policy accepts three parameters:
17
17
18
-
- Custom provider ID - This ID is the resource ID of the custom provider to which the resources need to be associated.
19
-
- Resource types to associate - These resource types are the list of resource types to be associated to the custom provider. You can associate multiple resource types to a custom provider using the same policy.
18
+
- Custom resource provider ID - This ID is the resource ID of the custom resource provider to which the resources need to be associated.
19
+
- Resource types to associate - These resource types are the list of resource types to be associated to the custom resource provider. You can associate multiple resource types to a custom resource provider using the same policy.
20
20
- Association name prefix - This string is the prefix to be added to the name of the association resource being created. The default value is "DeployedByPolicy".
21
21
22
22
The policy uses DeployIfNotExists evaluation. It runs after a Resource Provider has handled a create or update resource request and the evaluation has returned a success status code. After that, the association resource gets deployed using a template deployment.
23
-
For more information on associations, see [Azure Custom Providers resource onboarding](./concepts-resource-onboarding.md)
23
+
For more information on associations, see [Azure Custom Resource Providers resource onboarding](./concepts-resource-onboarding.md)
24
24
25
25
## How to use the deploy associations built-in policy
26
26
27
27
### Prerequisites
28
-
If the custom provider needs permissions to the scope of the policy to perform an action, the policy deployment of association resource wouldn't work without granting the permissions.
28
+
If the custom resource provider needs permissions to the scope of the policy to perform an action, the policy deployment of association resource wouldn't work without granting the permissions.
29
29
30
30
### Policy assignment
31
-
To use the built-in policy, create a policy assignment and assign the Deploy associations for a custom provider policy. The policy will then identify non-compliant resources and deploy association for those resources.
31
+
To use the built-in policy, create a policy assignment and assign the Deploy associations for a custom resource provider policy. The policy will then identify non-compliant resources and deploy association for those resources.
Copy file name to clipboardExpand all lines: articles/azure-resource-manager/custom-providers/concepts-resource-onboarding.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,38 +1,38 @@
1
1
---
2
2
title: Resource onboarding
3
-
description: Learn about performing resource onboarding by using Azure Custom Providers to apply management or configuration to other Azure resource types.
3
+
description: Learn about performing resource onboarding by using Azure Custom Resource Providers to apply management or configuration to other Azure resource types.
Azure Custom Providers resource onboarding is an extensibility model for Azure resource types. It allows you to apply operations or management across existing Azure resources at scale. For more information, see [How Azure Custom Providers can extend Azure](overview.md). This article describes:
12
+
Azure Custom Resource Providers resource onboarding is an extensibility model for Azure resource types. It allows you to apply operations or management across existing Azure resources at scale. For more information, see [How Azure Custom Resource Providers can extend Azure](overview.md). This article describes:
13
13
14
14
- What resource onboarding can do.
15
15
- Resource onboarding basics and how to use it.
16
16
- Where to find guides and code samples to get started.
17
17
18
18
> [!IMPORTANT]
19
-
> Custom Providers is currently in public preview.
19
+
> Custom Resource Providers is currently in public preview.
20
20
> This preview version is provided without a service-level agreement, and we don't recommend it for production workloads. Certain features might be unsupported or might have constrained capabilities.
21
21
> For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
22
22
23
23
## What can resource onboarding do?
24
24
25
-
Similar to [Azure Custom Providers custom resources](./custom-providers-resources-endpoint-how-to.md), resource onboarding defines a contract that will proxy "onboarding" requests to an endpoint. Unlike custom resources, resource onboarding doesn't create a new resource type. Instead, it allows the extension of existing resource types. And resource onboarding works with Azure Policy, so management and configuration of resources can be done at scale. Some examples of resource onboarding workflows:
25
+
Similar to [Azure Custom Resource Providers custom resources](./custom-providers-resources-endpoint-how-to.md), resource onboarding defines a contract that will proxy "onboarding" requests to an endpoint. Unlike custom resources, resource onboarding doesn't create a new resource type. Instead, it allows the extension of existing resource types. And resource onboarding works with Azure Policy, so management and configuration of resources can be done at scale. Some examples of resource onboarding workflows:
26
26
27
27
- Install and manage onto virtual machine extensions.
28
28
- Upload and configure defaults on Azure storage accounts.
29
29
- Enable baseline diagnostic settings at scale.
30
30
31
31
## Resource onboarding basics
32
32
33
-
You configure resource onboarding through Azure Custom Providers by using Microsoft.CustomProviders/resourceProviders and Microsoft.CustomProviders/associations resource types. To enable resource onboarding for a custom provider, during the configuration process, create a **resourceType** called "associations" with a **routingType** that includes "Extension". The Microsoft.CustomProviders/associations and Microsoft.CustomProviders/resourceProviders don't need to belong to the same resource group.
33
+
You configure resource onboarding through Azure Custom Resource Providers by using Microsoft.CustomProviders/resourceProviders and Microsoft.CustomProviders/associations resource types. To enable resource onboarding for a custom resource provider, during the configuration process, create a **resourceType** called "associations" with a **routingType** that includes "Extension". The Microsoft.CustomProviders/associations and Microsoft.CustomProviders/resourceProviders don't need to belong to the same resource group.
34
34
35
-
Here's a sample Azure custom provider:
35
+
Here's a sample Azure custom resource provider:
36
36
37
37
```JSON
38
38
{
@@ -55,12 +55,12 @@ name | Yes | The name of the endpoint definition. For resource onboarding, the n
55
55
routingType | Yes | Determines the type of contract with the endpoint. For resource onboarding, the valid **routingTypes** are "Proxy,Cache,Extension" and "Webhook,Cache,Extension".
56
56
endpoint | Yes | The endpoint to route the requests to. This will handle the response and any side effects of the request.
57
57
58
-
After you create the custom provider with the associations resource type, you can target using Microsoft.CustomProviders/associations. Microsoft.CustomProviders/associations is an extension resource that can extend any other Azure resource. When an instance of Microsoft.CustomProviders/associations is created, it will take a property **targetResourceId**, which should be a valid Microsoft.CustomProviders/resourceProviders or Microsoft.Solutions/applications resource ID. In these cases, the request will be forwarded to the associations resource type on the Microsoft.CustomProviders/resourceProviders instance you created.
58
+
After you create the custom resource provider with the associations resource type, you can target using Microsoft.CustomProviders/associations. Microsoft.CustomProviders/associations is an extension resource that can extend any other Azure resource. When an instance of Microsoft.CustomProviders/associations is created, it will take a property **targetResourceId**, which should be a valid Microsoft.CustomProviders/resourceProviders or Microsoft.Solutions/applications resource ID. In these cases, the request will be forwarded to the associations resource type on the Microsoft.CustomProviders/resourceProviders instance you created.
59
59
60
60
> [!NOTE]
61
61
> If a Microsoft.Solutions/applications resource ID is provided as the **targetResourceId**, there must be a Microsoft.CustomProviders/resourceProviders deployed in the managed resource group with the name "public".
@@ -79,7 +79,7 @@ targetResourceId | Yes | The resource ID of the Microsoft.CustomProviders/resour
79
79
80
80
Resource onboarding works by extending other resources with the Microsoft.CustomProviders/associations extension resource. In the following sample, the request is made for a virtual machine, but any resource can be extended.
81
81
82
-
First, you need to create a custom provider resource with an associations resource type. This will declare the callback URL that will be used when a corresponding Microsoft.CustomProviders/associations resource is created, which targets the custom provider.
82
+
First, you need to create a custom resource provider resource with an associations resource type. This will declare the callback URL that will be used when a corresponding Microsoft.CustomProviders/associations resource is created, which targets the custom resource provider.
This request will then be forwarded to the endpoint specified in the custom provider you created, which is referenced by the **targetResourceId** in this form:
125
+
This request will then be forwarded to the endpoint specified in the custom resource provider you created, which is referenced by the **targetResourceId** in this form:
126
126
127
127
```HTTP
128
128
PUT https://{endpointURL}/?api-version=2018-09-01-preview
@@ -149,10 +149,10 @@ If you have questions about Azure Custom Resource Providers development, try ask
149
149
150
150
## Next steps
151
151
152
-
In this article, you learned about custom providers. See these articles to learn more:
152
+
In this article, you learned about custom resource providers. See these articles to learn more:
153
153
154
-
-[Tutorial: Resource onboarding with custom providers](./tutorial-resource-onboarding.md)
154
+
-[Tutorial: Resource onboarding with custom resource providers](./tutorial-resource-onboarding.md)
155
155
-[Tutorial: Create custom actions and resources in Azure](./tutorial-get-started-with-custom-providers.md)
156
-
-[Quickstart: Create a custom resource provider and deploy custom resources](./create-custom-provider.md)
156
+
-[Quickstart: Create Azure Custom Resource Provider and deploy custom resources](./create-custom-provider.md)
157
157
-[How to: Adding custom actions to an Azure REST API](./custom-providers-action-endpoint-how-to.md)
158
158
-[How to: Adding custom resources to an Azure REST API](./custom-providers-resources-endpoint-how-to.md)
In this quickstart, you create a custom resource provider and deploy custom resources for that resource provider. For more information about custom providers, see [Azure Custom Resource Providers Overview](overview.md).
13
+
In this quickstart, you create a custom resource provider and deploy custom resources for that resource provider. For more information about custom resource providers, see [Azure Custom Resource Providers Overview](overview.md).
14
14
15
15
## Prerequisites
16
16
@@ -33,14 +33,14 @@ Azure CLI examples use `az rest` for `REST` requests. For more information, see
33
33
34
34
---
35
35
36
-
## Deploy custom provider
36
+
## Deploy custom resource provider
37
37
38
38
To set up the custom resource provider, deploy an [example template](https://github.com/Azure/azure-docs-json-samples/blob/master/custom-providers/customprovider.json) to your Azure subscription.
39
39
40
40
The template deploys the following resources to your subscription:
41
41
42
42
- Function app with the operations for the resources and actions.
43
-
- Storage account for storing users that are created through the custom provider.
43
+
- Storage account for storing users that are created through the custom resource provider.
44
44
- Custom resource provider that defines the custom resource types and actions. It uses the function app endpoint for sending requests.
45
45
- Custom resource from the custom resource provider.
0 commit comments