New-AzBlueprintAssignment

  • リファレンス
モジュール:
Az.Blueprint

ブループリント定義をサブスクリプションまたは管理グループに割り当てます。

構文

New-AzBlueprintAssignment
   -Name <String>
   -Blueprint <PSBlueprintBase>
   -Location <String>
   [-SystemAssignedIdentity]
   [-UserAssignedIdentity <String>]
   [-Lock <PSLockMode>]
   [-SecureStringParameter <Hashtable>]
   [-ResourceGroupParameter <Hashtable>]
   [-Parameter <Hashtable>]
   [-ManagementGroupId <String>]
   [-SubscriptionId <String[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzBlueprintAssignment
   -Name <String>
   [-Blueprint <PSBlueprintBase>]
   [-AssignmentFile <String>]
   [-ManagementGroupId <String>]
   [-SubscriptionId <String[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

ブループリント定義をサブスクリプションに割り当てます。

例

例 1

$rg = @{ResourceGroup=@{name='storage_rg';location='eastus'}}
$params = @{applytaganditsdefaultvalue_tagName="Department_Cost_Center"; applytaganditsdefaultvalue_tagValue="Contoso/RnD/Dev/986754"}
$blueprintObject =  Get-AzBlueprint -SubscriptionId "00000000-1111-0000-1111-000000000000" -Name "myBlueprintName"
$secureString = @{mySecureStringParam=@{keyVaultId='/subscriptions/00000000-1111-0000-1111-000000000000/rsourcegroups/myResourceGroup/providers/Microsoft.Keyvault/Vaults/myKeyVault';secretName='mySecret';secretVersion='1.0'}}
New-AzBlueprintAssignment -Name "myAssignment" -Blueprint $blueprintObject -SubscriptionId "00000000-1111-0000-1111-000000000000" -Location "West US" -ResourceGroupParameter $rg -Parameter $params -SecureStringParameter $secureString

Name              : myAssignment
Id                : /subscriptions/00000000-1111-0000-1111-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/myAssignment
Scope             : /subscriptions/00000000-1111-0000-1111-000000000000
LastModified      : 2019-01-08
LockMode          : None
ProvisioningState : Creating
Parameters        : {applytaganditsdefaultvalue_tagName, applytaganditsdefaultvalue_tagValue}
ResourceGroups    : ResourceGroup

定義されたパラメーターとリソース グループ ディクショナリを使用して、指定したサブスクリプション内にブループリント定義 $blueprintObject の新しいブループリント割り当てを作成します。 システム割り当て ID を使用します。 場所は、マネージド ID を作成するためのリージョンを定義します。

例 2

New-AzBlueprintAssignment -Name "myAssignment" -Blueprint $blueprintObject -SubscriptionId 00000000-1111-0000-1111-000000000000 -Location "West US" -Parameter @{P1="v1"; P2="v2"} -Lock AllResourcesReadOnly

定義されたパラメーターとリソース グループ ディクショナリを使用し、AllResources へのリソース ロックを構成して、指定したサブスクリプション内にブループリント定義 $blueprintObject の 新しいブループリント割り当てを作成します。 既定では、システム割り当て ID を使用します。 場所は、マネージド ID を作成するためのリージョンを定義します。

例 3

New-AzBlueprintAssignment -Name "myAssignment" -Blueprint $blueprintObject -SubscriptionId 00000000-1111-0000-1111-000000000000 -Location "West US" -Parameter @{P1="v1"; P2="v2"} -UserAssignedIdentity "/subscriptions/00000000-1111-0000-1111-000000000000/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-user-defined-identity"

指定したユーザー割り当て ID を使用して、定義済みのパラメーターとリソース グループ ディクショナリを使用して、指定したサブスクリプション内にブループリント定義 $blueprintObject の新しいブループリント割り当てを作成します。

例 4

$blueprintObject =  Get-AzBlueprint -SubscriptionId "00000000-1111-0000-1111-000000000000" -Name "myBlueprintName"
New-AzBlueprintAssignment -Name "myAssignment" -Blueprint $blueprintObject -SubscriptionId "00000000-1111-0000-1111-000000000000" -AssignmentFile C:\myAssignmentfile.json

Name              : myAssignment
Id                : /subscriptions/00000000-1111-0000-1111-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/myAssignment
Scope             : /subscriptions/00000000-1111-0000-1111-000000000000
LastModified      : 2019-01-08
LockMode          : None
ProvisioningState : Creating
Parameters        : {applytaganditsdefaultvalue_tagName, applytaganditsdefaultvalue_tagValue}
ResourceGroups    : ResourceGroup

割り当てファイルを使用してブループリントの割り当てを作成します。 割り当てファイルの形式は、次の要求/応答のサンプルにあります。 https://github.com/Azure/azure-rest-api-specs/tree/master/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples

例 5

$blueprintObject =  Get-AzBlueprint -SubscriptionId "myManagementGroup" -Name "myBlueprintName"
New-AzBlueprintAssignment -Name "myAssignment" -Blueprint $blueprintObject -ManagementGroupId "myManagementGroup" -SubscriptionId 00000000-1111-0000-1111-000000000000 -Location "West US" -Parameter @{P1="v1"; P2="v2"}

定義されたパラメーターを使用して、指定した管理グループ内の指定したサブスクリプションを対象とするブループリント定義 $blueprintObject の新しいブループリント割り当てを作成します。

パラメーター

-AssignmentFile

ディスク上の JSON 形式の割り当てファイルの場所。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Blueprint

ブループリント定義オブジェクト。

Type:PSBlueprintBase
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Location

作成されるマネージド ID のリージョン。 詳細については、aka.ms/blueprintmsi を参照してください

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Lock

リソースをロックします。 詳細については、aka.ms/blueprintlocks を参照してください

Type:Nullable<T>[PSLockMode]
Accepted values:None, AllResourcesReadOnly, AllResourcesDoNotDelete
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ManagementGroupId

ブループリントの割り当てが保存される管理グループの ID。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

ブループリントの割り当て名。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Parameter

成果物のパラメーター。

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupParameter

リソース グループ成果物に渡すパラメーターのハッシュテーブル。

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SecureStringParameter

KeyVault リソース ID、名前、バージョンのセキュリティで保護された文字列パラメーター。

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

ブループリント定義を割り当てるサブスクリプション ID。 subscriptionId 文字列のコンマ区切りリストを指定できます。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SystemAssignedIdentity

成果物をデプロイするためのシステム割り当て ID (MSI)。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserAssignedIdentity

成果物をデプロイするためのユーザー割り当て ID (MSI)。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

String

PSBlueprintBase

String[]

Hashtable

出力

Object