Get-AzFleet

  • Reference
Module:
Az.Fleet

Gets a Fleet.

Syntax

Get-AzFleet
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzFleet
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzFleet
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzFleet
   -InputObject <IFleetIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets a Fleet.

Examples

Example 1: Lists the Fleet resources in a subscription

Get-AzFleet

Location Name SystemDataCreatedAt   SystemDataCreatedBy   SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ETag                                   ResourceGroupName
-------- ---- -------------------   -------------------   ----------------------- ------------------------ ------------------------ ---------------------------- ----                                   -----------------
eastus   sss  11/14/2023 8:05:54 AM user1@example.com     User                    11/14/2023 8:05:54 AM    user1@example.com        User                         "25052d24-0000-0100-0000-65532a620000" ps1-test
eastus   ttt  11/14/2023 9:55:13 AM user1@example.com     User                    11/14/2023 9:55:13 AM    user1@example.com        User                         "29054cbc-0000-0100-0000-655344020000" ps1-test

This command lists the Fleet resources in a subscription.

Example 2: Get specific fleet with specified name

Get-AzFleet -Name testfleet01 -ResourceGroupName K8sFleet-Test

ETag                         : "61052549-0000-0100-0000-65542ab10000"
Id                           : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/Microsoft.ContainerService/fleets/testfleet01
IdentityPrincipalId          : 
IdentityTenantId             : 
IdentityType                 : 
IdentityUserAssignedIdentity : {
                               }
Location                     : eastus
Name                         : testfleet01
ProvisioningState            : Succeeded
ResourceGroupName            : K8sFleet-Test
SystemDataCreatedAt          : 11/15/2023 2:19:28 AM
SystemDataCreatedBy          : user1@example.com
SystemDataCreatedByType      : User
SystemDataLastModifiedAt     : 11/15/2023 2:19:28 AM
SystemDataLastModifiedBy     : user1@example.com
SystemDataLastModifiedByType : User
Tag                          : {
                               }
Type                         : Microsoft.ContainerService/fleets

This command gets specific fleet with specified name.

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

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

-Name

The name of the Fleet resource.

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

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

Inputs

IFleetIdentity

Outputs

IFleet