Edit

New-AzContainerRegistryCredentials

  • Reference
Module:
Az.ContainerRegistry

Generate keys for a token of a specified container registry.

Syntax

New-AzContainerRegistryCredentials
   -RegistryName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-Expiry <DateTime>]
   [-Name <TokenPasswordName>]
   [-TokenId <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzContainerRegistryCredentials
   -InputObject <IContainerRegistryIdentity>
   [-Expiry <DateTime>]
   [-Name <TokenPasswordName>]
   [-TokenId <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Generate keys for a token of a specified container registry.

Examples

Example 1: Generate keys for a token of a specified container registry.

New-AzContainerRegistryCredentials -TokenId /subscriptions/xxxx/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/mytoken -RegistryName myRegistry -ResourceGroupName MyResourceGroup

Username Password  Password2
-------- --------  ---------
token    xxxxxxxx  xxxxxxxxx

Generate keys for a token of a specified 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

-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

-Expiry

The expiry date of the generated credentials after which the credentials become invalid.

Type:DateTime
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

Specifies name of the password which should be regenerated if any -- password1 or password2.

Type:TokenPasswordName
Position:Named
Default value:None
Required:False
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

-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

-TokenId

The resource ID of the token for which credentials have to be generated.

Type:String
Position:Named
Default value:None
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

PSContainerRegistryCredential

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.

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.