orchestrator_instance_services

Creates, updates, deletes, gets or lists an orchestrator_instance_services resource.

Overview

Name	orchestrator_instance_services
Type	Resource
Id	azure.delegated_network.orchestrator_instance_services

Fields

The following fields are returned by SELECT queries:

list_by_resource_group

This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the orchestratorInstances in the resource group.

Name	Datatype	Description
id	string	An identifier that represents the resource.
name	string	The name of the resource.
identity	object	The identity of the orchestrator
kind	string	The kind of workbook. Choices are user and shared.
location	string	Location of the resource.
properties	object	Properties of the provision operation request.
tags	object	The resource tags.
type	string	The type of resource.

list_by_subscription

This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the orchestratorInstance in the subscription.

Name	Datatype	Description
id	string	An identifier that represents the resource.
name	string	The name of the resource.
identity	object	The identity of the orchestrator
kind	string	The kind of workbook. Choices are user and shared.
location	string	Location of the resource.
properties	object	Properties of the provision operation request.
tags	object	The resource tags.
type	string	The type of resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_resource_group	select	resourceGroupName, subscriptionId		Get all the OrchestratorInstances resources in a resource group.
list_by_subscription	select	subscriptionId		Get all the orchestratorInstance resources in a subscription.
create	insert	resourceGroupName, resourceName, subscriptionId		Create a orchestrator instance
patch	update	resourceGroupName, resourceName, subscriptionId		Update Orchestrator Instance
delete	delete	resourceGroupName, resourceName, subscriptionId	forceDelete	Deletes the Orchestrator Instance

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceName	string	The name of the resource. It must be a minimum of 3 characters, and a maximum of 63.
subscriptionId	string	The ID of the target subscription.
forceDelete	boolean	Force delete resource

SELECT examples

list_by_resource_group

Get all the OrchestratorInstances resources in a resource group.

SELECT
id,
name,
identity,
kind,
location,
properties,
tags,
type
FROM azure.delegated_network.orchestrator_instance_services
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Get all the orchestratorInstance resources in a subscription.

SELECT
id,
name,
identity,
kind,
location,
properties,
tags,
type
FROM azure.delegated_network.orchestrator_instance_services
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Create a orchestrator instance

INSERT INTO azure.delegated_network.orchestrator_instance_services (
data__location,
data__kind,
data__identity,
data__tags,
data__properties,
resourceGroupName,
resourceName,
subscriptionId
)
SELECT 
'{{ location }}',
'{{ kind }}',
'{{ identity }}',
'{{ tags }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
identity,
kind,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: orchestrator_instance_services
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the orchestrator_instance_services resource.
    - name: resourceName
      value: string
      description: Required parameter for the orchestrator_instance_services resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the orchestrator_instance_services resource.
    - name: location
      value: string
      description: |
        Location of the resource.
    - name: kind
      value: string
      description: |
        The kind of workbook. Choices are user and shared.
      valid_values: ['Kubernetes']
    - name: identity
      value: object
      description: |
        The identity of the orchestrator
    - name: tags
      value: object
      description: |
        The resource tags.
    - name: properties
      value: object
      description: |
        Properties of the provision operation request.

UPDATE examples

patch

Update Orchestrator Instance

UPDATE azure.delegated_network.orchestrator_instance_services
SET 
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
identity,
kind,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the Orchestrator Instance

DELETE FROM azure.delegated_network.orchestrator_instance_services
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND forceDelete = '{{ forceDelete }}'
;