Remove-AzKeyVaultAccessPolicy

  • Riferimento
Modulo:
Az.KeyVault

Rimuove tutte le autorizzazioni per un utente o un'applicazione da un insieme di credenziali delle chiavi.

Sintassi

Remove-AzKeyVaultAccessPolicy
      [-VaultName] <String>
      [[-ResourceGroupName] <String>]
      -UserPrincipalName <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultAccessPolicy
      [-VaultName] <String>
      [[-ResourceGroupName] <String>]
      -ObjectId <String>
      [-ApplicationId <Guid>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultAccessPolicy
      [-VaultName] <String>
      [[-ResourceGroupName] <String>]
      -ServicePrincipalName <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultAccessPolicy
      [-VaultName] <String>
      [[-ResourceGroupName] <String>]
      -EmailAddress <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultAccessPolicy
      [-VaultName] <String>
      [[-ResourceGroupName] <String>]
      [-EnabledForDeployment]
      [-EnabledForTemplateDeployment]
      [-EnabledForDiskEncryption]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultAccessPolicy
      [-InputObject] <PSKeyVault>
      -ObjectId <String>
      [-ApplicationId <Guid>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultAccessPolicy
      [-InputObject] <PSKeyVault>
      -ServicePrincipalName <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultAccessPolicy
      [-InputObject] <PSKeyVault>
      -UserPrincipalName <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultAccessPolicy
      [-InputObject] <PSKeyVault>
      -EmailAddress <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultAccessPolicy
      [-InputObject] <PSKeyVault>
      [-EnabledForDeployment]
      [-EnabledForTemplateDeployment]
      [-EnabledForDiskEncryption]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultAccessPolicy
      [-ResourceId] <String>
      -ObjectId <String>
      [-ApplicationId <Guid>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultAccessPolicy
      [-ResourceId] <String>
      -ServicePrincipalName <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultAccessPolicy
      [-ResourceId] <String>
      -UserPrincipalName <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultAccessPolicy
      [-ResourceId] <String>
      -EmailAddress <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultAccessPolicy
      [-ResourceId] <String>
      [-EnabledForDeployment]
      [-EnabledForTemplateDeployment]
      [-EnabledForDiskEncryption]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]

Descrizione

Il cmdlet Remove-AzKeyVaultAccessPolicy rimuove tutte le autorizzazioni per un utente o un'applicazione o per tutti gli utenti e le applicazioni da un insieme di credenziali delle chiavi. Anche se si rimuovono tutte le autorizzazioni, il proprietario della sottoscrizione di Azure che contiene l'insieme di credenziali delle chiavi può aggiungere autorizzazioni all'insieme di credenziali delle chiavi. Si noti che anche se l'impostazione del gruppo di risorse è facoltativa per questo cmdlet, è consigliabile farlo per ottenere prestazioni migliori.

Il cmdlet può chiamare sotto l'API Microsoft Graph in base ai parametri di input:

  • GET /directoryObjects/{id}
  • GET /users/{id}
  • GET /users
  • GET /servicePrincipals/{id}
  • GET /servicePrincipals
  • GET /groups/{id}

Esempio

Esempio 1: Rimuovere le autorizzazioni per un utente

Remove-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -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?          : 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                        :
                                   Permissions to Secrets                     :
                                   Permissions to Certificates                : get, create
                                   Permissions to (Key Vault Managed) Storage :


Network Rule Set                 :
                                   Default Action                             : Allow
                                   Bypass                                     : AzureServices
                                   IP Rules                                   :
                                   Virtual Network Rules                      :

Tags                             :

Questo comando rimuove tutte le autorizzazioni che un utente PattiFuller@contoso.com ha nell'insieme di credenziali delle chiavi denominato Contoso03Vault. Se si specifica -PassThru, viene restituito l'oggetto KeyVault.

Esempio 2: Rimuovere le autorizzazioni per un'applicazione

Remove-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ServicePrincipalName 'http://payroll.contoso.com'

Questo comando rimuove tutte le autorizzazioni di un'applicazione nell'insieme di credenziali delle chiavi denominato Contoso03Vault. In questo esempio viene identificata l'applicazione usando il nome dell'entità servizio registrato in Microsoft Entra ID, http://payroll.contoso.com.

Esempio 3: Rimuovere le autorizzazioni per un'applicazione usando il relativo ID oggetto

Remove-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ObjectID 34595082-9346-41b6-8d6b-295a2808b8db

Questo comando rimuove tutte le autorizzazioni di un'applicazione nell'insieme di credenziali delle chiavi denominato Contoso03Vault. Questo esempio identifica l'applicazione in base all'ID oggetto dell'entità servizio.

Esempio 4: Rimuovere le autorizzazioni per il provider di risorse Microsoft.Compute

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

Questo comando rimuove l'autorizzazione per il provider di risorse Microsoft.Compute per ottenere segreti da Contoso03Vault.

Parametri

-ApplicationId

Specifica l'ID dell'applicazione le cui autorizzazioni devono essere rimosse

Type:Nullable<T>[Guid]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Richiede conferma prima di eseguire il cmdlet.

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

-DefaultProfile

Credenziali, account, tenant e sottoscrizione usati per la comunicazione con Azure

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

-EmailAddress

Specifica l'indirizzo di posta elettronica dell'utente di cui si desidera rimuovere l'accesso.

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

-EnabledForDeployment

Se specificato, disabilita il recupero dei segreti da questo insieme di credenziali delle chiavi dal provider di risorse Microsoft.Compute quando si fa riferimento alla creazione di risorse.

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

-EnabledForDiskEncryption

Se specificato, disabilita il recupero dei segreti da questo insieme di credenziali delle chiavi Crittografia dischi di Azure.

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

-EnabledForTemplateDeployment

Se specificato, disabilita il recupero dei segreti da questo insieme di credenziali delle chiavi da Azure Resource Manager quando si fa riferimento ai modelli.

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

-InputObject

Oggetto Key Vault.

Type:PSKeyVault
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ObjectId

Specifica l'ID oggetto dell'utente o dell'entità servizio in Microsoft Entra ID per cui rimuovere le autorizzazioni.

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

-PassThru

Restituisce un oggetto che rappresenta l'elemento in uso. Per impostazione predefinita, il cmdlet non genera alcun output.

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

-ResourceGroupName

Specifica il nome del gruppo di risorse associato all'insieme di credenziali delle chiavi di cui vengono modificati i criteri di accesso. Se non specificato, questo cmdlet cerca l'insieme di credenziali delle chiavi nella sottoscrizione corrente.

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

-ResourceId

ID risorsa KeyVault.

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

-ServicePrincipalName

Specifica il nome dell'entità servizio dell'applicazione le cui autorizzazioni si desidera rimuovere. Specificare l'ID applicazione, noto anche come ID client, registrato per l'applicazione in Microsoft Entra ID.

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

-SubscriptionId

ID della sottoscrizione. Per impostazione predefinita, i cmdlet vengono eseguiti nella sottoscrizione impostata nel contesto corrente. Se l'utente specifica un'altra sottoscrizione, il cmdlet corrente viene eseguito nella sottoscrizione specificata dall'utente. L'override delle sottoscrizioni ha effetto solo durante il ciclo di vita del cmdlet corrente. Non modifica la sottoscrizione nel contesto e non influisce sui cmdlet successivi.

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

-UserPrincipalName

Specifica il nome dell'entità utente dell'utente di cui si desidera rimuovere l'accesso.

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

-VaultName

Specifica il nome dell'insieme di credenziali delle chiavi. Questo cmdlet rimuove le autorizzazioni per l'insieme di credenziali delle chiavi specificato da questo parametro.

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

-WhatIf

Mostra gli effetti dell'esecuzione del cmdlet. Il cmdlet non viene eseguito.

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

Input

PSKeyVault

String

Output

PSKeyVault