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
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Context
PsApiManagementContext のインスタンス。 このパラメーターは必須です。
| 型: | PsApiManagementContext |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| 型: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-KeyVault
名前付き値データをフェッチするために使用される KeyVault。Value が指定されていない場合は、このパラメーターが必要です。 詳細については、New-AzApiManagementKeyVaultObject を参照してください。
| 型: | PsApiManagementKeyVaultEntity |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Name
名前付き値の名前。 最大長は 100 文字です。 文字、数字、ピリオド、ダッシュ、アンダースコアのみを含めることができます。 このパラメーターは必須です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-NamedValueId
新しい名前付き値の識別子。 このパラメーターは省略可能です。 指定しない場合は生成されます。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Secret
値がシークレットであり、暗号化する必要があるかどうかを判断します。 このパラメーターは省略可能です。 既定値は false です。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Tag
名前付き値に関連付けるタグ。 このパラメーターは省略可能です。
| 型: | String[] |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Value
名前付き値の値。 ポリシー式を含めることができます。 最大長は 1000 文字です。 空白ではないか、空白のみで構成されている場合があります。 このパラメーターは必須です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
String[]