1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getReachabilityAnalysisRun
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.network.getReachabilityAnalysisRun

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Configuration information for analysis run.

Uses Azure REST API version 2024-05-01.

Other available API versions: 2024-01-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the version guide for details.

Using getReachabilityAnalysisRun

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getReachabilityAnalysisRun(args: GetReachabilityAnalysisRunArgs, opts?: InvokeOptions): Promise<GetReachabilityAnalysisRunResult>
function getReachabilityAnalysisRunOutput(args: GetReachabilityAnalysisRunOutputArgs, opts?: InvokeOptions): Output<GetReachabilityAnalysisRunResult>
Copy
def get_reachability_analysis_run(network_manager_name: Optional[str] = None,
                                  reachability_analysis_run_name: Optional[str] = None,
                                  resource_group_name: Optional[str] = None,
                                  workspace_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetReachabilityAnalysisRunResult
def get_reachability_analysis_run_output(network_manager_name: Optional[pulumi.Input[str]] = None,
                                  reachability_analysis_run_name: Optional[pulumi.Input[str]] = None,
                                  resource_group_name: Optional[pulumi.Input[str]] = None,
                                  workspace_name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetReachabilityAnalysisRunResult]
Copy
func LookupReachabilityAnalysisRun(ctx *Context, args *LookupReachabilityAnalysisRunArgs, opts ...InvokeOption) (*LookupReachabilityAnalysisRunResult, error)
func LookupReachabilityAnalysisRunOutput(ctx *Context, args *LookupReachabilityAnalysisRunOutputArgs, opts ...InvokeOption) LookupReachabilityAnalysisRunResultOutput
Copy

> Note: This function is named LookupReachabilityAnalysisRun in the Go SDK.

public static class GetReachabilityAnalysisRun 
{
    public static Task<GetReachabilityAnalysisRunResult> InvokeAsync(GetReachabilityAnalysisRunArgs args, InvokeOptions? opts = null)
    public static Output<GetReachabilityAnalysisRunResult> Invoke(GetReachabilityAnalysisRunInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetReachabilityAnalysisRunResult> getReachabilityAnalysisRun(GetReachabilityAnalysisRunArgs args, InvokeOptions options)
public static Output<GetReachabilityAnalysisRunResult> getReachabilityAnalysisRun(GetReachabilityAnalysisRunArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getReachabilityAnalysisRun
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

NetworkManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager.
ReachabilityAnalysisRunName
This property is required.
Changes to this property will trigger replacement.
string
Reachability Analysis Run name.
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.
NetworkManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager.
ReachabilityAnalysisRunName
This property is required.
Changes to this property will trigger replacement.
string
Reachability Analysis Run name.
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.
networkManagerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager.
reachabilityAnalysisRunName
This property is required.
Changes to this property will trigger replacement.
String
Reachability Analysis Run name.
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.
networkManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager.
reachabilityAnalysisRunName
This property is required.
Changes to this property will trigger replacement.
string
Reachability Analysis Run name.
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.
network_manager_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the network manager.
reachability_analysis_run_name
This property is required.
Changes to this property will trigger replacement.
str
Reachability Analysis Run name.
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.
networkManagerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager.
reachabilityAnalysisRunName
This property is required.
Changes to this property will trigger replacement.
String
Reachability Analysis Run name.
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.

getReachabilityAnalysisRun Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
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
Properties Pulumi.AzureNative.Network.Outputs.ReachabilityAnalysisRunPropertiesResponse
Represents the Reachability Analysis Run properties.
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"
AzureApiVersion string
The Azure API version of the resource.
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
Properties ReachabilityAnalysisRunPropertiesResponse
Represents the Reachability Analysis Run properties.
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"
azureApiVersion String
The Azure API version of the resource.
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
properties ReachabilityAnalysisRunPropertiesResponse
Represents the Reachability Analysis Run properties.
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"
azureApiVersion string
The Azure API version of the resource.
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
properties ReachabilityAnalysisRunPropertiesResponse
Represents the Reachability Analysis Run properties.
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"
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name str
The name of the resource
properties ReachabilityAnalysisRunPropertiesResponse
Represents the Reachability Analysis Run properties.
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"
azureApiVersion String
The Azure API version of the resource.
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
properties Property Map
Represents the Reachability Analysis Run properties.
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

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

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

ReachabilityAnalysisRunPropertiesResponse

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

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.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi