Skip to content

Get-AzAppConfigurationReplica.md

Latest commit

 

History

History
193 lines (148 loc) · 4.64 KB

Get-AzAppConfigurationReplica.md

File metadata and controls

193 lines (148 loc) · 4.64 KB
external help file
Module Name Az.AppConfiguration
online version https://learn.microsoft.com/powershell/module/az.appconfiguration/get-azappconfigurationreplica
schema 2.0.0

Get-AzAppConfigurationReplica

SYNOPSIS

Gets the properties of the specified replica.

SYNTAX

List (Default)

Get-AzAppConfigurationReplica -ConfigStoreName <String> -ResourceGroupName <String>
 [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>]

Get

Get-AzAppConfigurationReplica -ConfigStoreName <String> -Name <String> -ResourceGroupName <String>
 [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>]

GetViaIdentity

Get-AzAppConfigurationReplica -InputObject <IAppConfigurationIdentity> [-DefaultProfile <PSObject>]
 [<CommonParameters>]

GetViaIdentityConfigurationStore

Get-AzAppConfigurationReplica -ConfigurationStoreInputObject <IAppConfigurationIdentity> -Name <String>
 [-DefaultProfile <PSObject>] [<CommonParameters>]

DESCRIPTION

Gets the properties of the specified replica.

EXAMPLES

Example 1: List all replicas of an app configuration store

Get-AzAppConfigurationReplica -ConfigStoreName azpstest-appstore -ResourceGroupName azpstest_gp
Name            Location  ProvisioningState ResourceGroupName
----            --------  ----------------- -----------------
westus2replica  westus2   Succeeded         azpstest_gp
eastusreplica   eastus    Succeeded         azpstest_gp

This command lists all replicas of the specified app configuration store.

Example 2: Get a specific replica of an app configuration store

Get-AzAppConfigurationReplica -ConfigStoreName azpstest-appstore -ResourceGroupName azpstest_gp -Name westus2replica
Name            Location  ProvisioningState ResourceGroupName
----            --------  ----------------- -----------------
westus2replica  westus2   Succeeded         azpstest_gp

This command gets the properties of a specific replica by name.

PARAMETERS

-ConfigStoreName

The name of the configuration store.

Type: System.String
Parameter Sets: Get, List
Aliases:

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

-ConfigurationStoreInputObject

Identity Parameter

Type: Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.IAppConfigurationIdentity
Parameter Sets: GetViaIdentityConfigurationStore
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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: System.Management.Automation.PSObject
Parameter Sets: (All)
Aliases: AzureRMContext, AzureCredential

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

-InputObject

Identity Parameter

Type: Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.IAppConfigurationIdentity
Parameter Sets: GetViaIdentity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

The name of the replica.

Type: System.String
Parameter Sets: Get, GetViaIdentityConfigurationStore
Aliases: ReplicaName

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

-ResourceGroupName

The name of the resource group to which the container registry belongs.

Type: System.String
Parameter Sets: Get, List
Aliases:

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

-SubscriptionId

The Microsoft Azure subscription ID.

Type: System.String[]
Parameter Sets: Get, List
Aliases:

Required: False
Position: Named
Default value: (Get-AzContext).Subscription.Id
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.IAppConfigurationIdentity

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.IReplica

NOTES

RELATED LINKS