< Back
Get-AadrmKeys
Post
NAME Get-AadrmKeys
SYNOPSIS
Lists all tenant keys associated with your Rights Management tenant.
SYNTAX
Get-AadrmKeys [<CommonParameters>]
DESCRIPTION
The Get-AadrmKeys cmdlet lists all tenant keys associated with your tenant for the Azure Rights Management
service. The tenant keys include the initial tenant key that Microsoft generates for you, and any tenant keys that
are stored in Azure Key Vault. For more information, see Planning and implementing your Azure Information
Protection tenant key (https://docs.microsoft.com/information- ... tenant-key).
You must use PowerShell to configure your tenant key; you cannot do this configuration by using a management
portal.
For security reasons, the cmdlet does not display the value of the tenant keys.
When you run this cmdlet, you will see Status and KeyType :
- The Status value shows Archived or Active . Archived identifies a tenant key that can be used to open previously
protected content. Active identities the tenant key is currently in use to protect content.
- The KeyType value shows Microsoft-managed or Customer-managed (BYOK) . Microsoft-managed identifies the tenant
key as managed by Microsoft (the default). Customer-managed identifies the tenant key as managed by your
organization in Azure Key Vault. For a customer-managed key, you also see Publickey , which shows the base-64
encoded public key that is associated with the KeyIdentifier and that corresponds to the same information that
Azure Key Vault provides for your key.
For security reasons, the cmdlet does not display the value of the Microsoft-managed key and displays only the
public key information of customer-managed (BYOK) keys.
PARAMETERS
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
--------------------- Example 1: Get keys ---------------------
PS C:\\>Get-AadrmKeys
This command lists all tenant keys associated with your tenant for the Azure Rights Management service.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=400611
Add-AadrmKey
Import-AadrmTpd
Planning and implementing your Azure Information Protection tenant key
https://docs.microsoft.com/information- ... tenant-key
SYNOPSIS
Lists all tenant keys associated with your Rights Management tenant.
SYNTAX
Get-AadrmKeys [<CommonParameters>]
DESCRIPTION
The Get-AadrmKeys cmdlet lists all tenant keys associated with your tenant for the Azure Rights Management
service. The tenant keys include the initial tenant key that Microsoft generates for you, and any tenant keys that
are stored in Azure Key Vault. For more information, see Planning and implementing your Azure Information
Protection tenant key (https://docs.microsoft.com/information- ... tenant-key).
You must use PowerShell to configure your tenant key; you cannot do this configuration by using a management
portal.
For security reasons, the cmdlet does not display the value of the tenant keys.
When you run this cmdlet, you will see Status and KeyType :
- The Status value shows Archived or Active . Archived identifies a tenant key that can be used to open previously
protected content. Active identities the tenant key is currently in use to protect content.
- The KeyType value shows Microsoft-managed or Customer-managed (BYOK) . Microsoft-managed identifies the tenant
key as managed by Microsoft (the default). Customer-managed identifies the tenant key as managed by your
organization in Azure Key Vault. For a customer-managed key, you also see Publickey , which shows the base-64
encoded public key that is associated with the KeyIdentifier and that corresponds to the same information that
Azure Key Vault provides for your key.
For security reasons, the cmdlet does not display the value of the Microsoft-managed key and displays only the
public key information of customer-managed (BYOK) keys.
PARAMETERS
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
--------------------- Example 1: Get keys ---------------------
PS C:\\>Get-AadrmKeys
This command lists all tenant keys associated with your tenant for the Azure Rights Management service.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=400611
Add-AadrmKey
Import-AadrmTpd
Planning and implementing your Azure Information Protection tenant key
https://docs.microsoft.com/information- ... tenant-key