kubernetes_cluster_features

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

Overview

Name	kubernetes_cluster_features
Type	Resource
Id	azure.nexus.kubernetes_cluster_features

Fields

The following fields are returned by SELECT queries:

get

The resource has been successfully retrieved.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: KubernetesClusterFeatureProperties represents the properties of a Kubernetes cluster feature.)
tags	object	Resource tags.

list_by_kubernetes_cluster

The resource list has been successfully retrieved.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: KubernetesClusterFeatureProperties represents the properties of a Kubernetes cluster feature.)
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, kubernetesClusterName, featureName		Get properties of the provided the Kubernetes cluster feature.
list_by_kubernetes_cluster	select	subscriptionId, resourceGroupName, kubernetesClusterName		Get a list of features for the provided Kubernetes cluster.
create_or_update	insert	subscriptionId, resourceGroupName, kubernetesClusterName, featureName		Create a new Kubernetes cluster feature or update properties of the Kubernetes cluster feature if it exists.
update	update	subscriptionId, resourceGroupName, kubernetesClusterName, featureName		Patch properties of the provided Kubernetes cluster feature.
delete	delete	subscriptionId, resourceGroupName, kubernetesClusterName, featureName		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
featureName	string	The name of the feature.
kubernetesClusterName	string	The name of the Kubernetes cluster.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get properties of the provided the Kubernetes cluster feature.

SELECT
location,
properties,
tags
FROM azure.nexus.kubernetes_cluster_features
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND kubernetesClusterName = '{{ kubernetesClusterName }}' -- required
AND featureName = '{{ featureName }}' -- required
;

list_by_kubernetes_cluster

Get a list of features for the provided Kubernetes cluster.

SELECT
location,
properties,
tags
FROM azure.nexus.kubernetes_cluster_features
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND kubernetesClusterName = '{{ kubernetesClusterName }}' -- required
;

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.nexus.kubernetes_cluster_features (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
kubernetesClusterName,
featureName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ kubernetesClusterName }}',
'{{ featureName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: kubernetes_cluster_features
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the kubernetes_cluster_features resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the kubernetes_cluster_features resource.
    - name: kubernetesClusterName
      value: string
      description: Required parameter for the kubernetes_cluster_features resource.
    - name: featureName
      value: string
      description: Required parameter for the kubernetes_cluster_features resource.
    - name: properties
      value: object
      description: |
        The list of the resource properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Patch properties of the provided Kubernetes cluster feature.

UPDATE azure.nexus.kubernetes_cluster_features
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND kubernetesClusterName = '{{ kubernetesClusterName }}' --required
AND featureName = '{{ featureName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Delete the provided Kubernetes cluster feature.

DELETE FROM azure.nexus.kubernetes_cluster_features
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND kubernetesClusterName = '{{ kubernetesClusterName }}' --required
AND featureName = '{{ featureName }}' --required
;