HybridContainerServiceClient class

Package:

@azure/arm-hybridcontainerservice

Extends

ServiceClient

Constructors

HybridContainerServiceClient(TokenCredential, HybridContainerServiceClientOptionalParams)
HybridContainerServiceClient(TokenCredential, string, HybridContainerServiceClientOptionalParams)	Initializes a new instance of the HybridContainerServiceClient class.

Properties

$host
agentPoolOperations
apiVersion
hybridIdentityMetadataOperations
kubernetesVersions
operations
provisionedClusterInstances
subscriptionId
virtualNetworks
vMSkus

Inherited Properties

pipeline

The pipeline used by this client to make requests

Methods

beginDeleteKubernetesVersions(string, DeleteKubernetesVersionsOptionalParams)	Delete the default kubernetes versions resource type
beginDeleteKubernetesVersionsAndWait(string, DeleteKubernetesVersionsOptionalParams)	Delete the default kubernetes versions resource type
beginDeleteVMSkus(string, DeleteVMSkusOptionalParams)	Deletes the default VM skus resource type
beginDeleteVMSkusAndWait(string, DeleteVMSkusOptionalParams)	Deletes the default VM skus resource type
beginPutKubernetesVersions(string, KubernetesVersionProfile, PutKubernetesVersionsOptionalParams)	Puts the default kubernetes version resource type (one time operation, before listing the kubernetes versions)
beginPutKubernetesVersionsAndWait(string, KubernetesVersionProfile, PutKubernetesVersionsOptionalParams)	Puts the default kubernetes version resource type (one time operation, before listing the kubernetes versions)
beginPutVMSkus(string, VmSkuProfile, PutVMSkusOptionalParams)	Puts the default VM skus resource type (one time operation, before listing the VM skus)
beginPutVMSkusAndWait(string, VmSkuProfile, PutVMSkusOptionalParams)	Puts the default VM skus resource type (one time operation, before listing the VM skus)
getKubernetesVersions(string, GetKubernetesVersionsOptionalParams)	Lists the supported kubernetes versions for the specified custom location
getVMSkus(string, GetVMSkusOptionalParams)	Lists the supported VM skus for the specified custom location

Inherited Methods

sendOperationRequest<T>(OperationArguments, OperationSpec)	Send an HTTP request that is populated using the provided OperationSpec.
sendRequest(PipelineRequest)	Send the provided httpRequest.

Constructor Details

HybridContainerServiceClient(TokenCredential, HybridContainerServiceClientOptionalParams)

new HybridContainerServiceClient(credentials: TokenCredential, options?: HybridContainerServiceClientOptionalParams)

Parameters

credentials

TokenCredential

options

HybridContainerServiceClientOptionalParams

HybridContainerServiceClient(TokenCredential, string, HybridContainerServiceClientOptionalParams)

Initializes a new instance of the HybridContainerServiceClient class.

new HybridContainerServiceClient(credentials: TokenCredential, subscriptionId: string, options?: HybridContainerServiceClientOptionalParams)

Parameters

credentials

TokenCredential

Subscription credentials which uniquely identify client subscription.

subscriptionId

string

The ID of the target subscription. The value must be an UUID.

options

HybridContainerServiceClientOptionalParams

The parameter options

Property Details

$host

$host: string

Property Value

string

agentPoolOperations

agentPoolOperations: AgentPoolOperations

Property Value

AgentPoolOperations

apiVersion

apiVersion: string

Property Value

string

hybridIdentityMetadataOperations

hybridIdentityMetadataOperations: HybridIdentityMetadataOperations

Property Value

HybridIdentityMetadataOperations

kubernetesVersions

kubernetesVersions: KubernetesVersions

Property Value

KubernetesVersions

operations

operations: Operations

Property Value

Operations

provisionedClusterInstances

provisionedClusterInstances: ProvisionedClusterInstances

Property Value

ProvisionedClusterInstances

subscriptionId

subscriptionId?: string

Property Value

string

virtualNetworks

virtualNetworks: VirtualNetworks

Property Value

VirtualNetworks

vMSkus

vMSkus: VMSkus

Property Value

VMSkus

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Pipeline

Inherited From coreClient.ServiceClient.pipeline

Method Details

beginDeleteKubernetesVersions(string, DeleteKubernetesVersionsOptionalParams)

Delete the default kubernetes versions resource type

function beginDeleteKubernetesVersions(customLocationResourceUri: string, options?: DeleteKubernetesVersionsOptionalParams): Promise<SimplePollerLike<OperationState<HybridContainerServiceClientDeleteKubernetesVersionsHeaders>, HybridContainerServiceClientDeleteKubernetesVersionsHeaders>>

Parameters

customLocationResourceUri

string

The fully qualified Azure Resource Manager identifier of the custom location resource.

options

DeleteKubernetesVersionsOptionalParams

The options parameters.

Returns

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

beginDeleteKubernetesVersionsAndWait(string, DeleteKubernetesVersionsOptionalParams)

Delete the default kubernetes versions resource type

function beginDeleteKubernetesVersionsAndWait(customLocationResourceUri: string, options?: DeleteKubernetesVersionsOptionalParams): Promise<HybridContainerServiceClientDeleteKubernetesVersionsHeaders>

Parameters

customLocationResourceUri

string

The fully qualified Azure Resource Manager identifier of the custom location resource.

options

DeleteKubernetesVersionsOptionalParams

