New-AzApiManagementNamedValue

Referenz

Modul:: Az.ApiManagement

Erstellt einen neuen benannten Wert.

Syntax

New-AzApiManagementNamedValue
   -Context <PsApiManagementContext>
   [-NamedValueId <String>]
   [-Name <String>]
   [-Value <String>]
   [-Secret]
   [-Tag <String[]>]
   [-KeyVault <PsApiManagementKeyVaultEntity>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Beschreibung

Mit dem Cmdlet New-AzApiManagementNamedValue wird ein benannter Wert für die Azure-API-Verwaltung erstellt.

Beispiele

Beispiel 1: Erstellen eines benannten Werts, der Tags enthält

$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

Der erste Befehl weist der variablen $Tags zwei Werte zu. Der zweite Befehl erstellt einen benannten Wert und weist die Zeichenfolgen in $Tags als Tags für die Eigenschaft zu.

Beispiel 2: Erstellen eines benannten Werts mit einem geheimen Wert

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementNamedValue -Context $apimContext -NamedValueId "Property12" -Name "Secret Property" -Value "Secret Property Value" -Secret

Mit diesem Befehl wird ein benannter Wert erstellt, der einen verschlüsselten Wert aufweist.

Beispiel 3: Erstellen eines 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

Der erste Befehl erstellt einen Keyvault. Der zweite Befehl erstellt einen benannten Wert mithilfe eines geheimen Schlüssels aus diesem Keyvault.

Parameter

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

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

-Context

Instanz von PsApiManagementContext. Dieser Parameter ist erforderlich.

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

-DefaultProfile

Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure

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

-KeyVault

KeyVault zum Abrufen von Namedvalue-Daten. Dieser Parameter ist erforderlich, wenn "Value" nicht angegeben wurde. Details finden Sie unter New-AzApiManagementKeyVaultObject.

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

-Name

Name des benannten Werts. Die maximale Länge beträgt 100 Zeichen. Er kann nur Buchstaben, Ziffern, Punkte, Gedankenstriche und Unterstriche enthalten. Dieser Parameter ist erforderlich.

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

-NamedValueId

Bezeichner des neuen benannten Werts. Dieser Parameter ist optional. Wenn nicht angegeben, wird dies generiert.

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

-Secret

Bestimmt, ob der Wert ein geheimer Schlüssel ist und ob er verschlüsselt werden sollte. Dieser Parameter ist optional. Der Standardwert ist "false".

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

-Tag

Tags, die mit benannten Werten verknüpft werden sollen. Dieser Parameter ist optional.

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

-Value

Wert des benannten Werts. Kann Richtlinienausdrücke enthalten. Die maximale Länge beträgt 1000 Zeichen. Er darf nicht leer sein oder nur aus Leerzeichen bestehen. Dieser Parameter ist erforderlich.

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

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

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

Eingaben

PsApiManagementContext

String

SwitchParameter

String[]

Ausgaben

PsApiManagementNamedValue