reachability_analysis_intents

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

Overview

Name	reachability_analysis_intents
Type	Resource
Id	azure.network.reachability_analysis_intents

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
destinationResourceId	string	Destination resource id to verify the reachability path of. Required.
ipTraffic	object	IP traffic information. Required.
provisioningState	string	Provisioning states of a resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
sourceResourceId	string	Source resource id to verify the reachability path of. Required.
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

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
destinationResourceId	string	Destination resource id to verify the reachability path of. Required.
ipTraffic	object	IP traffic information. Required.
provisioningState	string	Provisioning states of a resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
sourceResourceId	string	Source resource id to verify the reachability path of. Required.
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	resource_group_name, network_manager_name, workspace_name, reachability_analysis_intent_name, subscription_id		Get the Reachability Analysis Intent. Get the Reachability Analysis Intent.
list	select	resource_group_name, network_manager_name, workspace_name, subscription_id	skipToken, skip, top, sortKey, sortValue	Gets list of Reachability Analysis Intents . Gets list of Reachability Analysis Intents .
create	insert	resource_group_name, network_manager_name, workspace_name, reachability_analysis_intent_name, subscription_id, properties		Creates Reachability Analysis Intent. Creates Reachability Analysis Intent.
delete	delete	resource_group_name, network_manager_name, workspace_name, reachability_analysis_intent_name, subscription_id		Deletes Reachability Analysis Intent. Deletes Reachability Analysis Intent.

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.
reachability_analysis_intent_name	string	Reachability Analysis Intent name. 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

Get the Reachability Analysis Intent. Get the Reachability Analysis Intent.

SELECT
id,
name,
description,
destinationResourceId,
ipTraffic,
provisioningState,
sourceResourceId,
systemData,
type
FROM azure.network.reachability_analysis_intents
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND reachability_analysis_intent_name = '{{ reachability_analysis_intent_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets list of Reachability Analysis Intents . Gets list of Reachability Analysis Intents .

SELECT
id,
name,
description,
destinationResourceId,
ipTraffic,
provisioningState,
sourceResourceId,
systemData,
type
FROM azure.network.reachability_analysis_intents
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
AND skipToken = '{{ skipToken }}'
AND skip = '{{ skip }}'
AND top = '{{ top }}'
AND sortKey = '{{ sortKey }}'
AND sortValue = '{{ sortValue }}'
;

INSERT examples

create

Creates Reachability Analysis Intent. Creates Reachability Analysis Intent.

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

Manifest

# Description fields are for documentation purposes
- name: reachability_analysis_intents
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the reachability_analysis_intents resource.
  - name: network_manager_name
    value: "{{ network_manager_name }}"
    description: Required parameter for the reachability_analysis_intents resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the reachability_analysis_intents resource.
  - name: reachability_analysis_intent_name
    value: "{{ reachability_analysis_intent_name }}"
    description: Required parameter for the reachability_analysis_intents resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the reachability_analysis_intents resource.
  - name: properties
    description: |
      Represents the Reachability Analysis Intent properties. Required.
    value:
      provisioningState: "{{ provisioningState }}"
      description: "{{ description }}"
      sourceResourceId: "{{ sourceResourceId }}"
      destinationResourceId: "{{ destinationResourceId }}"
      ipTraffic:
        sourceIps:
          - "{{ sourceIps }}"
        destinationIps:
          - "{{ destinationIps }}"
        sourcePorts:
          - "{{ sourcePorts }}"
        destinationPorts:
          - "{{ destinationPorts }}"
        protocols:
          - "{{ protocols }}"

DELETE examples

delete

Deletes Reachability Analysis Intent. Deletes Reachability Analysis Intent.

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