provisioned_cluster_instances

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

Overview

Name	provisioned_cluster_instances
Type	Resource
Id	azure.hybrid_container_service.provisioned_cluster_instances

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
agentPoolProfiles	array	The agent pool properties for the provisioned cluster.
autoScalerProfile	object	Parameters to be applied to the cluster-autoscaler when auto scaling is enabled for the provisioned cluster.
cloudProviderProfile	object	The profile for the underlying cloud infrastructure provider for the provisioned cluster.
clusterVMAccessProfile	object	The SSH restricted access profile for the VMs in the provisioned cluster.
controlPlane	object	The profile for control plane of the provisioned cluster.
extendedLocation	object	Extended location pointing to the underlying infrastructure.
kubernetesVersion	string	The version of Kubernetes in use by the provisioned cluster.
licenseProfile	object	The license profile of the provisioned cluster.
linuxProfile	object	The profile for Linux VMs in the provisioned cluster.
networkProfile	object	The network configuration profile for the provisioned cluster.
provisioningState	string	The status of the latest long running operation for the provisioned cluster. Known values are: "Succeeded", "Failed", "Canceled", "Pending", "Creating", "Deleting", "Updating", "Upgrading", and "Accepted".
status	object	The observed status of the provisioned cluster.
storageProfile	object	The storage configuration profile for the provisioned cluster.
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	connected_cluster_resource_uri		Gets the provisioned cluster instance. Gets the provisioned cluster instance.
create_or_update	insert	connected_cluster_resource_uri		Creates or updates the provisioned cluster instance. Creates or updates the provisioned cluster instance.
create_or_update	replace	connected_cluster_resource_uri		Creates or updates the provisioned cluster instance. Creates or updates the provisioned cluster instance.
delete	delete	connected_cluster_resource_uri		Deletes the provisioned cluster instance. Deletes the provisioned cluster instance.
list_user_kubeconfig	exec	connected_cluster_resource_uri		Lists the user credentials of the provisioned cluster (can only be used within private network). Lists the user credentials of the provisioned cluster (can only be used within private network).
list_admin_kubeconfig	exec	connected_cluster_resource_uri		Lists the admin credentials of the provisioned cluster (can only be used within private network). Lists the admin credentials of the provisioned cluster (can only be used within private network).
get_upgrade_profile	exec	connected_cluster_resource_uri		Gets the upgrade profile of a provisioned cluster. Gets the upgrade profile of a provisioned cluster.
list_raw	exec	connected_cluster_resource_uri		Lists the ProvisionedClusterInstance resource associated with the ConnectedCluster. Lists the ProvisionedClusterInstance resource associated with the ConnectedCluster.

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
connected_cluster_resource_uri	string	The fully qualified Azure Resource Manager identifier of the connected cluster resource. Required.

SELECT examples

get

Gets the provisioned cluster instance. Gets the provisioned cluster instance.

SELECT
id,
name,
agentPoolProfiles,
autoScalerProfile,
cloudProviderProfile,
clusterVMAccessProfile,
controlPlane,
extendedLocation,
kubernetesVersion,
licenseProfile,
linuxProfile,
networkProfile,
provisioningState,
status,
storageProfile,
systemData,
type
FROM azure.hybrid_container_service.provisioned_cluster_instances
WHERE connected_cluster_resource_uri = '{{ connected_cluster_resource_uri }}' -- required
;

INSERT examples

create_or_update

Creates or updates the provisioned cluster instance. Creates or updates the provisioned cluster instance.

INSERT INTO azure.hybrid_container_service.provisioned_cluster_instances (
properties,
extendedLocation,
connected_cluster_resource_uri
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}',
'{{ connected_cluster_resource_uri }}'
RETURNING
id,
name,
extendedLocation,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: provisioned_cluster_instances
props:
  - name: connected_cluster_resource_uri
    value: "{{ connected_cluster_resource_uri }}"
    description: Required parameter for the provisioned_cluster_instances resource.
  - name: properties
    description: |
      Properties of the provisioned cluster.
    value:
      linuxProfile:
        ssh:
          publicKeys:
            - keyData: "{{ keyData }}"
      controlPlane:
        count: {{ count }}
        vmSize: "{{ vmSize }}"
        controlPlaneEndpoint:
          hostIP: "{{ hostIP }}"
      kubernetesVersion: "{{ kubernetesVersion }}"
      networkProfile:
        loadBalancerProfile:
          count: {{ count }}
        networkPolicy: "{{ networkPolicy }}"
        podCidr: "{{ podCidr }}"
      storageProfile:
        smbCsiDriver:
          enabled: {{ enabled }}
        nfsCsiDriver:
          enabled: {{ enabled }}
      clusterVMAccessProfile:
        authorizedIPRanges: "{{ authorizedIPRanges }}"
      agentPoolProfiles:
        - osType: "{{ osType }}"
          osSKU: "{{ osSKU }}"
          nodeLabels: "{{ nodeLabels }}"
          nodeTaints: "{{ nodeTaints }}"
          maxCount: {{ maxCount }}
          minCount: {{ minCount }}
          enableAutoScaling: {{ enableAutoScaling }}
          maxPods: {{ maxPods }}
          count: {{ count }}
          vmSize: "{{ vmSize }}"
          kubernetesVersion: "{{ kubernetesVersion }}"
          name: "{{ name }}"
      cloudProviderProfile:
        infraNetworkProfile:
          vnetSubnetIds:
            - "{{ vnetSubnetIds }}"
      provisioningState: "{{ provisioningState }}"
      status:
        controlPlaneStatus:
          - name: "{{ name }}"
            phase: "{{ phase }}"
            ready: {{ ready }}
            errorMessage: "{{ errorMessage }}"
        currentState: "{{ currentState }}"
        errorMessage: "{{ errorMessage }}"
      licenseProfile:
        azureHybridBenefit: "{{ azureHybridBenefit }}"
      autoScalerProfile:
        balance-similar-node-groups: "{{ balance-similar-node-groups }}"
        expander: "{{ expander }}"
        max-empty-bulk-delete: "{{ max-empty-bulk-delete }}"
        max-graceful-termination-sec: "{{ max-graceful-termination-sec }}"
        max-node-provision-time: "{{ max-node-provision-time }}"
        max-total-unready-percentage: "{{ max-total-unready-percentage }}"
        new-pod-scale-up-delay: "{{ new-pod-scale-up-delay }}"
        ok-total-unready-count: "{{ ok-total-unready-count }}"
        scan-interval: "{{ scan-interval }}"
        scale-down-delay-after-add: "{{ scale-down-delay-after-add }}"
        scale-down-delay-after-delete: "{{ scale-down-delay-after-delete }}"
        scale-down-delay-after-failure: "{{ scale-down-delay-after-failure }}"
        scale-down-unneeded-time: "{{ scale-down-unneeded-time }}"
        scale-down-unready-time: "{{ scale-down-unready-time }}"
        scale-down-utilization-threshold: "{{ scale-down-utilization-threshold }}"
        skip-nodes-with-local-storage: "{{ skip-nodes-with-local-storage }}"
        skip-nodes-with-system-pods: "{{ skip-nodes-with-system-pods }}"
  - name: extendedLocation
    description: |
      Extended location pointing to the underlying infrastructure.
    value:
      type: "{{ type }}"
      name: "{{ name }}"

REPLACE examples

create_or_update

Creates or updates the provisioned cluster instance. Creates or updates the provisioned cluster instance.

REPLACE azure.hybrid_container_service.provisioned_cluster_instances
SET 
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
connected_cluster_resource_uri = '{{ connected_cluster_resource_uri }}' --required
RETURNING
id,
name,
extendedLocation,
properties,
systemData,
type;

DELETE examples

delete

Deletes the provisioned cluster instance. Deletes the provisioned cluster instance.

DELETE FROM azure.hybrid_container_service.provisioned_cluster_instances
WHERE connected_cluster_resource_uri = '{{ connected_cluster_resource_uri }}' --required
;

Lifecycle Methods

list_user_kubeconfig

Lists the user credentials of the provisioned cluster (can only be used within private network). Lists the user credentials of the provisioned cluster (can only be used within private network).

EXEC azure.hybrid_container_service.provisioned_cluster_instances.list_user_kubeconfig 
@connected_cluster_resource_uri='{{ connected_cluster_resource_uri }}' --required
;

list_admin_kubeconfig

Lists the admin credentials of the provisioned cluster (can only be used within private network). Lists the admin credentials of the provisioned cluster (can only be used within private network).

EXEC azure.hybrid_container_service.provisioned_cluster_instances.list_admin_kubeconfig 
@connected_cluster_resource_uri='{{ connected_cluster_resource_uri }}' --required
;

get_upgrade_profile

Gets the upgrade profile of a provisioned cluster. Gets the upgrade profile of a provisioned cluster.

EXEC azure.hybrid_container_service.provisioned_cluster_instances.get_upgrade_profile 
@connected_cluster_resource_uri='{{ connected_cluster_resource_uri }}' --required
;

list_raw

Lists the ProvisionedClusterInstance resource associated with the ConnectedCluster. Lists the ProvisionedClusterInstance resource associated with the ConnectedCluster.

EXEC azure.hybrid_container_service.provisioned_cluster_instances.list_raw 
@connected_cluster_resource_uri='{{ connected_cluster_resource_uri }}' --required
;