1. Packages
  2. Azure Native v2
  3. API Docs
  4. network
  5. ReachabilityAnalysisRun
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.network.ReachabilityAnalysisRun

Explore with Pulumi AI

Configuration information for analysis run. Azure REST API version: 2024-01-01-preview.

Other available API versions: 2024-05-01.

Example Usage

ReachabilityAnalysisRunCreate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var reachabilityAnalysisRun = new AzureNative.Network.ReachabilityAnalysisRun("reachabilityAnalysisRun", new()
    {
        NetworkManagerName = "testNetworkManager",
        Properties = new AzureNative.Network.Inputs.ReachabilityAnalysisRunPropertiesArgs
        {
            Description = "A sample reachability analysis run",
            IntentId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisIntents/testReachabilityAnalysisIntenant1",
        },
        ReachabilityAnalysisRunName = "testAnalysisRunName",
        ResourceGroupName = "rg1",
        WorkspaceName = "testWorkspace",
    });

});
Copy
package main

import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewReachabilityAnalysisRun(ctx, "reachabilityAnalysisRun", &network.ReachabilityAnalysisRunArgs{
			NetworkManagerName: pulumi.String("testNetworkManager"),
			Properties: &network.ReachabilityAnalysisRunPropertiesArgs{
				Description: pulumi.String("A sample reachability analysis run"),
				IntentId:    pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisIntents/testReachabilityAnalysisIntenant1"),
			},
			ReachabilityAnalysisRunName: pulumi.String("testAnalysisRunName"),
			ResourceGroupName:           pulumi.String("rg1"),
			WorkspaceName:               pulumi.String("testWorkspace"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.ReachabilityAnalysisRun;
import com.pulumi.azurenative.network.ReachabilityAnalysisRunArgs;
import com.pulumi.azurenative.network.inputs.ReachabilityAnalysisRunPropertiesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var reachabilityAnalysisRun = new ReachabilityAnalysisRun("reachabilityAnalysisRun", ReachabilityAnalysisRunArgs.builder()
            .networkManagerName("testNetworkManager")
            .properties(ReachabilityAnalysisRunPropertiesArgs.builder()
                .description("A sample reachability analysis run")
                .intentId("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisIntents/testReachabilityAnalysisIntenant1")
                .build())
            .reachabilityAnalysisRunName("testAnalysisRunName")
            .resourceGroupName("rg1")
            .workspaceName("testWorkspace")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const reachabilityAnalysisRun = new azure_native.network.ReachabilityAnalysisRun("reachabilityAnalysisRun", {
    networkManagerName: "testNetworkManager",
    properties: {
        description: "A sample reachability analysis run",
        intentId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisIntents/testReachabilityAnalysisIntenant1",
    },
    reachabilityAnalysisRunName: "testAnalysisRunName",
    resourceGroupName: "rg1",
    workspaceName: "testWorkspace",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

reachability_analysis_run = azure_native.network.ReachabilityAnalysisRun("reachabilityAnalysisRun",
    network_manager_name="testNetworkManager",
    properties={
        "description": "A sample reachability analysis run",
        "intent_id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisIntents/testReachabilityAnalysisIntenant1",
    },
    reachability_analysis_run_name="testAnalysisRunName",
    resource_group_name="rg1",
    workspace_name="testWorkspace")
Copy
resources:
  reachabilityAnalysisRun:
    type: azure-native:network:ReachabilityAnalysisRun
    properties:
      networkManagerName: testNetworkManager
      properties:
        description: A sample reachability analysis run
        intentId: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisIntents/testReachabilityAnalysisIntenant1
      reachabilityAnalysisRunName: testAnalysisRunName
      resourceGroupName: rg1
      workspaceName: testWorkspace
Copy

Create ReachabilityAnalysisRun Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ReachabilityAnalysisRun(name: string, args: ReachabilityAnalysisRunArgs, opts?: CustomResourceOptions);
@overload
def ReachabilityAnalysisRun(resource_name: str,
                            args: ReachabilityAnalysisRunArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def ReachabilityAnalysisRun(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            network_manager_name: Optional[str] = None,
                            properties: Optional[ReachabilityAnalysisRunPropertiesArgs] = None,
                            resource_group_name: Optional[str] = None,
                            workspace_name: Optional[str] = None,
                            reachability_analysis_run_name: Optional[str] = None)
func NewReachabilityAnalysisRun(ctx *Context, name string, args ReachabilityAnalysisRunArgs, opts ...ResourceOption) (*ReachabilityAnalysisRun, error)
public ReachabilityAnalysisRun(string name, ReachabilityAnalysisRunArgs args, CustomResourceOptions? opts = null)
public ReachabilityAnalysisRun(String name, ReachabilityAnalysisRunArgs args)
public ReachabilityAnalysisRun(String name, ReachabilityAnalysisRunArgs args, CustomResourceOptions options)
type: azure-native:network:ReachabilityAnalysisRun
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ReachabilityAnalysisRunArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ReachabilityAnalysisRunArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ReachabilityAnalysisRunArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ReachabilityAnalysisRunArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ReachabilityAnalysisRunArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var reachabilityAnalysisRunResource = new AzureNative.Network.ReachabilityAnalysisRun("reachabilityAnalysisRunResource", new()
{
    NetworkManagerName = "string",
    Properties = 
    {
        { "intentId", "string" },
        { "description", "string" },
    },
    ResourceGroupName = "string",
    WorkspaceName = "string",
    ReachabilityAnalysisRunName = "string",
});
Copy
example, err := network.NewReachabilityAnalysisRun(ctx, "reachabilityAnalysisRunResource", &network.ReachabilityAnalysisRunArgs{
	NetworkManagerName: "string",
	Properties: map[string]interface{}{
		"intentId":    "string",
		"description": "string",
	},
	ResourceGroupName:           "string",
	WorkspaceName:               "string",
	ReachabilityAnalysisRunName: "string",
})
Copy
var reachabilityAnalysisRunResource = new ReachabilityAnalysisRun("reachabilityAnalysisRunResource", ReachabilityAnalysisRunArgs.builder()
    .networkManagerName("string")
    .properties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .resourceGroupName("string")
    .workspaceName("string")
    .reachabilityAnalysisRunName("string")
    .build());
Copy
reachability_analysis_run_resource = azure_native.network.ReachabilityAnalysisRun("reachabilityAnalysisRunResource",
    network_manager_name=string,
    properties={
        intentId: string,
        description: string,
    },
    resource_group_name=string,
    workspace_name=string,
    reachability_analysis_run_name=string)
Copy
const reachabilityAnalysisRunResource = new azure_native.network.ReachabilityAnalysisRun("reachabilityAnalysisRunResource", {
    networkManagerName: "string",
    properties: {
        intentId: "string",
        description: "string",
    },
    resourceGroupName: "string",
    workspaceName: "string",
    reachabilityAnalysisRunName: "string",
});
Copy
type: azure-native:network:ReachabilityAnalysisRun
properties:
    networkManagerName: string
    properties:
        description: string
        intentId: string
    reachabilityAnalysisRunName: string
    resourceGroupName: string
    workspaceName: string
Copy

ReachabilityAnalysisRun Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ReachabilityAnalysisRun resource accepts the following input properties:

NetworkManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager.
Properties This property is required. Pulumi.AzureNative.Network.Inputs.ReachabilityAnalysisRunProperties
Represents the Reachability Analysis Run properties.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
Workspace name.
ReachabilityAnalysisRunName Changes to this property will trigger replacement. string
Reachability Analysis Run name.
NetworkManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager.
Properties This property is required. ReachabilityAnalysisRunPropertiesArgs
Represents the Reachability Analysis Run properties.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
Workspace name.
ReachabilityAnalysisRunName Changes to this property will trigger replacement. string
Reachability Analysis Run name.
networkManagerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager.
properties This property is required. ReachabilityAnalysisRunProperties
Represents the Reachability Analysis Run properties.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
Workspace name.
reachabilityAnalysisRunName Changes to this property will trigger replacement. String
Reachability Analysis Run name.
networkManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager.
properties This property is required. ReachabilityAnalysisRunProperties
Represents the Reachability Analysis Run properties.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
Workspace name.
reachabilityAnalysisRunName Changes to this property will trigger replacement. string
Reachability Analysis Run name.
network_manager_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the network manager.
properties This property is required. ReachabilityAnalysisRunPropertiesArgs
Represents the Reachability Analysis Run properties.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
Workspace name.
reachability_analysis_run_name Changes to this property will trigger replacement. str
Reachability Analysis Run name.
networkManagerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager.
properties This property is required. Property Map
Represents the Reachability Analysis Run properties.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
Workspace name.
reachabilityAnalysisRunName Changes to this property will trigger replacement. String
Reachability Analysis Run name.

Outputs

All input properties are implicitly available as output properties. Additionally, the ReachabilityAnalysisRun resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
SystemData Pulumi.AzureNative.Network.Outputs.SystemDataResponse
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"
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
SystemData SystemDataResponse
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"
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
systemData SystemDataResponse
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"
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
systemData SystemDataResponse
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"
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
systemData Property Map
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"

Supporting Types

IPTrafficResponse
, IPTrafficResponseArgs

DestinationIps This property is required. List<string>
List of destination IP addresses of the traffic..
DestinationPorts This property is required. List<string>
The destination ports of the traffic.
Protocols This property is required. List<string>
SourceIps This property is required. List<string>
List of source IP addresses of the traffic..
SourcePorts This property is required. List<string>
The source ports of the traffic.
DestinationIps This property is required. []string
List of destination IP addresses of the traffic..
DestinationPorts This property is required. []string
The destination ports of the traffic.
Protocols This property is required. []string
SourceIps This property is required. []string
List of source IP addresses of the traffic..
SourcePorts This property is required. []string
The source ports of the traffic.
destinationIps This property is required. List<String>
List of destination IP addresses of the traffic..
destinationPorts This property is required. List<String>
The destination ports of the traffic.
protocols This property is required. List<String>
sourceIps This property is required. List<String>
List of source IP addresses of the traffic..
sourcePorts This property is required. List<String>
The source ports of the traffic.
destinationIps This property is required. string[]
List of destination IP addresses of the traffic..
destinationPorts This property is required. string[]
The destination ports of the traffic.
protocols This property is required. string[]
sourceIps This property is required. string[]
List of source IP addresses of the traffic..
sourcePorts This property is required. string[]
The source ports of the traffic.
destination_ips This property is required. Sequence[str]
List of destination IP addresses of the traffic..
destination_ports This property is required. Sequence[str]
The destination ports of the traffic.
protocols This property is required. Sequence[str]
source_ips This property is required. Sequence[str]
List of source IP addresses of the traffic..
source_ports This property is required. Sequence[str]
The source ports of the traffic.
destinationIps This property is required. List<String>
List of destination IP addresses of the traffic..
destinationPorts This property is required. List<String>
The destination ports of the traffic.
protocols This property is required. List<String>
sourceIps This property is required. List<String>
List of source IP addresses of the traffic..
sourcePorts This property is required. List<String>
The source ports of the traffic.

IntentContentResponse
, IntentContentResponseArgs

DestinationResourceId This property is required. string
Destination resource id of the intent.
IpTraffic This property is required. Pulumi.AzureNative.Network.Inputs.IPTrafficResponse
IP traffic information.
SourceResourceId This property is required. string
Source resource id of the intent.
Description string
DestinationResourceId This property is required. string
Destination resource id of the intent.
IpTraffic This property is required. IPTrafficResponse
IP traffic information.
SourceResourceId This property is required. string
Source resource id of the intent.
Description string
destinationResourceId This property is required. String
Destination resource id of the intent.
ipTraffic This property is required. IPTrafficResponse
IP traffic information.
sourceResourceId This property is required. String
Source resource id of the intent.
description String
destinationResourceId This property is required. string
Destination resource id of the intent.
ipTraffic This property is required. IPTrafficResponse
IP traffic information.
sourceResourceId This property is required. string
Source resource id of the intent.
description string
destination_resource_id This property is required. str
Destination resource id of the intent.
ip_traffic This property is required. IPTrafficResponse
IP traffic information.
source_resource_id This property is required. str
Source resource id of the intent.
description str
destinationResourceId This property is required. String
Destination resource id of the intent.
ipTraffic This property is required. Property Map
IP traffic information.
sourceResourceId This property is required. String
Source resource id of the intent.
description String

ReachabilityAnalysisRunProperties
, ReachabilityAnalysisRunPropertiesArgs

IntentId This property is required. string
Id of the intent resource to run analysis on.
Description string
IntentId This property is required. string
Id of the intent resource to run analysis on.
Description string
intentId This property is required. String
Id of the intent resource to run analysis on.
description String
intentId This property is required. string
Id of the intent resource to run analysis on.
description string
intent_id This property is required. str
Id of the intent resource to run analysis on.
description str
intentId This property is required. String
Id of the intent resource to run analysis on.
description String

ReachabilityAnalysisRunPropertiesResponse
, ReachabilityAnalysisRunPropertiesResponseArgs

AnalysisResult This property is required. string
ErrorMessage This property is required. string
IntentContent This property is required. Pulumi.AzureNative.Network.Inputs.IntentContentResponse
Intent information.
IntentId This property is required. string
Id of the intent resource to run analysis on.
ProvisioningState This property is required. string
Provisioning states of a resource.
Description string
AnalysisResult This property is required. string
ErrorMessage This property is required. string
IntentContent This property is required. IntentContentResponse
Intent information.
IntentId This property is required. string
Id of the intent resource to run analysis on.
ProvisioningState This property is required. string
Provisioning states of a resource.
Description string
analysisResult This property is required. String
errorMessage This property is required. String
intentContent This property is required. IntentContentResponse
Intent information.
intentId This property is required. String
Id of the intent resource to run analysis on.
provisioningState This property is required. String
Provisioning states of a resource.
description String
analysisResult This property is required. string
errorMessage This property is required. string
intentContent This property is required. IntentContentResponse
Intent information.
intentId This property is required. string
Id of the intent resource to run analysis on.
provisioningState This property is required. string
Provisioning states of a resource.
description string
analysis_result This property is required. str
error_message This property is required. str
intent_content This property is required. IntentContentResponse
Intent information.
intent_id This property is required. str
Id of the intent resource to run analysis on.
provisioning_state This property is required. str
Provisioning states of a resource.
description str
analysisResult This property is required. String
errorMessage This property is required. String
intentContent This property is required. Property Map
Intent information.
intentId This property is required. String
Id of the intent resource to run analysis on.
provisioningState This property is required. String
Provisioning states of a resource.
description String

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The type of identity that last modified the resource.
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The type of identity that last modified the resource.
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The type of identity that last modified the resource.
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The type of identity that last modified the resource.
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The type of identity that last modified the resource.
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The type of identity that last modified the resource.
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:network:ReachabilityAnalysisRun testAnalysisRunName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/verifierWorkspaces/{workspaceName}/reachabilityAnalysisRuns/{reachabilityAnalysisRunName} 
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0