Update-AzContainerRegistryToken

Module:

Az.ContainerRegistry

Updates a token with the specified parameters.

Syntax

Update-AzContainerRegistryToken
      -Name <String>
      -RegistryName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-CredentialsCertificate <ITokenCertificate[]>]
      [-CredentialsPassword <ITokenPassword[]>]
      [-ScopeMapId <String>]
      [-Status <TokenStatus>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzContainerRegistryToken
      -InputObject <IContainerRegistryIdentity>
      [-CredentialsCertificate <ITokenCertificate[]>]
      [-CredentialsPassword <ITokenPassword[]>]
      [-ScopeMapId <String>]
      [-Status <TokenStatus>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Updates a token with the specified parameters.

Examples

Example 1: Update token scope map for a token

Update-AzContainerRegistryToken -name token -ScopeMapId /subscriptions/${subscription}/resourceGroups/myResourceGroups/providers/Microsoft.ContainerRegistry/registry/MyRegistries/scopeMaps/test -RegistryName MyRegistry -ResourceGroupName myResourceGroups

Name   SystemDataCreatedAt SystemDataCreatedBy       SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLa
                                                                                                      stModifiedBy
----   ------------------- -------------------       ----------------------- ------------------------ ------------
token 01/20/2023 05:59:56  user@microsoft.com User                    01/20/2023 05:59:56             user

Update token scope map for a token

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IContainerRegistryIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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

Inputs

IContainerRegistryIdentity

Outputs

IToken

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"

INPUTOBJECT <IContainerRegistryIdentity>: Identity Parameter

• [AgentPoolName <String>]: The name of the agent pool.
• [CacheRuleName <String>]: The name of the cache rule.
• [ConnectedRegistryName <String>]: The name of the connected registry.
• [CredentialSetName <String>]: The name of the credential set.
• [ExportPipelineName <String>]: The name of the export pipeline.
• [GroupName <String>]: The name of the private link resource.
• [Id <String>]: Resource identity path
• [ImportPipelineName <String>]: The name of the import pipeline.
• [PipelineRunName <String>]: The name of the pipeline run.
• [PrivateEndpointConnectionName <String>]: The name of the private endpoint connection.
• [RegistryName <String>]: The name of the container registry.
• [ReplicationName <String>]: The name of the replication.
• [ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.
• [RunId <String>]: The run ID.
• [ScopeMapName <String>]: The name of the scope map.
• [SubscriptionId <String>]: The ID of the target subscription. The value must be an UUID.
• [TaskName <String>]: The name of the container registry task.
• [TaskRunName <String>]: The name of the task run.
• [TokenName <String>]: The name of the token.
• [WebhookName <String>]: The name of the webhook.