FleetsImpl | @azure/arm-containerservice

Class containing Fleets operations.

Hierarchy

FleetsImpl

Implements

Fleets

Index

Constructors

constructor

Methods

Constructors

constructor

new FleetsImpl(client: ContainerServiceClient): FleetsImpl

- Defined in operations/fleets.ts:41
Initialize a new instance of the class Fleets class.

Parameters
- client: ContainerServiceClient
  
  Reference to the service client
Returns FleetsImpl

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, fleetName: string, parameters: Fleet, options?: FleetsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<FleetsCreateOrUpdateResponse>, FleetsCreateOrUpdateResponse>>

Implementation of Fleets.beginCreateOrUpdate
- Defined in operations/fleets.ts:153
Creates or updates a Fleet.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- fleetName: string
  
  The name of the Fleet resource.
- parameters: Fleet
  
  The Fleet to create or update.
- Optional options: FleetsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<FleetsCreateOrUpdateResponse>, FleetsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, fleetName: string, parameters: Fleet, options?: FleetsCreateOrUpdateOptionalParams): Promise<FleetsCreateOrUpdateResponse>

Implementation of Fleets.beginCreateOrUpdateAndWait
- Defined in operations/fleets.ts:223
Creates or updates a Fleet.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- fleetName: string
  
  The name of the Fleet resource.
- parameters: Fleet
  
  The Fleet to create or update.
- Optional options: FleetsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<FleetsCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, fleetName: string, options?: FleetsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of Fleets.beginDelete
- Defined in operations/fleets.ts:278
Deletes a Fleet.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- fleetName: string
  
  The name of the Fleet resource.
- Optional options: FleetsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, fleetName: string, options?: FleetsDeleteOptionalParams): Promise<void>

Implementation of Fleets.beginDeleteAndWait
- Defined in operations/fleets.ts:342
Deletes a Fleet.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- fleetName: string
  
  The name of the Fleet resource.
- Optional options: FleetsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, fleetName: string, options?: FleetsGetOptionalParams): Promise<FleetsGetResponse>

Implementation of Fleets.get
- Defined in operations/fleets.ts:261
Gets a Fleet.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- fleetName: string
  
  The name of the Fleet resource.
- Optional options: FleetsGetOptionalParams
  
  The options parameters.
Returns Promise<FleetsGetResponse>

list

list(options?: FleetsListOptionalParams): PagedAsyncIterableIterator<Fleet>

Implementation of Fleets.list
- Defined in operations/fleets.ts:108
Lists fleets in the specified subscription.

Parameters
- Optional options: FleetsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Fleet>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: FleetsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Fleet>

Implementation of Fleets.listByResourceGroup
- Defined in operations/fleets.ts:56
Lists fleets in the specified subscription and resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: FleetsListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Fleet>

listCredentials

listCredentials(resourceGroupName: string, fleetName: string, options?: FleetsListCredentialsOptionalParams): Promise<FleetsListCredentialsResponse>

Implementation of Fleets.listCredentials
- Defined in operations/fleets.ts:386
Lists the user credentials of a Fleet.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- fleetName: string
  
  The name of the Fleet resource.
- Optional options: FleetsListCredentialsOptionalParams
  
  The options parameters.
Returns Promise<FleetsListCredentialsResponse>

update

update(resourceGroupName: string, fleetName: string, options?: FleetsUpdateOptionalParams): Promise<FleetsUpdateResponse>

Implementation of Fleets.update
- Defined in operations/fleets.ts:244
Patches a fleet resource.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- fleetName: string
  
  The name of the Fleet resource.
- Optional options: FleetsUpdateOptionalParams
  
  The options parameters.
Returns Promise<FleetsUpdateResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ContainerServiceClient

Returns FleetsImpl

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

fleetName: string

parameters: Fleet

Optional options: FleetsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<FleetsCreateOrUpdateResponse>, FleetsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

fleetName: string

parameters: Fleet

Optional options: FleetsCreateOrUpdateOptionalParams

Returns Promise<FleetsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

fleetName: string

Optional options: FleetsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

fleetName: string

Optional options: FleetsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

fleetName: string

Optional options: FleetsGetOptionalParams

Returns Promise<FleetsGetResponse>

list

Parameters

Optional options: FleetsListOptionalParams

Returns PagedAsyncIterableIterator<Fleet>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: FleetsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<Fleet>

listCredentials

Parameters

resourceGroupName: string

fleetName: string

Optional options: FleetsListCredentialsOptionalParams

Returns Promise<FleetsListCredentialsResponse>

update

Parameters

resourceGroupName: string

fleetName: string

Optional options: FleetsUpdateOptionalParams

Returns Promise<FleetsUpdateResponse>