The options parameters.

Returns

Promise<HybridContainerServiceClientDeleteKubernetesVersionsHeaders>

beginDeleteVMSkus(string, DeleteVMSkusOptionalParams)

Deletes the default VM skus resource type

function beginDeleteVMSkus(customLocationResourceUri: string, options?: DeleteVMSkusOptionalParams): Promise<SimplePollerLike<OperationState<HybridContainerServiceClientDeleteVMSkusHeaders>, HybridContainerServiceClientDeleteVMSkusHeaders>>

Parameters

customLocationResourceUri

string

The fully qualified Azure Resource Manager identifier of the custom location resource.

options

DeleteVMSkusOptionalParams

The options parameters.

Returns

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

beginDeleteVMSkusAndWait(string, DeleteVMSkusOptionalParams)

Deletes the default VM skus resource type

function beginDeleteVMSkusAndWait(customLocationResourceUri: string, options?: DeleteVMSkusOptionalParams): Promise<HybridContainerServiceClientDeleteVMSkusHeaders>

Parameters

customLocationResourceUri

string

The fully qualified Azure Resource Manager identifier of the custom location resource.

options

DeleteVMSkusOptionalParams

The options parameters.

Returns

Promise<HybridContainerServiceClientDeleteVMSkusHeaders>

beginPutKubernetesVersions(string, KubernetesVersionProfile, PutKubernetesVersionsOptionalParams)

Puts the default kubernetes version resource type (one time operation, before listing the kubernetes versions)

function beginPutKubernetesVersions(customLocationResourceUri: string, kubernetesVersions: KubernetesVersionProfile, options?: PutKubernetesVersionsOptionalParams): Promise<SimplePollerLike<OperationState<KubernetesVersionProfile>, KubernetesVersionProfile>>

Parameters

customLocationResourceUri

string

The fully qualified Azure Resource Manager identifier of the custom location resource.

kubernetesVersions

KubernetesVersionProfile

Kubernetes Versions resource definition

options

PutKubernetesVersionsOptionalParams

The options parameters.

Returns

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

beginPutKubernetesVersionsAndWait(string, KubernetesVersionProfile, PutKubernetesVersionsOptionalParams)

Puts the default kubernetes version resource type (one time operation, before listing the kubernetes versions)

function beginPutKubernetesVersionsAndWait(customLocationResourceUri: string, kubernetesVersions: KubernetesVersionProfile, options?: PutKubernetesVersionsOptionalParams): Promise<KubernetesVersionProfile>

Parameters

customLocationResourceUri

string

The fully qualified Azure Resource Manager identifier of the custom location resource.

kubernetesVersions

KubernetesVersionProfile

Kubernetes Versions resource definition

options

PutKubernetesVersionsOptionalParams

The options parameters.

Returns

Promise<KubernetesVersionProfile>

beginPutVMSkus(string, VmSkuProfile, PutVMSkusOptionalParams)

Puts the default VM skus resource type (one time operation, before listing the VM skus)

function beginPutVMSkus(customLocationResourceUri: string, skus: VmSkuProfile, options?: PutVMSkusOptionalParams): Promise<SimplePollerLike<OperationState<VmSkuProfile>, VmSkuProfile>>

Parameters

customLocationResourceUri

string

The fully qualified Azure Resource Manager identifier of the custom location resource.

skus

VmSkuProfile

VM SKUs resource definition

options

PutVMSkusOptionalParams

The options parameters.

Returns

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

beginPutVMSkusAndWait(string, VmSkuProfile, PutVMSkusOptionalParams)

Puts the default VM skus resource type (one time operation, before listing the VM skus)

function beginPutVMSkusAndWait(customLocationResourceUri: string, skus: VmSkuProfile, options?: PutVMSkusOptionalParams): Promise<VmSkuProfile>

Parameters

customLocationResourceUri

string

The fully qualified Azure Resource Manager identifier of the custom location resource.

skus

VmSkuProfile

VM SKUs resource definition

options

PutVMSkusOptionalParams

The options parameters.

Returns

Promise<VmSkuProfile>

getKubernetesVersions(string, GetKubernetesVersionsOptionalParams)

Lists the supported kubernetes versions for the specified custom location

function getKubernetesVersions(customLocationResourceUri: string, options?: GetKubernetesVersionsOptionalParams): Promise<KubernetesVersionProfile>

Parameters

customLocationResourceUri

string

The fully qualified Azure Resource Manager identifier of the custom location resource.

options

GetKubernetesVersionsOptionalParams

The options parameters.

Returns

Promise<KubernetesVersionProfile>

getVMSkus(string, GetVMSkusOptionalParams)

Lists the supported VM skus for the specified custom location

function getVMSkus(customLocationResourceUri: string, options?: GetVMSkusOptionalParams): Promise<VmSkuProfile>

Parameters

customLocationResourceUri

string

The fully qualified Azure Resource Manager identifier of the custom location resource.

options

GetVMSkusOptionalParams

The options parameters.

Returns

Promise<VmSkuProfile>

Inherited Method Details

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

Parameters

operationArguments

OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec

OperationSpec

The OperationSpec to use to populate the httpRequest.

Returns

Promise<T>

Inherited From coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Send the provided httpRequest.

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

Parameters

request

PipelineRequest

Returns

Promise<PipelineResponse>

Inherited From coreClient.ServiceClient.sendRequest