kube_environments

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

Overview

Name	kube_environments
Type	Resource
Id	azure.app_service.kube_environments

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
extendedLocation	object	Extended Location.
properties	object	KubeEnvironment resource specific properties
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_resource_group

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
extendedLocation	object	Extended Location.
properties	object	KubeEnvironment resource specific properties
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_subscription

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
extendedLocation	object	Extended Location.
properties	object	KubeEnvironment resource specific properties
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, name, subscriptionId		Description for Get the properties of a Kubernetes Environment.
list_by_resource_group	select	resourceGroupName, subscriptionId		Description for Get all the Kubernetes Environments in a resource group.
list_by_subscription	select	subscriptionId		Description for Get all Kubernetes Environments for a subscription.
create_or_update	insert	resourceGroupName, name, subscriptionId		Description for Creates or updates a Kubernetes Environment.
update	update	resourceGroupName, name, subscriptionId		Description for Creates or updates a Kubernetes Environment.
delete	delete	resourceGroupName, name, subscriptionId		Description for Delete a Kubernetes Environment.

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
name	string	Name of the Kubernetes Environment.
resourceGroupName	string	Name of the resource group to which the resource belongs.
subscriptionId	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

SELECT examples

get

Description for Get the properties of a Kubernetes Environment.

SELECT
id,
name,
extendedLocation,
properties,
systemData,
type
FROM azure.app_service.kube_environments
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Description for Get all the Kubernetes Environments in a resource group.

SELECT
id,
name,
extendedLocation,
properties,
systemData,
type
FROM azure.app_service.kube_environments
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Description for Get all Kubernetes Environments for a subscription.

SELECT
id,
name,
extendedLocation,
properties,
systemData,
type
FROM azure.app_service.kube_environments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Description for Creates or updates a Kubernetes Environment.

INSERT INTO azure.app_service.kube_environments (
data__properties,
data__extendedLocation,
resourceGroupName,
name,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resourceGroupName }}',
'{{ name }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
extendedLocation,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: kube_environments
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the kube_environments resource.
    - name: name
      value: string
      description: Required parameter for the kube_environments resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the kube_environments resource.
    - name: properties
      value: object
      description: |
        KubeEnvironment resource specific properties
    - name: extendedLocation
      value: object
      description: |
        Extended Location.

UPDATE examples

update

Description for Creates or updates a Kubernetes Environment.

UPDATE azure.app_service.kube_environments
SET 
data__kind = '{{ kind }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
extendedLocation,
properties,
systemData,
type;

DELETE examples

delete

Description for Delete a Kubernetes Environment.

DELETE FROM azure.app_service.kube_environments
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;