mesh_network

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

Overview

Name	mesh_network
Type	Resource
Id	azure.service_fabric_dataplane.mesh_network

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string
description	string
kind	string
status	string	Status of the network. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed'
statusDetails	string	Gives additional information about the current status of the network.

list

Name	Datatype	Description
ContinuationToken	string
Items	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	network_resource_name, endpoint		Gets the Network resource with the given name. Gets the information about the Network resource with the given name. The information include the description and other properties of the Network.
list	select	endpoint		Lists all the network resources. Gets the information about all network resources in a given resource group. The information include the description and other properties of the Network.
create_or_update	insert	network_resource_name, endpoint, name, properties		Creates or updates a Network resource. Creates a Network resource with the specified name, description and properties. If Network resource with the same name exists, then it is updated with the specified description and properties. Network resource provides connectivity between application services.
create_or_update	replace	network_resource_name, endpoint, name, properties		Creates or updates a Network resource. Creates a Network resource with the specified name, description and properties. If Network resource with the same name exists, then it is updated with the specified description and properties. Network resource provides connectivity between application services.
delete	delete	network_resource_name, endpoint		Deletes the Network resource. 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
endpoint	string	The service endpoint host (no scheme). (default: )
network_resource_name	string	The identity of the network.

SELECT examples

get

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

SELECT
name,
description,
kind,
status,
statusDetails
FROM azure.service_fabric_dataplane.mesh_network
WHERE network_resource_name = '{{ network_resource_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

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

SELECT
ContinuationToken,
Items
FROM azure.service_fabric_dataplane.mesh_network
WHERE endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Network resource. Creates a Network resource with the specified name, description and properties. If Network resource with the same name exists, then it is updated with the specified description and properties. Network resource provides connectivity between application services.

INSERT INTO azure.service_fabric_dataplane.mesh_network (
name,
properties,
network_resource_name,
endpoint
)
SELECT 
'{{ name }}' /* required */,
'{{ properties }}' /* required */,
'{{ network_resource_name }}',
'{{ endpoint }}'
RETURNING
name,
properties
;

Manifest

# Description fields are for documentation purposes
- name: mesh_network
props:
  - name: network_resource_name
    value: "{{ network_resource_name }}"
    description: Required parameter for the mesh_network resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the mesh_network resource.
  - name: name
    value: "{{ name }}"
  - name: properties
    description: |
      Describes properties of a network resource. You probably want to use the sub-classes and not this class directly. Known sub-classes are: LocalNetworkResourceProperties Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure.
    value:
      kind: "{{ kind }}"
      description: "{{ description }}"
      status: "{{ status }}"
      statusDetails: "{{ statusDetails }}"

REPLACE examples

create_or_update

Creates or updates a Network resource. Creates a Network resource with the specified name, description and properties. If Network resource with the same name exists, then it is updated with the specified description and properties. Network resource provides connectivity between application services.

REPLACE azure.service_fabric_dataplane.mesh_network
SET 
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
network_resource_name = '{{ network_resource_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND name = '{{ name }}' --required
AND properties = '{{ properties }}' --required
RETURNING
name,
properties;

DELETE examples

delete

Deletes the Network resource. Deletes the Network resource identified by the name.

DELETE FROM azure.service_fabric_dataplane.mesh_network
WHERE network_resource_name = '{{ network_resource_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;