クイックスタート:Azure PowerShell を使用して Azure カスタム リソース プロバイダーを作成する

このクイックスタートでは、Az.CustomProviders PowerShell モジュールを使用して独自の Azure カスタム リソース プロバイダーを作成する方法について説明します。

注意

現在、Azure カスタム プロバイダーはパブリック プレビュー段階にあります。 このプレビュー バージョンは、サービス レベル アグリーメントなしに提供されます。 運用環境のワークロードにはお勧めしません。 特定の機能はサポート対象ではなく、機能が制限されることがあります。 詳しくは、Microsoft Azure プレビューの追加使用条件に関するページをご覧ください。

必要条件

Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。

ローカルで PowerShell を使用する場合は、Az PowerShell モジュールをインストールしたうえで、Connect-AzAccount コマンドレットを使用して自分の Azure アカウントに接続する必要があります。 Az PowerShell モジュールのインストールの詳細については、「Azure PowerShell のインストール」を参照してください。 Cloud Shell の使用を選択した場合、詳細については「Azure Cloud Shell の概要」を参照してください。

重要

Az.CustomProviders PowerShell モジュールがプレビュー段階にある間は、Install-Module コマンドレットを使用して、これを個別にインストールする必要があります。 この PowerShell モジュールは、一般提供された段階で将来の Az PowerShell モジュール リリースの一部となり、Azure Cloud Shell 内からネイティブに使用できるようになります。

Install-Module -Name Az.CustomProviders

複数の Azure サブスクリプションをお持ちの場合は、リソースが課金の対象となる適切なサブスクリプションを選択してください。 Set-AzContext コマンドレットを使用して、特定のサブスクリプションを選択します。

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

リソース グループを作成する

New-AzResourceGroup コマンドレットを使用して、Azure リソース グループを作成します。 リソース グループとは、複数の Azure リソースをまとめてデプロイ、管理する際の論理コンテナーです。

次の例では、指定された名前のリソース グループを、指定された場所に作成します。

New-AzResourceGroup -Name myResourceGroup -Location westus2

カスタム リソース プロバイダーの作成

カスタム リソース プロバイダーを作成または更新するには、次の例に示すように、New-AzCustomProvider コマンドレットを使用します。

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

カスタム リソース プロバイダー マニフェストを取得する

カスタム リソース プロバイダー マニフェストに関する情報を取得するには、次の例に示すように、Get-AzCustomProvider コマンドレットを使用します。

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

関連付けを作成する

関連付けを作成または更新するには、次の例に示すように、New-AzCustomProviderAssociation コマンドレットを使用します。

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

関連付けを取得する

関連付けに関する情報を取得するには、次の例に示すように、Get-AzCustomProviderAssociation コマンドレットを使用します。

Get-AzCustomProviderAssociation -Scope $resourceId -Name MyAssoc

リソースをクリーンアップする

この記事で作成したリソースが不要であれば、次の例を実行して削除できます。

関連付けを削除する

関連付けを削除するには、Remove-AzCustomProviderAssociation コマンドレットを使用します。 次の例では、関連付けを削除します。

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

カスタム リソース プロバイダーの削除

カスタム リソース プロバイダーを削除するには、Remove-AzCustomProvider コマンドレットを使用します。 次の例では、カスタム リソース プロバイダーを削除します。

Remove-AzCustomProvider -ResourceGroupName myResourceGroup -Name Namespace.Type

リソース グループを削除します

注意事項

次の例では、指定されたリソース グループとそれに含まれるすべてのリソースを削除します。 指定したリソース グループにこの記事の範囲外のリソースが含まれている場合、それらも削除されます。

Remove-AzResourceGroup -Name myResourceGroup

次のステップ

詳細については、Azure カスタム リソース プロバイダーに関するページを参照してください。