Get-AzContainerRegistryAgentPool
Gets the detailed information for a given agent pool.
Syntax
Get-AzContainerRegistryAgentPool
-RegistryName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzContainerRegistryAgentPool
-Name <String>
-RegistryName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzContainerRegistryAgentPool
-InputObject <IContainerRegistryIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Gets the detailed information for a given agent pool.
Examples
Example 1: Get the agent pool of an registry
Get-AzContainerRegistryAgentPool -RegistryName RegistryExample -ResourceGroupName MyResourceGroup
Name Location OS Count ProvisioningState
---- -------- -- ----- -----------------
agent eastus Linux 5 Succeeded
Get the agent pool of an registry
Parameters
-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 agent pool.
Type: | String |
Aliases: | AgentPoolName |
Position: | Named |
Default value: | None |
Required: | True |
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 to which the container registry belongs.
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
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.
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.