kubernetes_versions

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

Overview

Name	kubernetes_versions
Type	Resource
Id	azure_extras.network_cloud.kubernetes_versions

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.
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.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the Kubernetes version resource. Known values are: "Accepted", "Canceled", "Failed", and "Succeeded". (Accepted, Canceled, Failed, Succeeded)
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".
values	array	The list of available Kubernetes versions.

list_by_resource_group

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.
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.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the Kubernetes version resource. Known values are: "Accepted", "Canceled", "Failed", and "Succeeded". (Accepted, Canceled, Failed, Succeeded)
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".
values	array	The list of available Kubernetes versions.

list_by_subscription

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.
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.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the Kubernetes version resource. Known values are: "Accepted", "Canceled", "Failed", and "Succeeded". (Accepted, Canceled, Failed, Succeeded)
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".
values	array	The list of available Kubernetes versions.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, kubernetes_version_name, subscription_id		Retrieve the Kubernetes version resource that describes the available Kubernetes versions for deployment.
list_by_resource_group	select	resource_group_name, subscription_id	$top, $skipToken	Get a list of Kubernetes version resources in the provided resource group.
list_by_subscription	select	subscription_id	$top, $skipToken	Get a list of Kubernetes version resources in the provided subscription.
create_or_update	insert	resource_group_name, kubernetes_version_name, subscription_id, location, properties, extendedLocation		Create the Kubernetes version resource or update its tags. This resource is system managed and should only be created with the name "default".
update	update	resource_group_name, kubernetes_version_name, subscription_id		Update tags associated with the Kubernetes version resource. No other properties are supported for update.
create_or_update	replace	resource_group_name, kubernetes_version_name, subscription_id, location, properties, extendedLocation		Create the Kubernetes version resource or update its tags. This resource is system managed and should only be created with the name "default".
delete	delete	resource_group_name, kubernetes_version_name, subscription_id		Delete the specified Kubernetes version resource.

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
kubernetes_version_name	string	The name of the Kubernetes version resource. 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

Retrieve the Kubernetes version resource that describes the available Kubernetes versions for deployment.

SELECT
id,
name,
etag,
extendedLocation,
location,
provisioningState,
systemData,
tags,
type,
values
FROM azure_extras.network_cloud.kubernetes_versions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND kubernetes_version_name = '{{ kubernetes_version_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get a list of Kubernetes version resources in the provided resource group.

SELECT
id,
name,
etag,
extendedLocation,
location,
provisioningState,
systemData,
tags,
type,
values
FROM azure_extras.network_cloud.kubernetes_versions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

list_by_subscription

Get a list of Kubernetes version resources in the provided subscription.

SELECT
id,
name,
etag,
extendedLocation,
location,
provisioningState,
systemData,
tags,
type,
values
FROM azure_extras.network_cloud.kubernetes_versions
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Create the Kubernetes version resource or update its tags. This resource is system managed and should only be created with the name "default".

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

Manifest

# Description fields are for documentation purposes
- name: kubernetes_versions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the kubernetes_versions resource.
  - name: kubernetes_version_name
    value: "{{ kubernetes_version_name }}"
    description: Required parameter for the kubernetes_versions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the kubernetes_versions 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. Required.
    value:
      values:
        - description: "{{ description }}"
          version: "{{ version }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      The extended location of the resource. This property is required when creating the resource. Required.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

Update tags associated with the Kubernetes version resource. No other properties are supported for update.

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

REPLACE examples

create_or_update

Create the Kubernetes version resource or update its tags. This resource is system managed and should only be created with the name "default".

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

DELETE examples

delete

Delete the specified Kubernetes version resource.

DELETE FROM azure_extras.network_cloud.kubernetes_versions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND kubernetes_version_name = '{{ kubernetes_version_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;