kubernetes_cluster_features

Creates, updates, deletes, gets or lists a kubernetes_cluster_features resource.

Overview

Name	kubernetes_cluster_features
Type	Resource
Id	azure_extras.network_cloud.kubernetes_cluster_features

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
availabilityLifecycle	string	The lifecycle indicator of the feature. Known values are: "Preview" and "GenerallyAvailable". (Preview, GenerallyAvailable)
detailedStatus	string	The detailed status of the feature. Known values are: "Error", "Provisioning", and "Installed". (Error, Provisioning, Installed)
detailedStatusMessage	string	The descriptive message for the detailed status of the feature.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
location	string	The geo-location where the resource lives. Required.
options	array	The configured options for the feature.
provisioningState	string	The provisioning state of the Kubernetes cluster feature. Known values are: "Accepted", "Canceled", "Deleting", "Failed", "Succeeded", and "Updating". (Accepted, Canceled, Deleting, Failed, Succeeded, Updating)
required	string	The indicator of if the feature is required or optional. Optional features may be deleted by the user, while required features are managed with the kubernetes cluster lifecycle. Known values are: "True" and "False". (True, False)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	The version of the feature.

list_by_kubernetes_cluster

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
availabilityLifecycle	string	The lifecycle indicator of the feature. Known values are: "Preview" and "GenerallyAvailable". (Preview, GenerallyAvailable)
detailedStatus	string	The detailed status of the feature. Known values are: "Error", "Provisioning", and "Installed". (Error, Provisioning, Installed)
detailedStatusMessage	string	The descriptive message for the detailed status of the feature.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
location	string	The geo-location where the resource lives. Required.
options	array	The configured options for the feature.
provisioningState	string	The provisioning state of the Kubernetes cluster feature. Known values are: "Accepted", "Canceled", "Deleting", "Failed", "Succeeded", and "Updating". (Accepted, Canceled, Deleting, Failed, Succeeded, Updating)
required	string	The indicator of if the feature is required or optional. Optional features may be deleted by the user, while required features are managed with the kubernetes cluster lifecycle. Known values are: "True" and "False". (True, False)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	The version of the feature.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, kubernetes_cluster_name, feature_name, subscription_id		Get properties of the provided the Kubernetes cluster feature.
list_by_kubernetes_cluster	select	resource_group_name, kubernetes_cluster_name, subscription_id	$top, $skipToken	Get a list of features for the provided Kubernetes cluster.
create_or_update	insert	resource_group_name, kubernetes_cluster_name, feature_name, subscription_id, location		Create a new Kubernetes cluster feature or update properties of the Kubernetes cluster feature if it exists.
update	update	resource_group_name, kubernetes_cluster_name, feature_name, subscription_id		Patch properties of the provided Kubernetes cluster feature.
create_or_update	replace	resource_group_name, kubernetes_cluster_name, feature_name, subscription_id, location		Create a new Kubernetes cluster feature or update properties of the Kubernetes cluster feature if it exists.
delete	delete	resource_group_name, kubernetes_cluster_name, feature_name, subscription_id		Delete the provided Kubernetes cluster feature.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
feature_name	string	The name of the feature. Required.
kubernetes_cluster_name	string	The name of the Kubernetes cluster. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$skipToken	string	The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets. Default value is None.
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Get properties of the provided the Kubernetes cluster feature.

SELECT
id,
name,
availabilityLifecycle,
detailedStatus,
detailedStatusMessage,
etag,
location,
options,
provisioningState,
required,
systemData,
tags,
type,
version
FROM azure_extras.network_cloud.kubernetes_cluster_features
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND kubernetes_cluster_name = '{{ kubernetes_cluster_name }}' -- required
AND feature_name = '{{ feature_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_kubernetes_cluster

Get a list of features for the provided Kubernetes cluster.

SELECT
id,
name,
availabilityLifecycle,
detailedStatus,
detailedStatusMessage,
etag,
location,
options,
provisioningState,
required,
systemData,
tags,
type,
version
FROM azure_extras.network_cloud.kubernetes_cluster_features
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND kubernetes_cluster_name = '{{ kubernetes_cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Create a new Kubernetes cluster feature or update properties of the Kubernetes cluster feature if it exists.

INSERT INTO azure_extras.network_cloud.kubernetes_cluster_features (
tags,
location,
properties,
resource_group_name,
kubernetes_cluster_name,
feature_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ kubernetes_cluster_name }}',
'{{ feature_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: kubernetes_cluster_features
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the kubernetes_cluster_features resource.
  - name: kubernetes_cluster_name
    value: "{{ kubernetes_cluster_name }}"
    description: Required parameter for the kubernetes_cluster_features resource.
  - name: feature_name
    value: "{{ feature_name }}"
    description: Required parameter for the kubernetes_cluster_features resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the kubernetes_cluster_features resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The list of the resource properties.
    value:
      options:
        - key: "{{ key }}"
          value: "{{ value }}"
      availabilityLifecycle: "{{ availabilityLifecycle }}"
      detailedStatus: "{{ detailedStatus }}"
      detailedStatusMessage: "{{ detailedStatusMessage }}"
      required: "{{ required }}"
      version: "{{ version }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Patch properties of the provided Kubernetes cluster feature.

UPDATE azure_extras.network_cloud.kubernetes_cluster_features
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND kubernetes_cluster_name = '{{ kubernetes_cluster_name }}' --required
AND feature_name = '{{ feature_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a new Kubernetes cluster feature or update properties of the Kubernetes cluster feature if it exists.

REPLACE azure_extras.network_cloud.kubernetes_cluster_features
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND kubernetes_cluster_name = '{{ kubernetes_cluster_name }}' --required
AND feature_name = '{{ feature_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete the provided Kubernetes cluster feature.

DELETE FROM azure_extras.network_cloud.kubernetes_cluster_features
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND kubernetes_cluster_name = '{{ kubernetes_cluster_name }}' --required
AND feature_name = '{{ feature_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;