networks

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

Overview

Name	networks
Type	Resource
Id	azure.service_fabric_mesh.networks

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Describes properties of a network resource.
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Describes properties of a network resource.
tags	object	Resource tags.

list_by_subscription

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Describes properties of a network resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, networkResourceName	api-version	Gets the information about the network resource with the given name. The information include the description and other properties of the network.
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version	Gets the information about all network resources in a given resource group. The information include the description and other properties of the Network.
list_by_subscription	select	subscriptionId	api-version	Gets the information about all network resources in a given resource group. The information include the description and other properties of the network.
create	insert	subscriptionId, resourceGroupName, networkResourceName, data__properties	api-version	Creates a network resource with the specified name, description and properties. If a network resource with the same name exists, then it is updated with the specified description and properties.
delete	delete	subscriptionId, resourceGroupName, networkResourceName	api-version	Deletes the network resource identified by the name.

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
networkResourceName	string	The identity of the network.
resourceGroupName	string	Azure resource group name
subscriptionId	string	The customer subscription identifier
api-version	string	The version of the API. This parameter is required and its value must be 2018-09-01-preview.

SELECT examples

get

Gets the information about the network resource with the given name. The information include the description and other properties of the network.

SELECT
location,
properties,
tags
FROM azure.service_fabric_mesh.networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkResourceName = '{{ networkResourceName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_resource_group

Gets the information about all network resources in a given resource group. The information include the description and other properties of the Network.

SELECT
location,
properties,
tags
FROM azure.service_fabric_mesh.networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_subscription

Gets the information about all network resources in a given resource group. The information include the description and other properties of the network.

SELECT
location,
properties,
tags
FROM azure.service_fabric_mesh.networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create

Creates a network resource with the specified name, description and properties. If a network resource with the same name exists, then it is updated with the specified description and properties.

INSERT INTO azure.service_fabric_mesh.networks (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
networkResourceName,
api-version
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ networkResourceName }}',
'{{ api-version }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: networks
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the networks resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the networks resource.
    - name: networkResourceName
      value: string
      description: Required parameter for the networks resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Describes properties of a network resource.
    - name: api-version
      value: string
      description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`.

DELETE examples

delete

Deletes the network resource identified by the name.

DELETE FROM azure.service_fabric_mesh.networks
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND networkResourceName = '{{ networkResourceName }}' --required
AND api-version = '{{ api-version }}'
;