New-AzKeyVault
Tworzy magazyn kluczy.
Składnia
New-AzKeyVault
[-Name] <String>
[-ResourceGroupName] <String>
[-Location] <String>
[-EnabledForDeployment]
[-EnabledForTemplateDeployment]
[-EnabledForDiskEncryption]
[-EnablePurgeProtection]
[-DisableRbacAuthorization]
[-SoftDeleteRetentionInDays <Int32>]
[-PublicNetworkAccess <String>]
[-Sku <String>]
[-Tag <Hashtable>]
[-NetworkRuleSet <PSKeyVaultNetworkRuleSet>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
Opis
Polecenie cmdlet New-AzKeyVault tworzy magazyn kluczy w określonej grupie zasobów. To polecenie cmdlet przyznaje również uprawnienia do aktualnie zalogowanego użytkownika w celu dodawania, usuwania lub wyświetlania listy kluczy i wpisów tajnych w magazynie kluczy. Uwaga: jeśli podczas próby utworzenia nowego magazynu kluczy zostanie wyświetlony błąd Subskrypcja nie jest zarejestrowana w celu używania przestrzeni nazw "Microsoft.KeyVault" podczas próby utworzenia nowego magazynu kluczy, uruchom polecenie Register-AzResourceProvider -ProviderNamespace "Microsoft.KeyVault", a następnie uruchom ponownie polecenie new-AzKeyVault. Aby uzyskać więcej informacji, zobacz Register-AzResourceProvider.
Polecenie cmdlet może wywołać poniższy interfejs API programu Microsoft Graph zgodnie z parametrami wejściowymi:
- GET /directoryObjects/{id}
- GET /users/{id}
- GET /servicePrincipals/{id}
- GET /groups/{id}
- GET /me
Przykłady
Przykład 1. Tworzenie standardowego magazynu kluczy
New-AzKeyVault -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -Location 'East US'
Vault Name : contoso03vault
Resource Group Name : group14
Location : East US
Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/group14/providers
/Microsoft.KeyVault/vaults/contoso03vault
Vault URI : https://contoso03vault.vault.azure.net/
Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
SKU : Standard
Enabled For Deployment? :
Enabled For Template Deployment? :
Enabled For Disk Encryption? :
Soft Delete Enabled? : True
Access Policies :
Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
Application ID :
Display Name : User Name (username@microsoft.com)
Permissions to Keys : all
Permissions to Secrets : all
Permissions to Certificates : all
Permissions to (Key Vault Managed) Storage : all
Network Rule Set :
Default Action : Allow
Bypass : AzureServices
IP Rules :
Virtual Network Rules :
Tags :
To polecenie tworzy magazyn kluczy o nazwie Contoso03Vault w regionie świadczenia usługi Azure Wschodnie stany USA. Polecenie dodaje magazyn kluczy do grupy zasobów o nazwie Group14. Ponieważ polecenie nie określa wartości parametru jednostki SKU
Przykład 2. Tworzenie magazynu kluczy Premium
New-AzKeyVault -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -Location 'East US' -Sku 'Premium'
Vault Name : contoso03vault
Resource Group Name : group14
Location : East US
Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/group14/providers
/Microsoft.KeyVault/vaults/contoso03vault
Vault URI : https://contoso03vault.vault.azure.net/
Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
SKU : Premium
Enabled For Deployment? : False
Enabled For Template Deployment? : False
Enabled For Disk Encryption? : False
Soft Delete Enabled? :
Access Policies :
Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
Application ID :
Display Name : User Name (username@microsoft.com)
Permissions to Keys : all
Permissions to Secrets : all
Permissions to Certificates : all
Permissions to (Key Vault Managed) Storage : all
Network Rule Set :
Default Action : Allow
Bypass : AzureServices
IP Rules :
Virtual Network Rules :
Tags :
To polecenie tworzy magazyn kluczy, podobnie jak w poprzednim przykładzie. Określa jednak wartość Premium dla SKU parametru w celu utworzenia magazynu kluczy Premium.
Przykład 3
$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "110.0.1.0/24" -ServiceEndpoint Microsoft.KeyVault
$virtualNetwork = New-AzVirtualNetwork -Name myVNet -ResourceGroupName myRG -Location westus -AddressPrefix "110.0.0.0/16" -Subnet $frontendSubnet
$myNetworkResId = (Get-AzVirtualNetwork -Name myVNet -ResourceGroupName myRG).Subnets[0].Id
$ruleSet = New-AzKeyVaultNetworkRuleSetObject -DefaultAction Allow -Bypass AzureServices -IpAddressRange "110.0.1.0/24" -VirtualNetworkResourceId $myNetworkResId
New-AzKeyVault -ResourceGroupName "myRg" -VaultName "myVault" -NetworkRuleSet $ruleSet -Location westus
Vault Name : myVault
Resource Group Name : myRg
Location : East US
Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myRg/providers
/Microsoft.KeyVault/vaults/myVault
Vault URI : https://myVault.vault.azure.net/
Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
SKU : Premium
Enabled For Deployment? : False
Enabled For Template Deployment? : False
Enabled For Disk Encryption? : False
Soft Delete Enabled? :
Access Policies :
Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
Application ID :
Display Name : User Name (username@microsoft.com)
Permissions to Keys : all
Permissions to Secrets : all
Permissions to Certificates : all
Permissions to (Key Vault Managed) Storage : all
Network Rule Set :
Default Action : Allow
Bypass : AzureServices
IP Rules : 110.0.1.0/24
Virtual Network Rules : /subscriptions/0b1f6471-1bf0-4dda-ae
c3-cb9272f09590/resourcegroups/myRg/providers/microsoft.network/virtualnetworks
/myvnet/subnets/frontendsubnet
Tags :
Utworzenie magazynu kluczy i określenie reguł sieci umożliwiających dostęp do określonego adresu IP z sieci wirtualnej zidentyfikowanej przez $myNetworkResId. Aby uzyskać więcej informacji, zobacz New-AzKeyVaultNetworkRuleSetObject
.
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 |
-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 |
-DisableRbacAuthorization
Jeśli zostanie określona, wyłączy autoryzację akcji danych za pomocą kontroli dostępu opartej na rolach (RBAC), a następnie zasady dostępu określone we właściwościach magazynu zostaną uznane. Należy pamiętać, że akcje zarządzania są zawsze autoryzowane za pomocą kontroli dostępu opartej na rolach.
Typ: | SwitchParameter |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-EnabledForDeployment
Umożliwia dostawcy zasobów Microsoft.Compute pobieranie wpisów tajnych z tego magazynu kluczy podczas odwołowania się do tego magazynu kluczy podczas tworzenia zasobów, na przykład podczas tworzenia maszyny wirtualnej.
Typ: | SwitchParameter |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-EnabledForDiskEncryption
Umożliwia usłudze Azure Disk Encryption pobieranie wpisów tajnych i odpakowywanie kluczy z tego magazynu kluczy.
Typ: | SwitchParameter |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-EnabledForTemplateDeployment
Umożliwia usłudze Azure Resource Manager pobieranie wpisów tajnych z tego magazynu kluczy podczas odwołowania się do tego magazynu kluczy we wdrożeniu szablonu.
Typ: | SwitchParameter |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-EnablePurgeProtection
W przypadku określenia ochrony przed bezpośrednim usunięciem jest włączona dla tego magazynu; wymaga również włączenia usuwania nietrwałego.
Typ: | SwitchParameter |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-Location
Określa region platformy Azure, w którym ma zostać utworzony magazyn kluczy. Użyj polecenia Get-AzLocation, aby wyświetlić wybrane opcje.
Typ: | String |
Position: | 2 |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Name
Określa nazwę magazynu kluczy do utworzenia. Nazwa może być dowolną kombinacją liter, cyfr lub łączników. Nazwa musi zaczynać się i kończyć literą lub cyfrą. Nazwa musi być uniwersalnie unikatowa.
Typ: | String |
Aliasy: | VaultName |
Position: | 0 |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-NetworkRuleSet
Określa zestaw reguł sieciowych magazynu. Zarządza ona dostępnością magazynu kluczy z określonych lokalizacji sieciowych. Utworzone przez New-AzKeyVaultNetworkRuleSetObject
.
Typ: | PSKeyVaultNetworkRuleSet |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-PublicNetworkAccess
Określa, czy magazyn będzie akceptował ruch z publicznego Internetu. W przypadku ustawienia opcji "disabled" cały ruch z wyjątkiem ruchu prywatnego punktu końcowego i pochodzącego z zaufanych usług zostanie zablokowany. Spowoduje to zastąpienie ustawionych reguł zapory, co oznacza, że nawet jeśli istnieją reguły zapory, nie będziemy przestrzegać reguł. Domyślnie włączymy dostęp do sieci publicznej.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-ResourceGroupName
Określa nazwę istniejącej grupy zasobów, w której ma zostać utworzony magazyn kluczy.
Typ: | String |
Position: | 1 |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Sku
Określa jednostkę SKU wystąpienia magazynu kluczy. Aby uzyskać informacje o funkcjach dostępnych dla każdej jednostki SKU, zobacz witrynę internetową Azure Key Vault — cennik (https://go.microsoft.com/fwlink/?linkid=512521).
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-SoftDeleteRetentionInDays
Określa czas przechowywania usuniętych zasobów oraz czas przechowywania magazynu lub obiektu w usuniętym stanie. Wartość domyślna to 90 dni.
Typ: | Int32 |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-SubscriptionId
Identyfikator subskrypcji. Domyślnie polecenia cmdlet są wykonywane w subskrypcji ustawionej w bieżącym kontekście. Jeśli użytkownik określi inną subskrypcję, bieżące polecenie cmdlet zostanie wykonane w subskrypcji określonej przez użytkownika. Zastępowanie subskrypcji ma zastosowanie tylko w cyklu życia bieżącego polecenia cmdlet. Nie zmienia subskrypcji w kontekście i nie ma wpływu na kolejne polecenia cmdlet.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Tag
Pary klucz-wartość w postaci tabeli skrótów. Na przykład: @{key0="value0"; key1=$null; key2="value2"}
Typ: | Hashtable |
Aliasy: | Tags |
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 |