Edit

Get-AzContainerRegistryReplication

  • Reference
Module:
Az.ContainerRegistry

Gets the properties of the specified replication.

Syntax

Get-AzContainerRegistryReplication
   -RegistryName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzContainerRegistryReplication
   -RegistryName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -Name <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzContainerRegistryReplication
   -InputObject <IContainerRegistryIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzContainerRegistryReplication
   -Registry <IRegistry>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets the properties of the specified replication.

Examples

Example 1: Gets all the replications of a container registry

Get-AzContainerRegistryReplication -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample"

Name           Location ProvisioningState StatusTimestamp
----           -------- ----------------- ---------------
replication001 westus   Succeeded         1/19/2023 5:57:00 AM
eastus2        eastus2  Succeeded         1/19/2023 5:56:51 AM

Gets all the replications of a container registry

Example 2: Gets a specified replication of a container registry

Get-AzContainerRegistryReplication -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample"  -Name "replication001"

Name           Location ProvisioningState StatusTimestamp
----           -------- ----------------- ---------------
replication001 westus   Succeeded         1/19/2023 5:57:00 AM

Gets a specified replication of a container registry

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

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 replication.

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

-Registry

The Registry Object. To construct, see NOTES section for REGISTRY properties and create a hash table.

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

-RegistryName

The name of the container registry.

Type:String
Aliases:ContainerRegistryName
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

Inputs

IRegistry

IContainerRegistryIdentity

Outputs

IReplication

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.

REGISTRY <IRegistry>: The Registry Object.

  • Location <String>: The location of the resource. This cannot be changed after the resource is created.
  • SkuName <SkuName>: The SKU name of the container registry. Required for registry creation.
  • [SystemDataCreatedAt <DateTime?>]: The timestamp of resource creation (UTC).
  • [SystemDataCreatedBy <String>]: The identity that created the resource.
  • [SystemDataCreatedByType <CreatedByType?>]: The type of identity that created the resource.
  • [SystemDataLastModifiedAt <DateTime?>]: The timestamp of resource modification (UTC).
  • [SystemDataLastModifiedBy <String>]: The identity that last modified the resource.
  • [SystemDataLastModifiedByType <LastModifiedByType?>]: The type of identity that last modified the resource.
  • [Tag <IResourceTags>]: The tags of the resource.
    • [(Any) <String>]: This indicates any property can be added to this object.
  • [AdminUserEnabled <Boolean?>]: The value that indicates whether the admin user is enabled.
  • [AnonymousPullEnabled <Boolean?>]: Enables registry-wide pull from unauthenticated clients.
  • [AzureAdAuthenticationAsArmPolicyStatus <AzureAdAuthenticationAsArmPolicyStatus?>]: The value that indicates whether the policy is enabled or not.
  • [DataEndpointEnabled <Boolean?>]: Enable a single data endpoint per region for serving data.
  • [EncryptionStatus <EncryptionStatus?>]: Indicates whether or not the encryption is enabled for container registry.
  • [ExportPolicyStatus <ExportPolicyStatus?>]: The value that indicates whether the policy is enabled or not.
  • [IdentityPrincipalId <String>]: The principal ID of resource identity.
  • [IdentityTenantId <String>]: The tenant ID of resource.
  • [IdentityType <ResourceIdentityType?>]: The identity type.
  • [IdentityUserAssignedIdentity <IIdentityPropertiesUserAssignedIdentities>]: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    • [(Any) <IUserIdentityProperties>]: This indicates any property can be added to this object.
  • [KeyVaultPropertyIdentity <String>]: The client id of the identity which will be used to access key vault.
  • [KeyVaultPropertyKeyIdentifier <String>]: Key vault uri to access the encryption key.
  • [NetworkRuleBypassOption <NetworkRuleBypassOptions?>]: Whether to allow trusted Azure services to access a network restricted registry.
  • [NetworkRuleSetDefaultAction <DefaultAction?>]: The default action of allow or deny when no other rules match.
  • [NetworkRuleSetIPRule <IIPRule[]>]: The IP ACL rules.
    • IPAddressOrRange <String>: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.
    • [Action <Action?>]: The action of IP ACL rule.
  • [PublicNetworkAccess <PublicNetworkAccess?>]: Whether or not public network access is allowed for the container registry.
  • [QuarantinePolicyStatus <PolicyStatus?>]: The value that indicates whether the policy is enabled or not.
  • [RetentionPolicyDay <Int32?>]: The number of days to retain an untagged manifest after which it gets purged.
  • [RetentionPolicyStatus <PolicyStatus?>]: The value that indicates whether the policy is enabled or not.
  • [SoftDeletePolicyRetentionDay <Int32?>]: The number of days after which a soft-deleted item is permanently deleted.
  • [SoftDeletePolicyStatus <PolicyStatus?>]: The value that indicates whether the policy is enabled or not.
  • [TrustPolicyStatus <PolicyStatus?>]: The value that indicates whether the policy is enabled or not.
  • [TrustPolicyType <TrustPolicyType?>]: The type of trust policy.
  • [ZoneRedundancy <ZoneRedundancy?>]: Whether or not zone redundancy is enabled for this container registry