New-AzApiManagementNamedValue
新しい名前付き値を作成します。
構文
New-AzApiManagementNamedValue
-Context <PsApiManagementContext>
[-NamedValueId <String>]
[-Name <String>]
[-Value <String>]
[-Secret]
[-Tag <String[]>]
[-KeyVault <PsApiManagementKeyVaultEntity>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
New-AzApiManagementNamedValue コマンドレットは、Azure API Management の名前付き値を作成します。
例
例 1: タグを含む名前付き値を作成する
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$Tags = 'sdk', 'powershell'
New-AzApiManagementNamedValue -Context $apimContext -NamedValueId "Property11" -Name "Property Name" -Value "Property Value" -Tag $Tags最初のコマンドは、$Tags変数に 2 つの値を割り当てます。 2 番目のコマンドは、名前付きの値を作成し、プロパティのタグとして$Tags内の文字列を割り当てます。
例 2: シークレット値を持つ名前付き値を作成する
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementNamedValue -Context $apimContext -NamedValueId "Property12" -Name "Secret Property" -Value "Secret Property Value" -Secretこのコマンドは、 暗号化された値を持つ名前付き値 を作成します。
例 3: keyVault Namedvalue を作成する
$secretIdentifier = 'https://contoso.vault.azure.net/secrets/xxxx'
$keyvault = New-AzApiManagementKeyVaultObject -SecretIdentifier $secretIdentifier
$keyVaultNamedValue = New-AzApiManagementNamedValue -Context $context -NamedValueId $keyVaultNamedValueId -Name $keyVaultNamedValueName -keyVault $keyvault -Secret最初のコマンドでは、keyvault が作成されます。 2 番目のコマンドは、この keyvault のシークレットを使用して名前付き値を作成します。
パラメーター
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Context
PsApiManagementContext のインスタンス。 このパラメーターは必須です。
| Type: | PsApiManagementContext |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| 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 |
-KeyVault
名前付き値データをフェッチするために使用される KeyVault。Value が指定されていない場合は、このパラメーターが必要です。 詳細については、New-AzApiManagementKeyVaultObject を参照してください。
| Type: | PsApiManagementKeyVaultEntity |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
名前付き値の名前。 最大長は 100 文字です。 文字、数字、ピリオド、ダッシュ、下線のみを使用できます。 このパラメーターは必須です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NamedValueId
新しい名前付き値の識別子。 このパラメーターは省略可能です。 指定しない場合は生成されます。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Secret
値がシークレットかどうかと暗号化する必要があるかどうかを決定します。 このパラメーターは省略可能です。 既定値は false です。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Tag
名前付き値に関連付けるタグ。 このパラメーターは省略可能です。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Value
名前付き値の値。 ポリシー式を含めることができます。 最大長は 1,000 文字です。 空にすることはできません。スペースのみで構成することはできません。 このパラメーターは必須です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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[]