Quickstart: Create an Azure custom resource provider with Azure PowerShell

Article
05/11/2023

In this quickstart, you learn how to create your own Azure custom resource provider using the Az.CustomProviders PowerShell module.

Caution

Azure Custom Resource Providers is currently in public preview. This preview version is provided without a service level agreement. It's not recommended for production workloads. Certain features might not be supported or might have constrained capabilities. For more information, see Supplemental Terms of Use for Microsoft Azure Previews.

Requirements

If you don't have an Azure subscription, create a free account before you begin.

If you choose to use PowerShell locally, this article requires that you install the Az PowerShell module and connect to your Azure account using the Connect-AzAccount cmdlet. For more information about installing the Az PowerShell module, see Install Azure PowerShell. If you choose to use Cloud Shell, see Overview of Azure Cloud Shell for more information.

Important

While the Az.CustomProviders PowerShell module is in preview, you must install it separately using the Install-Module cmdlet. Once this PowerShell module becomes generally available, it becomes part of future Az PowerShell module releases and available natively from within Azure Cloud Shell.

Install-Module -Name Az.CustomProviders

If you have multiple Azure subscriptions, choose the appropriate subscription in which the resources should be billed. Select a specific subscription using the Set-AzContext cmdlet.

Set-AzContext -SubscriptionId 00000000-0000-0000-0000-000000000000

Create a resource group

Create an Azure resource group using the New-AzResourceGroup cmdlet. A resource group is a logical container in which Azure resources are deployed and managed as a group.

The following example creates a resource group with the specified name and in the specified location.

New-AzResourceGroup -Name myResourceGroup -Location westus2

Create a custom resource provider

To create or update a custom resource provider, you use the New-AzCustomProvider cmdlet as shown in the following example.

New-AzCustomProvider -ResourceGroupName myResourceGroup -Name Namespace.Type -Location westus2 -ResourceType @{Name='CustomRoute1'; Endpoint='https://www.contoso.com/'}

Get the custom resource provider manifest

To retrieve information about the custom resource provider manifest, you use the Get-AzCustomProvider cmdlet as shown in the following example.

Get-AzCustomProvider -ResourceGroupName myResourceGroup -Name Namespace.Type | Format-List

Create an association

To create or update an association, you use the New-AzCustomProviderAssociation cmdlet as shown in the following example.

$provider = Get-AzCustomProvider -ResourceGroupName myResourceGroup -Name Namespace.Type
New-AzCustomProviderAssociation -Scope $resourceId -Name MyAssoc -TargetResourceId $provider.Id

Get an association

To retrieve information about an association, you use the Get-AzCustomProviderAssociation cmdlet as shown in the following example.

Get-AzCustomProviderAssociation -Scope $resourceId -Name MyAssoc

Clean up resources

If the resources created in this article aren't needed, you can delete them by running the following examples.

Delete an association

To remove an association, you use the Remove-AzCustomProviderAssociation cmdlet. The following example deletes an association.

Remove-AzCustomProviderAssociation -Scope $id -Name Namespace.Type

Delete a custom resource provider

To remove a custom resource provider, you use the Remove-AzCustomProvider cmdlet. The following example deletes a custom resource provider.

Remove-AzCustomProvider -ResourceGroupName myResourceGroup -Name Namespace.Type

Delete the resource group