Package version:

Interface Extensions

Interface representing a Extensions.

interface Extensions {
    beginCreate(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, extension: Extension, options?: ExtensionsCreateOptionalParams): Promise<SimplePollerLike<OperationState<Extension>, Extension>>;
    beginCreateAndWait(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, extension: Extension, options?: ExtensionsCreateOptionalParams): Promise<Extension>;
    beginDelete(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, options?: ExtensionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, options?: ExtensionsDeleteOptionalParams): Promise<void>;
    beginUpdate(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, patchExtension: PatchExtension, options?: ExtensionsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Extension>, Extension>>;
    beginUpdateAndWait(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, patchExtension: PatchExtension, options?: ExtensionsUpdateOptionalParams): Promise<Extension>;
    get(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, options?: ExtensionsGetOptionalParams): Promise<Extension>;
    list(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, options?: ExtensionsListOptionalParams): PagedAsyncIterableIterator<Extension>;
}

Methods

beginCreate beginCreateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get list

Methods

beginCreate

  • beginCreate(resourceGroupName, clusterRp, clusterResourceName, clusterName, extensionName, extension, options?): Promise<SimplePollerLike<OperationState<Extension>, Extension>>

  • Create a new Kubernetes Cluster Extension.

    Parameters

    • resourceGroupName: string

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

    • clusterRp: string

      The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

    • clusterResourceName: string

      The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters, appliances.

    • clusterName: string

      The name of the kubernetes cluster.

    • extensionName: string

      Name of the Extension.

    • extension: Extension

      Properties necessary to Create an Extension.

    • Optionaloptions: ExtensionsCreateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<Extension>, Extension>>

beginCreateAndWait

  • beginCreateAndWait(resourceGroupName, clusterRp, clusterResourceName, clusterName, extensionName, extension, options?): Promise<Extension>

  • Create a new Kubernetes Cluster Extension.

    Parameters

    • resourceGroupName: string

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

    • clusterRp: string

      The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

    • clusterResourceName: string

      The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters, appliances.

    • clusterName: string

      The name of the kubernetes cluster.

    • extensionName: string

      Name of the Extension.

    • extension: Extension

      Properties necessary to Create an Extension.

    • Optionaloptions: ExtensionsCreateOptionalParams

      The options parameters.

    Returns Promise<Extension>

beginDelete

  • beginDelete(resourceGroupName, clusterRp, clusterResourceName, clusterName, extensionName, options?): Promise<SimplePollerLike<OperationState<void>, void>>

  • Delete a Kubernetes Cluster Extension. This will cause the Agent to Uninstall the extension from the cluster.

    Parameters

    • resourceGroupName: string

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

    • clusterRp: string

      The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

    • clusterResourceName: string

      The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters, appliances.

    • clusterName: string

      The name of the kubernetes cluster.

    • extensionName: string

      Name of the Extension.

    • Optionaloptions: ExtensionsDeleteOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

  • beginDeleteAndWait(resourceGroupName, clusterRp, clusterResourceName, clusterName, extensionName, options?): Promise<void>

  • Delete a Kubernetes Cluster Extension. This will cause the Agent to Uninstall the extension from the cluster.

    Parameters

    • resourceGroupName: string

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

    • clusterRp: string

      The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

    • clusterResourceName: string

      The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters, appliances.

    • clusterName: string

      The name of the kubernetes cluster.

    • extensionName: string

      Name of the Extension.

    • Optionaloptions: ExtensionsDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

beginUpdate

  • beginUpdate(resourceGroupName, clusterRp, clusterResourceName, clusterName, extensionName, patchExtension, options?): Promise<SimplePollerLike<OperationState<Extension>, Extension>>

  • Patch an existing Kubernetes Cluster Extension.

    Parameters

    • resourceGroupName: string

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

    • clusterRp: string

      The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

    • clusterResourceName: string

      The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters, appliances.

    • clusterName: string

      The name of the kubernetes cluster.

    • extensionName: string

      Name of the Extension.

    • patchExtension: PatchExtension

      Properties to Patch in an existing Extension.

    • Optionaloptions: ExtensionsUpdateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<Extension>, Extension>>

beginUpdateAndWait

  • beginUpdateAndWait(resourceGroupName, clusterRp, clusterResourceName, clusterName, extensionName, patchExtension, options?): Promise<Extension>

  • Patch an existing Kubernetes Cluster Extension.

    Parameters

    • resourceGroupName: string

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

    • clusterRp: string

      The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

    • clusterResourceName: string

      The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters, appliances.

    • clusterName: string

      The name of the kubernetes cluster.

    • extensionName: string

      Name of the Extension.

    • patchExtension: PatchExtension

      Properties to Patch in an existing Extension.

    • Optionaloptions: ExtensionsUpdateOptionalParams

      The options parameters.

    Returns Promise<Extension>

get

  • get(resourceGroupName, clusterRp, clusterResourceName, clusterName, extensionName, options?): Promise<Extension>

  • Gets Kubernetes Cluster Extension.

    Parameters

    • resourceGroupName: string

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

    • clusterRp: string

      The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

    • clusterResourceName: string

      The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters, appliances.

    • clusterName: string

      The name of the kubernetes cluster.

    • extensionName: string

      Name of the Extension.

    • Optionaloptions: ExtensionsGetOptionalParams

      The options parameters.

    Returns Promise<Extension>

list

  • list(resourceGroupName, clusterRp, clusterResourceName, clusterName, options?): PagedAsyncIterableIterator<Extension>

  • List all Extensions in the cluster.

    Parameters

    • resourceGroupName: string

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

    • clusterRp: string

      The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

    • clusterResourceName: string

      The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters, appliances.

    • clusterName: string

      The name of the kubernetes cluster.

    • Optionaloptions: ExtensionsListOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<Extension>

Settings

Member Visibility