service_runners

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

Overview

Name	service_runners
Type	Resource
Id	azure.dev_test_labs.service_runners

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
identity	object	The identity of the resource.
location	string	The location of the resource.
tags	object	The tags of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, lab_name, name, subscription_id		Get service runner.
create_or_update	insert	resource_group_name, lab_name, name, subscription_id		Create or replace an existing service runner.
create_or_update	replace	resource_group_name, lab_name, name, subscription_id		Create or replace an existing service runner.
delete	delete	resource_group_name, lab_name, name, subscription_id		Delete service runner.

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
lab_name	string	The name of the lab. Required.
name	string	The name of the service runner. Required.
resource_group_name	string	The name of the resource group. Required.
subscription_id	string

SELECT examples

get

Get service runner.

SELECT
id,
name,
identity,
location,
tags,
type
FROM azure.dev_test_labs.service_runners
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or replace an existing service runner.

INSERT INTO azure.dev_test_labs.service_runners (
location,
tags,
identity,
resource_group_name,
lab_name,
name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ lab_name }}',
'{{ name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: service_runners
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the service_runners resource.
  - name: lab_name
    value: "{{ lab_name }}"
    description: Required parameter for the service_runners resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the service_runners resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the service_runners resource.
  - name: location
    value: "{{ location }}"
    description: |
      The location of the resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      The tags of the resource.
  - name: identity
    description: |
      The identity of the resource.
    value:
      type: "{{ type }}"
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      clientSecretUrl: "{{ clientSecretUrl }}"

REPLACE examples

create_or_update

Create or replace an existing service runner.

REPLACE azure.dev_test_labs.service_runners
SET 
location = '{{ location }}',
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
tags,
type;

DELETE examples

delete

Delete service runner.

DELETE FROM azure.dev_test_labs.service_runners
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;