Extensions interface
Interface representing a Extensions.
Methods
Method Details
beginCreate(string, string, string, string, string, Extension, ExtensionsCreateOptionalParams)
Create a new Kubernetes Cluster Extension.
function beginCreate(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, extension: Extension, options?: ExtensionsCreateOptionalParams): Promise<SimplePollerLike<OperationState<Extension>, 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.
- clusterName
-
string
The name of the kubernetes cluster.
- extensionName
-
string
Name of the Extension.
- extension
- Extension
Properties necessary to Create an Extension.
- options
- ExtensionsCreateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Extension>, Extension>>
beginCreateAndWait(string, string, string, string, string, Extension, ExtensionsCreateOptionalParams)
Create a new Kubernetes Cluster Extension.
function beginCreateAndWait(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, extension: Extension, options?: ExtensionsCreateOptionalParams): Promise<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.
- clusterName
-
string
The name of the kubernetes cluster.
- extensionName
-
string
Name of the Extension.
- extension
- Extension
Properties necessary to Create an Extension.
- options
- ExtensionsCreateOptionalParams
The options parameters.
Returns
Promise<Extension>
beginDelete(string, string, string, string, string, ExtensionsDeleteOptionalParams)
Delete a Kubernetes Cluster Extension. This will cause the Agent to Uninstall the extension from the cluster.
function beginDelete(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, options?: ExtensionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
- clusterName
-
string
The name of the kubernetes cluster.
- extensionName
-
string
Name of the Extension.
- options
- ExtensionsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, string, string, ExtensionsDeleteOptionalParams)
Delete a Kubernetes Cluster Extension. This will cause the Agent to Uninstall the extension from the cluster.
function beginDeleteAndWait(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, options?: ExtensionsDeleteOptionalParams): Promise<void>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.
- clusterName
-
string
The name of the kubernetes cluster.
- extensionName
-
string
Name of the Extension.
- options
- ExtensionsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, string, string, PatchExtension, ExtensionsUpdateOptionalParams)
Patch an existing Kubernetes Cluster Extension.
function beginUpdate(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, patchExtension: PatchExtension, options?: ExtensionsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Extension>, 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.
- clusterName
-
string
The name of the kubernetes cluster.
- extensionName
-
string
Name of the Extension.
- patchExtension
- PatchExtension
Properties to Patch in an existing Extension.
- options
- ExtensionsUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Extension>, Extension>>
beginUpdateAndWait(string, string, string, string, string, PatchExtension, ExtensionsUpdateOptionalParams)
Patch an existing Kubernetes Cluster Extension.
function beginUpdateAndWait(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, patchExtension: PatchExtension, options?: ExtensionsUpdateOptionalParams): Promise<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.
- clusterName
-
string
The name of the kubernetes cluster.
- extensionName
-
string
Name of the Extension.
- patchExtension
- PatchExtension
Properties to Patch in an existing Extension.
- options
- ExtensionsUpdateOptionalParams
The options parameters.
Returns
Promise<Extension>
get(string, string, string, string, string, ExtensionsGetOptionalParams)
Gets Kubernetes Cluster Extension.
function get(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, options?: ExtensionsGetOptionalParams): Promise<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.
- clusterName
-
string
The name of the kubernetes cluster.
- extensionName
-
string
Name of the Extension.
- options
- ExtensionsGetOptionalParams
The options parameters.
Returns
Promise<Extension>
list(string, string, string, string, ExtensionsListOptionalParams)
List all Extensions in the cluster.
function list(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, options?: ExtensionsListOptionalParams): PagedAsyncIterableIterator<Extension, Extension[], PageSettings>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.
- clusterName
-
string
The name of the kubernetes cluster.
- options
- ExtensionsListOptionalParams
The options parameters.