Udostępnij przez


Set-AzKeyVaultAccessPolicy

Przyznaje lub modyfikuje istniejące uprawnienia dla użytkownika, aplikacji lub grupy zabezpieczeń w celu wykonywania operacji z magazynem kluczy.

Składnia

ByUserPrincipalName (domyślnie)

Set-AzKeyVaultAccessPolicy
    [-VaultName] <String>
    [[-ResourceGroupName] <String>]
    -UserPrincipalName <String>
    [-PermissionsToKeys <String[]>]
    [-PermissionsToSecrets <String[]>]
    [-PermissionsToCertificates <String[]>]
    [-PermissionsToStorage <String[]>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

ByObjectId

Set-AzKeyVaultAccessPolicy
    [-VaultName] <String>
    [[-ResourceGroupName] <String>]
    -ObjectId <String>
    [-ApplicationId <Guid>]
    [-PermissionsToKeys <String[]>]
    [-PermissionsToSecrets <String[]>]
    [-PermissionsToCertificates <String[]>]
    [-PermissionsToStorage <String[]>]
    [-BypassObjectIdValidation]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

ByServicePrincipalName

Set-AzKeyVaultAccessPolicy
    [-VaultName] <String>
    [[-ResourceGroupName] <String>]
    -ServicePrincipalName <String>
    [-PermissionsToKeys <String[]>]
    [-PermissionsToSecrets <String[]>]
    [-PermissionsToCertificates <String[]>]
    [-PermissionsToStorage <String[]>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

ByEmailAddress

Set-AzKeyVaultAccessPolicy
    [-VaultName] <String>
    [[-ResourceGroupName] <String>]
    -EmailAddress <String>
    [-PermissionsToKeys <String[]>]
    [-PermissionsToSecrets <String[]>]
    [-PermissionsToCertificates <String[]>]
    [-PermissionsToStorage <String[]>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

ForVault

Set-AzKeyVaultAccessPolicy
    [-VaultName] <String>
    [[-ResourceGroupName] <String>]
    [-EnabledForDeployment]
    [-EnabledForTemplateDeployment]
    [-EnabledForDiskEncryption]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

InputObjectByObjectId

Set-AzKeyVaultAccessPolicy
    [-InputObject] <PSKeyVaultIdentityItem>
    -ObjectId <String>
    [-ApplicationId <Guid>]
    [-PermissionsToKeys <String[]>]
    [-PermissionsToSecrets <String[]>]
    [-PermissionsToCertificates <String[]>]
    [-PermissionsToStorage <String[]>]
    [-BypassObjectIdValidation]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

InputObjectByServicePrincipalName

Set-AzKeyVaultAccessPolicy
    [-InputObject] <PSKeyVaultIdentityItem>
    -ServicePrincipalName <String>
    [-PermissionsToKeys <String[]>]
    [-PermissionsToSecrets <String[]>]
    [-PermissionsToCertificates <String[]>]
    [-PermissionsToStorage <String[]>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

InputObjectByUserPrincipalName

Set-AzKeyVaultAccessPolicy
    [-InputObject] <PSKeyVaultIdentityItem>
    -UserPrincipalName <String>
    [-PermissionsToKeys <String[]>]
    [-PermissionsToSecrets <String[]>]
    [-PermissionsToCertificates <String[]>]
    [-PermissionsToStorage <String[]>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

InputObjectByEmailAddress

Set-AzKeyVaultAccessPolicy
    [-InputObject] <PSKeyVaultIdentityItem>
    -EmailAddress <String>
    [-PermissionsToKeys <String[]>]
    [-PermissionsToSecrets <String[]>]
    [-PermissionsToCertificates <String[]>]
    [-PermissionsToStorage <String[]>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

InputObjectForVault

Set-AzKeyVaultAccessPolicy
    [-InputObject] <PSKeyVaultIdentityItem>
    [-EnabledForDeployment]
    [-EnabledForTemplateDeployment]
    [-EnabledForDiskEncryption]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

ResourceIdByObjectId

Set-AzKeyVaultAccessPolicy
    [-ResourceId] <String>
    -ObjectId <String>
    [-ApplicationId <Guid>]
    [-PermissionsToKeys <String[]>]
    [-PermissionsToSecrets <String[]>]
    [-PermissionsToCertificates <String[]>]
    [-PermissionsToStorage <String[]>]
    [-BypassObjectIdValidation]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

ResourceIdByServicePrincipalName

Set-AzKeyVaultAccessPolicy
    [-ResourceId] <String>
    -ServicePrincipalName <String>
    [-PermissionsToKeys <String[]>]
    [-PermissionsToSecrets <String[]>]
    [-PermissionsToCertificates <String[]>]
    [-PermissionsToStorage <String[]>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

ResourceIdByUserPrincipalName

Set-AzKeyVaultAccessPolicy
    [-ResourceId] <String>
    -UserPrincipalName <String>
    [-PermissionsToKeys <String[]>]
    [-PermissionsToSecrets <String[]>]
    [-PermissionsToCertificates <String[]>]
    [-PermissionsToStorage <String[]>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

ResourceIdByEmailAddress

Set-AzKeyVaultAccessPolicy
    [-ResourceId] <String>
    -EmailAddress <String>
    [-PermissionsToKeys <String[]>]
    [-PermissionsToSecrets <String[]>]
    [-PermissionsToCertificates <String[]>]
    [-PermissionsToStorage <String[]>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

ResourceIdForVault

Set-AzKeyVaultAccessPolicy
    [-ResourceId] <String>
    [-EnabledForDeployment]
    [-EnabledForTemplateDeployment]
    [-EnabledForDiskEncryption]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

Opis

Polecenie cmdlet Set-AzKeyVaultAccessPolicy przyznaje lub modyfikuje istniejące uprawnienia dla użytkownika, aplikacji lub grupy zabezpieczeń w celu wykonania określonych operacji z magazynem kluczy. Nie modyfikuje uprawnień, które mają inni użytkownicy, aplikacje lub grupy zabezpieczeń w magazynie kluczy. Jeśli ustawiasz uprawnienia dla grupy zabezpieczeń, ta operacja ma wpływ tylko na użytkowników w tej grupie zabezpieczeń. Wszystkie następujące katalogi muszą być tym samym katalogem platformy Azure:

  • Domyślny katalog subskrypcji platformy Azure, w którym znajduje się magazyn kluczy.
  • Katalog platformy Azure zawierający grupę użytkowników lub aplikacji, do której udzielasz uprawnień. Przykłady scenariuszy, w których te warunki nie są spełnione, a to polecenie cmdlet nie będzie działać:
  • Autoryzowanie użytkownika z innej organizacji w celu zarządzania magazynem kluczy. Każda organizacja ma własny katalog.
  • Twoje konto platformy Azure ma wiele katalogów. Jeśli zarejestrujesz aplikację w katalogu innym niż katalog domyślny, nie możesz autoryzować tej aplikacji do korzystania z magazynu kluczy. Aplikacja musi znajdować się w katalogu domyślnym. Należy pamiętać, że chociaż określenie grupy zasobów jest opcjonalne dla tego polecenia cmdlet, należy to zrobić, aby uzyskać lepszą wydajność.

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 /users
  • GET /servicePrincipals/{id}
  • GET /servicePrincipals
  • GET /groups/{id}

Uwaga / Notatka

W przypadku używania jednostki usługi do udzielania uprawnień zasad dostępu należy użyć parametru -BypassObjectIdValidation .

Przykłady

Przykład 1: Udzielanie uprawnień użytkownikowi dla magazynu kluczy i modyfikowanie uprawnień

Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToKeys create,import,delete,list -PermissionsToSecrets set,delete -PassThru

Vault Name                       : Contoso03Vault
Resource Group Name              : myrg
Location                         : westus
Resource ID                      : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers
                                   /Microsoft.KeyVault/vaults/contoso03vault
Vault URI                        : https://contoso03vault.vault.azure.net/
Tenant ID                        : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
SKU                              : Standard
Enabled For Deployment?          : True
Enabled For Template Deployment? : False
Enabled For Disk Encryption?     : False
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                        : create, import, delete, list
                                   Permissions to Secrets                     : set, delete
                                   Permissions to Certificates                :
                                   Permissions to (Key Vault Managed) Storage :

Tags                             :

Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToSecrets set,delete,get -PassThru

Vault Name                       : Contoso03Vault
Resource Group Name              : myrg
Location                         : westus
Resource ID                      : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers
                                   /Microsoft.KeyVault/vaults/contoso03vault
Vault URI                        : https://contoso03vault.vault.azure.net/
Tenant ID                        : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
SKU                              : Standard
Enabled For Deployment?          : True
Enabled For Template Deployment? : False
Enabled For Disk Encryption?     : False
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                        : create, import, delete, list
                                   Permissions to Secrets                     : set, delete, get
                                   Permissions to Certificates                :
                                   Permissions to (Key Vault Managed) Storage :

Tags                             :

Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToKeys @() -PassThru

Vault Name                       : Contoso03Vault
Resource Group Name              : myrg
Location                         : westus
Resource ID                      : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers
                                   /Microsoft.KeyVault/vaults/contoso03vault
Vault URI                        : https://contoso03vault.vault.azure.net/
Tenant ID                        : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
SKU                              : Standard
Enabled For Deployment?          : True
Enabled For Template Deployment? : False
Enabled For Disk Encryption?     : False
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                        :
                                   Permissions to Secrets                     : set, delete, get
                                   Permissions to Certificates                :
                                   Permissions to (Key Vault Managed) Storage :

Tags                             :

Pierwsze polecenie udziela uprawnień użytkownikowi w identyfikatorze Entra firmy Microsoft, PattiFuller@contoso.com, w celu wykonywania operacji na kluczach i wpisach tajnych z magazynem kluczy o nazwie Contoso03Vault. Parametr PassThru powoduje zwrócenie zaktualizowanego obiektu przez polecenie cmdlet. Drugie polecenie modyfikuje uprawnienia, które zostały przyznane PattiFuller@contoso.com w pierwszym poleceniu, aby teraz umożliwić uzyskiwanie wpisów tajnych oprócz ustawiania i usuwania ich. Uprawnienia do operacji kluczy pozostają niezmienione po tym poleceniu. Ostatnie polecenie dodatkowo modyfikuje istniejące uprawnienia, PattiFuller@contoso.com aby usunąć wszystkie uprawnienia do operacji kluczy. Uprawnienia do operacji wpisów tajnych pozostają niezmienione po tym poleceniu.

Przykład 2. Udzielanie uprawnień dla jednostki usługi aplikacji w celu odczytywania i zapisywania wpisów tajnych

Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ServicePrincipalName 'http://payroll.contoso.com' -PermissionsToSecrets Get,Set

To polecenie przyznaje uprawnienia aplikacji dla magazynu kluczy o nazwie Contoso03Vault. Parametr ServicePrincipalName określa aplikację. Aplikacja musi być zarejestrowana w identyfikatorze Entra firmy Microsoft. Wartość parametru ServicePrincipalName musi być nazwą główną usługi aplikacji lub identyfikatorem GUID identyfikatora aplikacji. W tym przykładzie określa nazwę http://payroll.contoso.comgłówną usługi , a polecenie przyznaje aplikacji uprawnienia do odczytu i zapisu wpisów tajnych.

Przykład 3. Udzielanie uprawnień dla aplikacji przy użyciu identyfikatora obiektu

Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ObjectId 34595082-9346-41b6-8d6b-295a2808b8db -PermissionsToSecrets Get,Set

To polecenie przyznaje aplikacji uprawnienia do odczytu i zapisu wpisów tajnych. W tym przykładzie określa aplikację przy użyciu identyfikatora obiektu jednostki usługi aplikacji.

Przykład 4. Udzielanie uprawnień dla głównej nazwy użytkownika

Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToSecrets Get,List,Set

To polecenie umożliwia uzyskanie, wyświetlenie listy i ustawienie uprawnień dla określonej głównej nazwy użytkownika w celu uzyskania dostępu do wpisów tajnych.

Przykład 5. Włączanie pobierania wpisów tajnych z magazynu kluczy przez dostawcę zasobów Microsoft.Compute

Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -EnabledForDeployment

To polecenie przyznaje uprawnienia do pobierania wpisów tajnych z magazynu kluczy Contoso03Vault przez dostawcę zasobów Microsoft.Compute.

Przykład 6. Udzielanie uprawnień grupie zabezpieczeń

Get-AzADGroup
Set-AzKeyVaultAccessPolicy -VaultName 'myownvault' -ObjectId (Get-AzADGroup -SearchString 'group2')[0].Id -PermissionsToKeys get, set -PermissionsToSecrets get, set

Pierwsze polecenie używa polecenia cmdlet Get-AzADGroup, aby pobrać wszystkie grupy usługi Active Directory. W danych wyjściowych zobaczysz 3 zwrócone grupy o nazwie group1, group2 i group3. Wiele grup może mieć taką samą nazwę, ale zawsze ma unikatowy identyfikator ObjectId. Gdy zwracana jest więcej niż jedna grupa o tej samej nazwie, użyj identyfikatora ObjectId w danych wyjściowych, aby zidentyfikować grupę, której chcesz użyć. Następnie użyjesz danych wyjściowych tego polecenia z Set-AzKeyVaultAccessPolicy, aby udzielić uprawnień grupie group2 dla magazynu kluczy o nazwie myownvault. W tym przykładzie wyliczane są grupy o nazwie "group2" w tym samym wierszu polecenia. Na zwracanej liście może znajdować się wiele grup o nazwie "group2". Ten przykład wybiera pierwszy, wskazywany przez indeks [0] na zwracanej liście.

Przykład 7. Udzielanie usłudze Azure Information Protection dostępu do klucza dzierżawy zarządzanego przez klienta (BYOK)

Set-AzKeyVaultAccessPolicy -VaultName 'Contoso04Vault' -ServicePrincipalName 'MyServicePrincipal' -PermissionsToKeys decrypt,sign,get

To polecenie autoryzuje usługę Azure Information Protection do używania klucza zarządzanego przez klienta (scenariusz bring your own key lub "BYOK") jako klucza dzierżawy usługi Azure Information Protection. Po uruchomieniu tego polecenia określ własną nazwę magazynu kluczy, ale musisz określić parametr ServicePrincipalName i określić uprawnienia w przykładzie.

Parametry

-ApplicationId

Do użytku w przyszłości.

Właściwości parametru

Typ:

Nullable<T>[Guid]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

ByObjectId
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByObjectId
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByObjectId
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-BypassObjectIdValidation

Umożliwia określenie identyfikatora obiektu bez sprawdzania poprawności, czy obiekt istnieje w identyfikatorze Entra firmy Microsoft. Użyj tego parametru tylko wtedy, gdy chcesz udzielić dostępu do magazynu kluczy do identyfikatora obiektu, który odwołuje się do delegowanej grupy zabezpieczeń z innej dzierżawy platformy Azure.

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

ByObjectId
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByObjectId
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByObjectId
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Confirm

Prosi o potwierdzenie przed uruchomieniem cmdletu.

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:por

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure

Właściwości parametru

Typ:IAzureContextContainer
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:AzContext, AzureRmContext, AzureCredential

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-EmailAddress

Określa adres e-mail użytkownika, któremu chcesz udzielić uprawnień. Ten adres e-mail musi istnieć w katalogu skojarzonym z bieżącą subskrypcją i być unikatowy.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

ByEmailAddress
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByEmailAddress
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByEmailAddress
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów: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.

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

ForVault
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectForVault
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdForVault
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-EnabledForDiskEncryption

Umożliwia usłudze Azure Disk Encryption pobieranie wpisów tajnych i odpakowywanie kluczy z tego magazynu kluczy.

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

ForVault
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectForVault
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdForVault
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów: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.

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

ForVault
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectForVault
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdForVault
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-InputObject

Obiekt usługi Key Vault

Właściwości parametru

Typ:PSKeyVaultIdentityItem
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

InputObjectByObjectId
Position:0
Obowiązkowe:True
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByServicePrincipalName
Position:0
Obowiązkowe:True
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByUserPrincipalName
Position:0
Obowiązkowe:True
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByEmailAddress
Position:0
Obowiązkowe:True
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectForVault
Position:0
Obowiązkowe:True
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ObjectId

Określa identyfikator obiektu użytkownika lub jednostki usługi w identyfikatorze Entra firmy Microsoft, dla którego mają być przyznane uprawnienia. Jego wartość jest w formacie GUID.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

ByObjectId
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByObjectId
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByObjectId
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-PassThru

Zwraca obiekt reprezentujący element, z którym pracujesz. Domyślnie to polecenie cmdlet nie generuje żadnych danych wyjściowych.

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-PermissionsToCertificates

Określa tablicę uprawnień certyfikatu do udzielenia użytkownikowi lub jednostce usługi. Opcja "Wszystkie" przyzna wszystkie uprawnienia z wyjątkiem "Przeczyszczanie" Dopuszczalne wartości dla tego parametru:

  • Wszystko
  • Pobierz
  • List
  • Usuń
  • Create
  • Import
  • Update
  • Zarządzaniekontaktami
  • Getissuers
  • Listissuers
  • Setissuers
  • Deleteissuers
  • Zarządzajissuers
  • Odzyskiwanie
  • Backup
  • Przywróć
  • Oczyszczenie

Właściwości parametru

Typ:

String[]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

ByUserPrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ByObjectId
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ByServicePrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ByEmailAddress
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByObjectId
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByServicePrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByUserPrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByEmailAddress
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByObjectId
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByServicePrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByUserPrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByEmailAddress
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-PermissionsToKeys

Określa tablicę uprawnień operacji klucza w celu udzielenia użytkownikowi lub jednostce usługi. Opcja "Wszystkie" przyzna wszystkie uprawnienia z wyjątkiem "Przeczyszczanie" Dopuszczalne wartości dla tego parametru:

  • Wszystko
  • Odszyfrować
  • Szyfrować
  • UnwrapKey
  • WrapKey
  • Verify
  • Znak
  • Pobierz
  • List
  • Update
  • Create
  • Import
  • Usuń
  • Backup
  • Przywróć
  • Odzyskiwanie
  • Oczyszczenie
  • Obracać

Właściwości parametru

Typ:

String[]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

ByUserPrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ByObjectId
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ByServicePrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ByEmailAddress
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByObjectId
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByServicePrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByUserPrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByEmailAddress
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByObjectId
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByServicePrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByUserPrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByEmailAddress
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-PermissionsToSecrets

Określa tablicę uprawnień operacji wpisu tajnego w celu udzielenia użytkownikowi lub jednostce usługi. Opcja "Wszystkie" przyzna wszystkie uprawnienia z wyjątkiem "Przeczyszczanie" Dopuszczalne wartości dla tego parametru:

  • Wszystko
  • Pobierz
  • List
  • Ustawienie
  • Usuń
  • Backup
  • Przywróć
  • Odzyskiwanie
  • Oczyszczenie

Właściwości parametru

Typ:

String[]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

ByUserPrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ByObjectId
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ByServicePrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ByEmailAddress
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByObjectId
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByServicePrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByUserPrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByEmailAddress
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByObjectId
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByServicePrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByUserPrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByEmailAddress
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-PermissionsToStorage

Określa zarządzane konto magazynu i uprawnienia operacji saS-definition, aby przyznać użytkownikowi lub jednostce usługi. Opcja "Wszystkie" przyzna wszystkie uprawnienia z wyjątkiem "Przeczyszczanie" Dopuszczalne wartości dla tego parametru:

  • all
  • pobranie
  • list
  • usunąć
  • set
  • aktualizacja
  • regeneratekey
  • getsas
  • listas
  • deletesas
  • zestawy
  • recover
  • kopia zapasowa
  • przywracać
  • przeczyścić

Właściwości parametru

Typ:

String[]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

ByUserPrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ByObjectId
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ByServicePrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ByEmailAddress
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByObjectId
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByServicePrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByUserPrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByEmailAddress
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByObjectId
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByServicePrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByUserPrincipalName
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByEmailAddress
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ResourceGroupName

Określa nazwę grupy zasobów.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

ByUserPrincipalName
Position:1
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ByObjectId
Position:1
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ByServicePrincipalName
Position:1
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ByEmailAddress
Position:1
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ForVault
Position:1
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ResourceId

Identyfikator zasobu usługi Key Vault

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

ResourceIdByObjectId
Position:0
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False
ResourceIdByServicePrincipalName
Position:0
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False
ResourceIdByUserPrincipalName
Position:0
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False
ResourceIdByEmailAddress
Position:0
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False
ResourceIdForVault
Position:0
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-ServicePrincipalName

Określa nazwę główną usługi aplikacji, do której mają być przyznane uprawnienia. Określ identyfikator aplikacji, znany również jako identyfikator klienta zarejestrowany dla aplikacji w identyfikatorze Entra firmy Microsoft. Aplikacja o nazwie głównej usługi, którą określa ten parametr, musi być zarejestrowana w katalogu platformy Azure, który zawiera bieżącą subskrypcję.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:główna nazwa usługi

Zestawy parametrów

ByServicePrincipalName
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByServicePrincipalName
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByServicePrincipalName
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów: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.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-UserPrincipalName

Określa główną nazwę użytkownika, któremu należy udzielić uprawnień. Ta główna nazwa użytkownika musi istnieć w katalogu skojarzonym z bieżącą subskrypcją.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:nazwa UPN

Zestawy parametrów

ByUserPrincipalName
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
InputObjectByUserPrincipalName
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceIdByUserPrincipalName
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-VaultName

Określa nazwę magazynu kluczy. To polecenie cmdlet modyfikuje zasady dostępu dla magazynu kluczy, który określa ten parametr.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

ByUserPrincipalName
Position:0
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ByObjectId
Position:0
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ByServicePrincipalName
Position:0
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ByEmailAddress
Position:0
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ForVault
Position:0
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-WhatIf

Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Cmdlet nie jest uruchomiony.

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:Wi

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

PSKeyVaultIdentityItem

String

Dane wyjściowe

PSKeyVault