New-AzApiManagementNamedValue
Tworzy nową nazwaną wartość.
Składnia
New-AzApiManagementNamedValue
-Context <PsApiManagementContext>
[-NamedValueId <String>]
[-Name <String>]
[-Value <String>]
[-Secret]
[-Tag <String[]>]
[-KeyVault <PsApiManagementKeyVaultEntity>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Opis
Polecenie cmdlet New-AzApiManagementNamedValue tworzy nazwaną wartość usługi Azure API Management.
Przykłady
Przykład 1. Tworzenie nazwanej wartości zawierającej tagi
$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
Pierwsze polecenie przypisuje dwie wartości do zmiennej $Tags. Drugie polecenie tworzy nazwaną wartość i przypisuje ciągi w $Tags jako tagi właściwości.
Przykład 2. Tworzenie nazwanej wartości, która ma wartość wpisu tajnego
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementNamedValue -Context $apimContext -NamedValueId "Property12" -Name "Secret Property" -Value "Secret Property Value" -Secret
To polecenie tworzy nazwaną wartość, która ma zaszyfrowaną wartość.
Przykład 3: Tworzenie wartości nazwanej magazynu kluczy
$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
Pierwsze polecenie tworzy magazyn kluczy. Drugie polecenie tworzy nazwaną wartość przy użyciu wpisu tajnego z tego magazynu kluczy.
Parametry
-Confirm
Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.
Typ: | SwitchParameter |
Aliasy: | cf |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-Context
Wystąpienie elementu PsApiManagementContext. Ten parametr jest wymagany.
Typ: | PsApiManagementContext |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-DefaultProfile
Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.
Typ: | IAzureContextContainer |
Aliasy: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-KeyVault
Usługa KeyVault używana do pobierania danych nazwanychvalue. Ten parametr jest wymagany, jeśli wartość nie jest określona. Aby uzyskać szczegółowe informacje, zobacz New-AzApiManagementKeyVaultObject.
Typ: | PsApiManagementKeyVaultEntity |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Name
Nazwa nazwanej wartości. Maksymalna długość to 100 znaków. Może zawierać tylko litery, cyfry, kropkę, kreskę i znaki podkreślenia. Ten parametr jest wymagany.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-NamedValueId
Identyfikator nowej nazwanej wartości. Ten parametr jest opcjonalny. Jeśli nie zostanie określony, zostanie wygenerowany.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Secret
Określa, czy wartość jest wpisem tajnym i powinna być zaszyfrowana, czy nie. Ten parametr jest opcjonalny. Wartość domyślna to false.
Typ: | SwitchParameter |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Tag
Tagi do skojarzenia z nazwaną wartością. Ten parametr jest opcjonalny.
Typ: | String[] |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Value
Wartość nazwanej wartości. Może zawierać wyrażenia zasad. Maksymalna długość to 1000 znaków. Może nie być pusty lub składać się tylko z białych znaków. Ten parametr jest wymagany.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-WhatIf
Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Polecenie cmdlet nie jest uruchamiane.
Typ: | SwitchParameter |
Aliasy: | wi |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
Dane wejściowe
String[]