FleetMembers | @azure/arm-containerservice

Interface representing a FleetMembers.

Hierarchy

FleetMembers

Implemented by

FleetMembersImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, fleetName: string, fleetMemberName: string, parameters: FleetMember, options?: FleetMembersCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<FleetMembersCreateOrUpdateResponse>, FleetMembersCreateOrUpdateResponse>>

- Defined in operationsInterfaces/fleetMembers.ts:44
A member contains a reference to an existing Kubernetes cluster. Creating a member makes the referenced cluster join the Fleet.

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

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, fleetName: string, fleetMemberName: string, parameters: FleetMember, options?: FleetMembersCreateOrUpdateOptionalParams): Promise<FleetMembersCreateOrUpdateResponse>

- Defined in operationsInterfaces/fleetMembers.ts:65
A member contains a reference to an existing Kubernetes cluster. Creating a member makes the referenced cluster join the Fleet.

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

beginDelete

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

- Defined in operationsInterfaces/fleetMembers.ts:93
Deleting a Fleet member results in the member cluster leaving fleet. The Member azure resource is deleted upon success. The underlying cluster is not deleted.

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

beginDeleteAndWait

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

- Defined in operationsInterfaces/fleetMembers.ts:107
Deleting a Fleet member results in the member cluster leaving fleet. The Member azure resource is deleted upon success. The underlying cluster is not deleted.

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

get

get(resourceGroupName: string, fleetName: string, fleetMemberName: string, options?: FleetMembersGetOptionalParams): Promise<FleetMembersGetResponse>

- Defined in operationsInterfaces/fleetMembers.ts:79
Gets a Fleet member.

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

listByFleet

listByFleet(resourceGroupName: string, fleetName: string, options?: FleetMembersListByFleetOptionalParams): PagedAsyncIterableIterator<FleetMember>

- Defined in operationsInterfaces/fleetMembers.ts:30
Lists the members 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: FleetMembersListByFleetOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<FleetMember>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

fleetName: string

fleetMemberName: string

parameters: FleetMember

Optional options: FleetMembersCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<FleetMembersCreateOrUpdateResponse>, FleetMembersCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

fleetName: string

fleetMemberName: string

parameters: FleetMember

Optional options: FleetMembersCreateOrUpdateOptionalParams

Returns Promise<FleetMembersCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

fleetName: string

fleetMemberName: string

Optional options: FleetMembersDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

fleetName: string

fleetMemberName: string

Optional options: FleetMembersDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

fleetName: string

fleetMemberName: string

Optional options: FleetMembersGetOptionalParams

Returns Promise<FleetMembersGetResponse>

listByFleet

Parameters

resourceGroupName: string

fleetName: string

Optional options: FleetMembersListByFleetOptionalParams

Returns PagedAsyncIterableIterator<FleetMember>