verifier_workspaces

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

Overview

Name	verifier_workspaces
Type	Resource
Id	azure.network.verifier_workspaces

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.
description	string	:vartype description: str
etag	string	String representing unique etag for the resource document.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning states of a resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
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

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.
description	string	:vartype description: str
etag	string	String representing unique etag for the resource document.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning states of a resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
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, network_manager_name, workspace_name, subscription_id		Gets Verifier Workspace. Gets Verifier Workspace.
list	select	resource_group_name, network_manager_name, subscription_id	skipToken, skip, top, sortKey, sortValue	Gets list of Verifier Workspaces. Gets list of Verifier Workspaces.
create	insert	resource_group_name, network_manager_name, workspace_name, subscription_id, location		Creates Verifier Workspace. Creates Verifier Workspace.
update	update	resource_group_name, network_manager_name, workspace_name, subscription_id		Updates Verifier Workspace. Updates Verifier Workspace.
delete	delete	resource_group_name, network_manager_name, workspace_name, subscription_id		Deletes Verifier Workspace. Deletes Verifier Workspace.

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
network_manager_name	string	The name of the network manager. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the resource. Required.
skip	integer	Optional num entries to skip. Default value is 0.
skipToken	string	Optional skip token. Default value is None.
sortKey	string	Optional key by which to sort. Default value is None.
sortValue	string	Optional sort value for pagination. Default value is None.
top	integer	Optional num entries to show. Default value is 50.

SELECT examples

get

Gets Verifier Workspace. Gets Verifier Workspace.

SELECT
id,
name,
description,
etag,
location,
provisioningState,
systemData,
tags,
type
FROM azure.network.verifier_workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets list of Verifier Workspaces. Gets list of Verifier Workspaces.

SELECT
id,
name,
description,
etag,
location,
provisioningState,
systemData,
tags,
type
FROM azure.network.verifier_workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND skipToken = '{{ skipToken }}'
AND skip = '{{ skip }}'
AND top = '{{ top }}'
AND sortKey = '{{ sortKey }}'
AND sortValue = '{{ sortValue }}'
;

INSERT examples

create

Creates Verifier Workspace. Creates Verifier Workspace.

INSERT INTO azure.network.verifier_workspaces (
tags,
location,
properties,
resource_group_name,
network_manager_name,
workspace_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ network_manager_name }}',
'{{ workspace_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: verifier_workspaces
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the verifier_workspaces resource.
  - name: network_manager_name
    value: "{{ network_manager_name }}"
    description: Required parameter for the verifier_workspaces resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the verifier_workspaces resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the verifier_workspaces resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties of Verifier Workspace resource.
    value:
      description: "{{ description }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Updates Verifier Workspace. Updates Verifier Workspace.

UPDATE azure.network.verifier_workspaces
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_manager_name = '{{ network_manager_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes Verifier Workspace. Deletes Verifier Workspace.

DELETE FROM azure.network.verifier_workspaces
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_manager_name = '{{ network_manager_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;