test_lines

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

Overview

Name	test_lines
Type	Resource
Id	azure_extras.voice_services.test_lines

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.
location	string	The geo-location where the resource lives. Required.
phoneNumber	string	The phone number.
provisioningState	string	Resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled".
purpose	string	Purpose of this test line, e.g. automated or manual testing. Known values are: "Manual" and "Automated".
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".

list_by_communications_gateway

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.
location	string	The geo-location where the resource lives. Required.
phoneNumber	string	The phone number.
provisioningState	string	Resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled".
purpose	string	Purpose of this test line, e.g. automated or manual testing. Known values are: "Manual" and "Automated".
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, communications_gateway_name, test_line_name, subscription_id		Get a TestLine.
list_by_communications_gateway	select	resource_group_name, communications_gateway_name, subscription_id		List TestLine resources by CommunicationsGateway.
create_or_update	insert	resource_group_name, communications_gateway_name, test_line_name, subscription_id, location		Create a TestLine.
update	update	resource_group_name, communications_gateway_name, test_line_name, subscription_id		Update a TestLine.
create_or_update	replace	resource_group_name, communications_gateway_name, test_line_name, subscription_id, location		Create a TestLine.
delete	delete	resource_group_name, communications_gateway_name, test_line_name, subscription_id		Delete a TestLine.

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
communications_gateway_name	string	Unique identifier for this deployment. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
test_line_name	string	Unique identifier for this test line. Required.

SELECT examples

get

Get a TestLine.

SELECT
id,
name,
location,
phoneNumber,
provisioningState,
purpose,
systemData,
tags,
type
FROM azure_extras.voice_services.test_lines
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND communications_gateway_name = '{{ communications_gateway_name }}' -- required
AND test_line_name = '{{ test_line_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_communications_gateway

List TestLine resources by CommunicationsGateway.

SELECT
id,
name,
location,
phoneNumber,
provisioningState,
purpose,
systemData,
tags,
type
FROM azure_extras.voice_services.test_lines
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND communications_gateway_name = '{{ communications_gateway_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a TestLine.

INSERT INTO azure_extras.voice_services.test_lines (
tags,
location,
properties,
resource_group_name,
communications_gateway_name,
test_line_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ communications_gateway_name }}',
'{{ test_line_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: test_lines
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the test_lines resource.
  - name: communications_gateway_name
    value: "{{ communications_gateway_name }}"
    description: Required parameter for the test_lines resource.
  - name: test_line_name
    value: "{{ test_line_name }}"
    description: Required parameter for the test_lines resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the test_lines resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    value:
      phoneNumber: "{{ phoneNumber }}"
      purpose: "{{ purpose }}"

UPDATE examples

update

Update a TestLine.

UPDATE azure_extras.voice_services.test_lines
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND communications_gateway_name = '{{ communications_gateway_name }}' --required
AND test_line_name = '{{ test_line_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a TestLine.

REPLACE azure_extras.voice_services.test_lines
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND communications_gateway_name = '{{ communications_gateway_name }}' --required
AND test_line_name = '{{ test_line_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a TestLine.

DELETE FROM azure_extras.voice_services.test_lines
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND communications_gateway_name = '{{ communications_gateway_name }}' --required
AND test_line_name = '{{ test_line_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;