Share via

Fleets interface

  • Reference
Package:
@azure/arm-containerservicefleet

Interface representing a Fleets.

Methods

beginCreateOrUpdate(string, string, Fleet, FleetsCreateOrUpdateOptionalParams)

Creates or updates a Fleet.
beginCreateOrUpdateAndWait(string, string, Fleet, FleetsCreateOrUpdateOptionalParams)

Creates or updates a Fleet.
beginDelete(string, string, FleetsDeleteOptionalParams)

Delete a Fleet
beginDeleteAndWait(string, string, FleetsDeleteOptionalParams)

Delete a Fleet
beginUpdate(string, string, FleetPatch, FleetsUpdateOptionalParams)

Update a Fleet
beginUpdateAndWait(string, string, FleetPatch, FleetsUpdateOptionalParams)

Update a Fleet
get(string, string, FleetsGetOptionalParams)

Gets a Fleet.
listByResourceGroup(string, FleetsListByResourceGroupOptionalParams)

Lists fleets in the specified subscription and resource group.
listBySubscription(FleetsListBySubscriptionOptionalParams)

Lists fleets in the specified subscription.
listCredentials(string, string, FleetsListCredentialsOptionalParams)

Lists the user credentials of a Fleet.

Method Details

beginCreateOrUpdate(string, string, Fleet, FleetsCreateOrUpdateOptionalParams)

Creates or updates a Fleet.

function beginCreateOrUpdate(resourceGroupName: string, fleetName: string, resource: Fleet, options?: FleetsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Fleet>, Fleet>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

fleetName

string

The name of the Fleet resource.

resource
Fleet

Resource create parameters.

options
FleetsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Fleet>, Fleet>>

beginCreateOrUpdateAndWait(string, string, Fleet, FleetsCreateOrUpdateOptionalParams)

Creates or updates a Fleet.

function beginCreateOrUpdateAndWait(resourceGroupName: string, fleetName: string, resource: Fleet, options?: FleetsCreateOrUpdateOptionalParams): Promise<Fleet>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

fleetName

string

The name of the Fleet resource.

resource
Fleet

Resource create parameters.

options
FleetsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Fleet>

beginDelete(string, string, FleetsDeleteOptionalParams)

Delete a Fleet

function beginDelete(resourceGroupName: string, fleetName: string, options?: FleetsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

fleetName

string

The name of the Fleet resource.

options
FleetsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, FleetsDeleteOptionalParams)

Delete a Fleet

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

fleetName

string

The name of the Fleet resource.

options
FleetsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, FleetPatch, FleetsUpdateOptionalParams)

Update a Fleet

function beginUpdate(resourceGroupName: string, fleetName: string, properties: FleetPatch, options?: FleetsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Fleet>, Fleet>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

fleetName

string

The name of the Fleet resource.

properties
FleetPatch

The resource properties to be updated.

options
FleetsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Fleet>, Fleet>>

beginUpdateAndWait(string, string, FleetPatch, FleetsUpdateOptionalParams)

Update a Fleet

function beginUpdateAndWait(resourceGroupName: string, fleetName: string, properties: FleetPatch, options?: FleetsUpdateOptionalParams): Promise<Fleet>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

fleetName

string

The name of the Fleet resource.

properties
FleetPatch

The resource properties to be updated.

options
FleetsUpdateOptionalParams

The options parameters.

Returns

Promise<Fleet>

get(string, string, FleetsGetOptionalParams)

Gets a Fleet.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

fleetName

string

The name of the Fleet resource.

options
FleetsGetOptionalParams

The options parameters.

Returns

Promise<Fleet>

listByResourceGroup(string, FleetsListByResourceGroupOptionalParams)

Lists fleets in the specified subscription and resource group.

function listByResourceGroup(resourceGroupName: string, options?: FleetsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Fleet, Fleet[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options
FleetsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Fleet, Fleet[], PageSettings>

listBySubscription(FleetsListBySubscriptionOptionalParams)

Lists fleets in the specified subscription.

function listBySubscription(options?: FleetsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Fleet, Fleet[], PageSettings>

Parameters

options
FleetsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Fleet, Fleet[], PageSettings>

listCredentials(string, string, FleetsListCredentialsOptionalParams)

Lists the user credentials of a Fleet.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

fleetName

string

The name of the Fleet resource.

options
FleetsListCredentialsOptionalParams

The options parameters.

Returns

Promise<FleetCredentialResults>