ExtensionsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SourceControlConfigurationClient's
<xref:extensions> attribute.
- Inheritance
-
builtins.objectExtensionsOperations
Constructor
ExtensionsOperations(*args, **kwargs)
Methods
begin_create |
Create a new Kubernetes Cluster Extension. |
begin_delete |
Delete a Kubernetes Cluster Extension. This will cause the Agent to Uninstall the extension from the cluster. |
begin_update |
Patch an existing Kubernetes Cluster Extension. |
get |
Gets Kubernetes Cluster Extension. |
list |
List all Extensions in the cluster. |
begin_create
Create a new Kubernetes Cluster Extension.
begin_create(resource_group_name: str, cluster_rp: str | _models.Enum0, cluster_resource_name: str | _models.Enum1, cluster_name: str, extension_name: str, extension: _models.Extension, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Extension]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
cluster_rp
Required
|
The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). Known values are: "Microsoft.ContainerService" and "Microsoft.Kubernetes". Required. |
cluster_resource_name
Required
|
The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). Known values are: "managedClusters" and "connectedClusters". Required. |
cluster_name
Required
|
The name of the kubernetes cluster. Required. |
extension_name
Required
|
Name of the Extension. Required. |
extension
Required
|
Properties necessary to Create an Extension. Is either a Extension type or a IO type. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either Extension or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_delete
Delete a Kubernetes Cluster Extension. This will cause the Agent to Uninstall the extension from the cluster.
begin_delete(resource_group_name: str, cluster_rp: str | Enum0, cluster_resource_name: str | Enum1, cluster_name: str, extension_name: str, force_delete: bool | None = None, **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
cluster_rp
Required
|
The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). Known values are: "Microsoft.ContainerService" and "Microsoft.Kubernetes". Required. |
cluster_resource_name
Required
|
The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). Known values are: "managedClusters" and "connectedClusters". Required. |
cluster_name
Required
|
The name of the kubernetes cluster. Required. |
extension_name
Required
|
Name of the Extension. Required. |
force_delete
Required
|
Delete the extension resource in Azure - not the normal asynchronous delete. Default value is None. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_update
Patch an existing Kubernetes Cluster Extension.
begin_update(resource_group_name: str, cluster_rp: str | _models.Enum0, cluster_resource_name: str | _models.Enum1, cluster_name: str, extension_name: str, patch_extension: _models.PatchExtension, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Extension]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
cluster_rp
Required
|
The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). Known values are: "Microsoft.ContainerService" and "Microsoft.Kubernetes". Required. |
cluster_resource_name
Required
|
The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). Known values are: "managedClusters" and "connectedClusters". Required. |
cluster_name
Required
|
The name of the kubernetes cluster. Required. |
extension_name
Required
|
Name of the Extension. Required. |
patch_extension
Required
|
PatchExtension or
IO
Properties to Patch in an existing Extension. Is either a PatchExtension type or a IO type. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either Extension or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get
Gets Kubernetes Cluster Extension.
get(resource_group_name: str, cluster_rp: str | Enum0, cluster_resource_name: str | Enum1, cluster_name: str, extension_name: str, **kwargs: Any) -> Extension
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
cluster_rp
Required
|
The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). Known values are: "Microsoft.ContainerService" and "Microsoft.Kubernetes". Required. |
cluster_resource_name
Required
|
The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). Known values are: "managedClusters" and "connectedClusters". Required. |
cluster_name
Required
|
The name of the kubernetes cluster. Required. |
extension_name
Required
|
Name of the Extension. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
Extension or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list
List all Extensions in the cluster.
list(resource_group_name: str, cluster_rp: str | Enum0, cluster_resource_name: str | Enum1, cluster_name: str, **kwargs: Any) -> Iterable[Extension]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
cluster_rp
Required
|
The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). Known values are: "Microsoft.ContainerService" and "Microsoft.Kubernetes". Required. |
cluster_resource_name
Required
|
The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). Known values are: "managedClusters" and "connectedClusters". Required. |
cluster_name
Required
|
The name of the kubernetes cluster. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
An iterator like instance of either Extension or the result of cls(response) |
Exceptions
Type | Description |
---|---|
Attributes
models
models = <module 'azure.mgmt.kubernetesconfiguration.v2021_11_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.10\\x64\\Lib\\site-packages\\azure\\mgmt\\kubernetesconfiguration\\v2021_11_01_preview\\models\\__init__.py'>
Azure SDK for Python