KubeEnvironments interface

Interface representing a KubeEnvironments.

Methods

beginCreateOrUpdate(string, string, KubeEnvironment, KubeEnvironmentsCreateOrUpdateOptionalParams)

Description for Creates or updates a Kubernetes Environment.

beginCreateOrUpdateAndWait(string, string, KubeEnvironment, KubeEnvironmentsCreateOrUpdateOptionalParams)

Description for Creates or updates a Kubernetes Environment.

beginDelete(string, string, KubeEnvironmentsDeleteOptionalParams)

Description for Delete a Kubernetes Environment.

beginDeleteAndWait(string, string, KubeEnvironmentsDeleteOptionalParams)

Description for Delete a Kubernetes Environment.

get(string, string, KubeEnvironmentsGetOptionalParams)

Description for Get the properties of a Kubernetes Environment.

listByResourceGroup(string, KubeEnvironmentsListByResourceGroupOptionalParams)

Description for Get all the Kubernetes Environments in a resource group.

listBySubscription(KubeEnvironmentsListBySubscriptionOptionalParams)

Description for Get all Kubernetes Environments for a subscription.

update(string, string, KubeEnvironmentPatchResource, KubeEnvironmentsUpdateOptionalParams)

Description for Creates or updates a Kubernetes Environment.

Method Details

beginCreateOrUpdate(string, string, KubeEnvironment, KubeEnvironmentsCreateOrUpdateOptionalParams)

Description for Creates or updates a Kubernetes Environment.

function beginCreateOrUpdate(resourceGroupName: string, name: string, kubeEnvironmentEnvelope: KubeEnvironment, options?: KubeEnvironmentsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<KubeEnvironment>, KubeEnvironment>>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

name

string

Name of the Kubernetes Environment.

kubeEnvironmentEnvelope
KubeEnvironment

Configuration details of the Kubernetes Environment.

options
KubeEnvironmentsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, KubeEnvironment, KubeEnvironmentsCreateOrUpdateOptionalParams)

Description for Creates or updates a Kubernetes Environment.

function beginCreateOrUpdateAndWait(resourceGroupName: string, name: string, kubeEnvironmentEnvelope: KubeEnvironment, options?: KubeEnvironmentsCreateOrUpdateOptionalParams): Promise<KubeEnvironment>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

name

string

Name of the Kubernetes Environment.

kubeEnvironmentEnvelope
KubeEnvironment

Configuration details of the Kubernetes Environment.

options
KubeEnvironmentsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<KubeEnvironment>

beginDelete(string, string, KubeEnvironmentsDeleteOptionalParams)

Description for Delete a Kubernetes Environment.

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

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

name

string

Name of the Kubernetes Environment.

options
KubeEnvironmentsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, KubeEnvironmentsDeleteOptionalParams)

Description for Delete a Kubernetes Environment.

function beginDeleteAndWait(resourceGroupName: string, name: string, options?: KubeEnvironmentsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

name

string

Name of the Kubernetes Environment.

options
KubeEnvironmentsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, KubeEnvironmentsGetOptionalParams)

Description for Get the properties of a Kubernetes Environment.

function get(resourceGroupName: string, name: string, options?: KubeEnvironmentsGetOptionalParams): Promise<KubeEnvironment>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

name

string

Name of the Kubernetes Environment.

options
KubeEnvironmentsGetOptionalParams

The options parameters.

Returns

Promise<KubeEnvironment>

listByResourceGroup(string, KubeEnvironmentsListByResourceGroupOptionalParams)

Description for Get all the Kubernetes Environments in a resource group.

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

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

options
KubeEnvironmentsListByResourceGroupOptionalParams

The options parameters.

Returns

listBySubscription(KubeEnvironmentsListBySubscriptionOptionalParams)

Description for Get all Kubernetes Environments for a subscription.

function listBySubscription(options?: KubeEnvironmentsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<KubeEnvironment, KubeEnvironment[], PageSettings>

Parameters

options
KubeEnvironmentsListBySubscriptionOptionalParams

The options parameters.

Returns

update(string, string, KubeEnvironmentPatchResource, KubeEnvironmentsUpdateOptionalParams)

Description for Creates or updates a Kubernetes Environment.

function update(resourceGroupName: string, name: string, kubeEnvironmentEnvelope: KubeEnvironmentPatchResource, options?: KubeEnvironmentsUpdateOptionalParams): Promise<KubeEnvironment>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

name

string

Name of the Kubernetes Environment.

kubeEnvironmentEnvelope
KubeEnvironmentPatchResource

Configuration details of the Kubernetes Environment.

options
KubeEnvironmentsUpdateOptionalParams

The options parameters.

Returns

Promise<KubeEnvironment>