New-AzContainerRegistryToken
Creates a token for a container registry with the specified parameters.
Syntax
New-AzContainerRegistryToken
-Name <String>
-RegistryName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-CredentialsCertificate <ITokenCertificate[]>]
[-CredentialsPassword <ITokenPassword[]>]
[-ScopeMapId <String>]
[-Status <TokenStatus>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Creates a token for a container registry with the specified parameters.
Examples
Example 1: Create new token for certain container registry
New-AzContainerRegistryToken -Name token2 -RegistryName lnxcr -ResourceGroupName lnxtest -ScopeMapId /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lnxtest/providers/Microsoft.ContainerRegistry/registries/lnxcr/scopeMaps/newmap
Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLa
stModifiedBy
---- ------------------- ------------------- ----------------------- ------------------------ ------------
token 01/20/2023 05:14:16 user@microsoft.com User 01/20/2023 05:14:16 userCreate new token for certain container registry
Parameters
-AsJob
Run the command as a job
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CredentialsCertificate
. To construct, see NOTES section for CREDENTIALSCERTIFICATE properties and create a hash table.
| Type: | ITokenCertificate[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CredentialsPassword
. To construct, see NOTES section for CREDENTIALSPASSWORD properties and create a hash table.
| Type: | ITokenPassword[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
The name of the token.
| Type: | String |
| Aliases: | TokenName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NoWait
Run the command asynchronously
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RegistryName
The name of the container registry.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ScopeMapId
The resource ID of the scope map to which the token will be associated with.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Status
The status of the token example enabled or disabled.
| Type: | TokenStatus |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription. The value must be an UUID.
| Type: | String |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
Notes
ALIASES
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
CREDENTIALSCERTIFICATE <ITokenCertificate[]>: .
[EncodedPemCertificate <String>]: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token.[Expiry <DateTime?>]: The expiry datetime of the certificate.[Name <TokenCertificateName?>]:[Thumbprint <String>]: The thumbprint of the certificate.
CREDENTIALSPASSWORD <ITokenPassword[]>: .
[CreationTime <DateTime?>]: The creation datetime of the password.[Expiry <DateTime?>]: The expiry datetime of the password.[Name <TokenPasswordName?>]: The password name "password1" or "password2"