managers

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

Overview

Name	managers
Type	Resource
Id	azure.network.managers

Fields

The following fields are returned by SELECT queries:

get

OK - Returns information about the network manager.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	The network manager properties
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"

list

OK - Returns a list of network managers.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	The network manager properties
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"

list_by_subscription

OK - Returns information about the network managers.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	The network manager properties
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			Gets the specified Network Manager.
list	select	subscriptionId, resourceGroupName	$top, $skipToken	List network managers in a resource group.
list_by_subscription	select	subscriptionId	$top, $skipToken	List all network managers in a subscription.
create_or_update	insert			Creates or updates a Network Manager.
patch	update			Patch NetworkManager.
delete	delete		force	Deletes a network manager.

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.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$skipToken	string	SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.
$top	integer (int32)	An optional query parameter which specifies the maximum number of records to be returned by the server.
force	boolean	Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete.

SELECT examples

get

Gets the specified Network Manager.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.managers
;

list

List network managers in a resource group.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.managers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

list_by_subscription

List all network managers in a subscription.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.managers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Creates or updates a Network Manager.

INSERT INTO azure.network.managers (
data__properties
)
SELECT 
'{{ properties }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: managers
  props:
    - name: properties
      value: object
      description: |
        The network manager properties

UPDATE examples

patch

Patch NetworkManager.

UPDATE azure.network.managers
SET 
data__tags = '{{ tags }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

Deletes a network manager.

DELETE FROM azure.network.managers
WHERE force = '{{ force }}'
;