reachability_analysis_runs

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

Overview

Name	reachability_analysis_runs
Type	Resource
Id	azure.network.reachability_analysis_runs

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.
analysisResult	string	:vartype analysis_result: str
description	string	:vartype description: str
errorMessage	string	:vartype error_message: str
intentContent	object	Intent information.
intentId	string	Id of the intent resource to run analysis on. 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.
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.
analysisResult	string	:vartype analysis_result: str
description	string	:vartype description: str
errorMessage	string	:vartype error_message: str
intentContent	object	Intent information.
intentId	string	Id of the intent resource to run analysis on. 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.
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_run_name, subscription_id		Gets Reachability Analysis Run. Gets Reachability Analysis Run.
list	select	resource_group_name, network_manager_name, workspace_name, subscription_id	skipToken, skip, top, sortKey, sortValue	Gets list of Reachability Analysis Runs. Gets list of Reachability Analysis Runs.
create	insert	resource_group_name, network_manager_name, workspace_name, reachability_analysis_run_name, subscription_id, properties		Creates Reachability Analysis Runs. Creates Reachability Analysis Runs.
delete	delete	resource_group_name, network_manager_name, workspace_name, reachability_analysis_run_name, subscription_id		Deletes Reachability Analysis Run. Deletes Reachability Analysis Run.

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_run_name	string	Reachability Analysis Run 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

Gets Reachability Analysis Run. Gets Reachability Analysis Run.

SELECT
id,
name,
analysisResult,
description,
errorMessage,
intentContent,
intentId,
provisioningState,
systemData,
type
FROM azure.network.reachability_analysis_runs
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_run_name = '{{ reachability_analysis_run_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets list of Reachability Analysis Runs. Gets list of Reachability Analysis Runs.

SELECT
id,
name,
analysisResult,
description,
errorMessage,
intentContent,
intentId,
provisioningState,
systemData,
type
FROM azure.network.reachability_analysis_runs
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 Runs. Creates Reachability Analysis Runs.

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

Manifest

# Description fields are for documentation purposes
- name: reachability_analysis_runs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the reachability_analysis_runs resource.
  - name: network_manager_name
    value: "{{ network_manager_name }}"
    description: Required parameter for the reachability_analysis_runs resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the reachability_analysis_runs resource.
  - name: reachability_analysis_run_name
    value: "{{ reachability_analysis_run_name }}"
    description: Required parameter for the reachability_analysis_runs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the reachability_analysis_runs resource.
  - name: properties
    description: |
      Represents the Reachability Analysis Run properties. Required.
    value:
      description: "{{ description }}"
      intentId: "{{ intentId }}"
      intentContent:
        description: "{{ description }}"
        sourceResourceId: "{{ sourceResourceId }}"
        destinationResourceId: "{{ destinationResourceId }}"
        ipTraffic:
          sourceIps:
            - "{{ sourceIps }}"
          destinationIps:
            - "{{ destinationIps }}"
          sourcePorts:
            - "{{ sourcePorts }}"
          destinationPorts:
            - "{{ destinationPorts }}"
          protocols:
            - "{{ protocols }}"
      analysisResult: "{{ analysisResult }}"
      errorMessage: "{{ errorMessage }}"
      provisioningState: "{{ provisioningState }}"

DELETE examples

delete

Deletes Reachability Analysis Run. Deletes Reachability Analysis Run.

DELETE FROM azure.network.reachability_analysis_runs
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_run_name = '{{ reachability_analysis_run_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;