This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
azure-native.azurestackhci.getLogicalNetwork
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
The logical network resource definition. Azure REST API version: 2023-09-01-preview.
Other available API versions: 2024-01-01, 2024-02-01-preview, 2024-05-01-preview, 2024-07-15-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-02-01-preview.
Using getLogicalNetwork
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 getLogicalNetwork(args: GetLogicalNetworkArgs, opts?: InvokeOptions): Promise<GetLogicalNetworkResult>
function getLogicalNetworkOutput(args: GetLogicalNetworkOutputArgs, opts?: InvokeOptions): Output<GetLogicalNetworkResult>def get_logical_network(logical_network_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetLogicalNetworkResult
def get_logical_network_output(logical_network_name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetLogicalNetworkResult]func LookupLogicalNetwork(ctx *Context, args *LookupLogicalNetworkArgs, opts ...InvokeOption) (*LookupLogicalNetworkResult, error)
func LookupLogicalNetworkOutput(ctx *Context, args *LookupLogicalNetworkOutputArgs, opts ...InvokeOption) LookupLogicalNetworkResultOutput> Note: This function is named LookupLogicalNetwork in the Go SDK.
public static class GetLogicalNetwork 
{
    public static Task<GetLogicalNetworkResult> InvokeAsync(GetLogicalNetworkArgs args, InvokeOptions? opts = null)
    public static Output<GetLogicalNetworkResult> Invoke(GetLogicalNetworkInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetLogicalNetworkResult> getLogicalNetwork(GetLogicalNetworkArgs args, InvokeOptions options)
public static Output<GetLogicalNetworkResult> getLogicalNetwork(GetLogicalNetworkArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:azurestackhci:getLogicalNetwork
  arguments:
    # arguments dictionaryThe following arguments are supported:
- LogicalNetwork stringName 
- Name of the logical network
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- LogicalNetwork stringName 
- Name of the logical network
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- logicalNetwork StringName 
- Name of the logical network
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- logicalNetwork stringName 
- Name of the logical network
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- logical_network_ strname 
- Name of the logical network
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- logicalNetwork StringName 
- Name of the logical network
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
getLogicalNetwork Result
The following output properties are available:
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- ProvisioningState string
- Provisioning state of the logical network.
- Status
Pulumi.Azure Native. Azure Stack HCI. Outputs. Logical Network Status Response 
- The observed state of logical networks
- SystemData Pulumi.Azure Native. Azure Stack HCI. Outputs. System Data Response 
- 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"
- DhcpOptions Pulumi.Azure Native. Azure Stack HCI. Outputs. Logical Network Properties Response Dhcp Options 
- DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options.
- ExtendedLocation Pulumi.Azure Native. Azure Stack HCI. Outputs. Extended Location Response 
- The extendedLocation of the resource.
- Subnets
List<Pulumi.Azure Native. Azure Stack HCI. Outputs. Subnet Response> 
- Subnet - list of subnets under the logical network
- Dictionary<string, string>
- Resource tags.
- VmSwitch stringName 
- name of the network switch to be used for VMs
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- ProvisioningState string
- Provisioning state of the logical network.
- Status
LogicalNetwork Status Response 
- The observed state of logical networks
- SystemData SystemData Response 
- 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"
- DhcpOptions LogicalNetwork Properties Response Dhcp Options 
- DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options.
- ExtendedLocation ExtendedLocation Response 
- The extendedLocation of the resource.
- Subnets
[]SubnetResponse 
- Subnet - list of subnets under the logical network
- map[string]string
- Resource tags.
- VmSwitch stringName 
- name of the network switch to be used for VMs
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- provisioningState String
- Provisioning state of the logical network.
- status
LogicalNetwork Status Response 
- The observed state of logical networks
- systemData SystemData Response 
- 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"
- dhcpOptions LogicalNetwork Properties Response Dhcp Options 
- DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options.
- extendedLocation ExtendedLocation Response 
- The extendedLocation of the resource.
- subnets
List<SubnetResponse> 
- Subnet - list of subnets under the logical network
- Map<String,String>
- Resource tags.
- vmSwitch StringName 
- name of the network switch to be used for VMs
- id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- location string
- The geo-location where the resource lives
- name string
- The name of the resource
- provisioningState string
- Provisioning state of the logical network.
- status
LogicalNetwork Status Response 
- The observed state of logical networks
- systemData SystemData Response 
- 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"
- dhcpOptions LogicalNetwork Properties Response Dhcp Options 
- DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options.
- extendedLocation ExtendedLocation Response 
- The extendedLocation of the resource.
- subnets
SubnetResponse[] 
- Subnet - list of subnets under the logical network
- {[key: string]: string}
- Resource tags.
- vmSwitch stringName 
- name of the network switch to be used for VMs
- id str
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- location str
- The geo-location where the resource lives
- name str
- The name of the resource
- provisioning_state str
- Provisioning state of the logical network.
- status
LogicalNetwork Status Response 
- The observed state of logical networks
- system_data SystemData Response 
- 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"
- dhcp_options LogicalNetwork Properties Response Dhcp Options 
- DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options.
- extended_location ExtendedLocation Response 
- The extendedLocation of the resource.
- subnets
Sequence[SubnetResponse] 
- Subnet - list of subnets under the logical network
- Mapping[str, str]
- Resource tags.
- vm_switch_ strname 
- name of the network switch to be used for VMs
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- provisioningState String
- Provisioning state of the logical network.
- status Property Map
- The observed state of logical networks
- 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"
- dhcpOptions Property Map
- DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options.
- extendedLocation Property Map
- The extendedLocation of the resource.
- subnets List<Property Map>
- Subnet - list of subnets under the logical network
- Map<String>
- Resource tags.
- vmSwitch StringName 
- name of the network switch to be used for VMs
Supporting Types
ExtendedLocationResponse  
IPPoolInfoResponse  
IPPoolResponse 
- End string
- end of the ip address pool
- Info
Pulumi.Azure Native. Azure Stack HCI. Inputs. IPPool Info Response 
- IpPool stringType 
- ip pool type
- Name string
- Name of the IP-Pool
- Start string
- start of the ip address pool
- End string
- end of the ip address pool
- Info
IPPoolInfo Response 
- IpPool stringType 
- ip pool type
- Name string
- Name of the IP-Pool
- Start string
- start of the ip address pool
- end String
- end of the ip address pool
- info
IPPoolInfo Response 
- ipPool StringType 
- ip pool type
- name String
- Name of the IP-Pool
- start String
- start of the ip address pool
- end string
- end of the ip address pool
- info
IPPoolInfo Response 
- ipPool stringType 
- ip pool type
- name string
- Name of the IP-Pool
- start string
- start of the ip address pool
- end str
- end of the ip address pool
- info
IPPoolInfo Response 
- ip_pool_ strtype 
- ip pool type
- name str
- Name of the IP-Pool
- start str
- start of the ip address pool
- end String
- end of the ip address pool
- info Property Map
- ipPool StringType 
- ip pool type
- name String
- Name of the IP-Pool
- start String
- start of the ip address pool
LogicalNetworkPropertiesResponseDhcpOptions     
- DnsServers List<string>
- The list of DNS servers IP addresses.
- DnsServers []string
- The list of DNS servers IP addresses.
- dnsServers List<String>
- The list of DNS servers IP addresses.
- dnsServers string[]
- The list of DNS servers IP addresses.
- dns_servers Sequence[str]
- The list of DNS servers IP addresses.
- dnsServers List<String>
- The list of DNS servers IP addresses.
LogicalNetworkStatusResponse   
- ErrorCode string
- LogicalNetwork provisioning error code
- ErrorMessage string
- Descriptive error message
- ProvisioningStatus Pulumi.Azure Native. Azure Stack HCI. Inputs. Logical Network Status Response Provisioning Status 
- ErrorCode string
- LogicalNetwork provisioning error code
- ErrorMessage string
- Descriptive error message
- ProvisioningStatus LogicalNetwork Status Response Provisioning Status 
- errorCode String
- LogicalNetwork provisioning error code
- errorMessage String
- Descriptive error message
- provisioningStatus LogicalNetwork Status Response Provisioning Status 
- errorCode string
- LogicalNetwork provisioning error code
- errorMessage string
- Descriptive error message
- provisioningStatus LogicalNetwork Status Response Provisioning Status 
- error_code str
- LogicalNetwork provisioning error code
- error_message str
- Descriptive error message
- provisioning_status LogicalNetwork Status Response Provisioning Status 
- errorCode String
- LogicalNetwork provisioning error code
- errorMessage String
- Descriptive error message
- provisioningStatus Property Map
LogicalNetworkStatusResponseProvisioningStatus     
- OperationId string
- The ID of the operation performed on the logical network
- Status string
- The status of the operation performed on the logical network [Succeeded, Failed, InProgress]
- OperationId string
- The ID of the operation performed on the logical network
- Status string
- The status of the operation performed on the logical network [Succeeded, Failed, InProgress]
- operationId String
- The ID of the operation performed on the logical network
- status String
- The status of the operation performed on the logical network [Succeeded, Failed, InProgress]
- operationId string
- The ID of the operation performed on the logical network
- status string
- The status of the operation performed on the logical network [Succeeded, Failed, InProgress]
- operation_id str
- The ID of the operation performed on the logical network
- status str
- The status of the operation performed on the logical network [Succeeded, Failed, InProgress]
- operationId String
- The ID of the operation performed on the logical network
- status String
- The status of the operation performed on the logical network [Succeeded, Failed, InProgress]
RouteResponse 
- AddressPrefix string
- The destination CIDR to which the route applies.
- Name string
- Name - name of the subnet
- NextHop stringIp Address 
- The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
- AddressPrefix string
- The destination CIDR to which the route applies.
- Name string
- Name - name of the subnet
- NextHop stringIp Address 
- The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
- addressPrefix String
- The destination CIDR to which the route applies.
- name String
- Name - name of the subnet
- nextHop StringIp Address 
- The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
- addressPrefix string
- The destination CIDR to which the route applies.
- name string
- Name - name of the subnet
- nextHop stringIp Address 
- The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
- address_prefix str
- The destination CIDR to which the route applies.
- name str
- Name - name of the subnet
- next_hop_ strip_ address 
- The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
- addressPrefix String
- The destination CIDR to which the route applies.
- name String
- Name - name of the subnet
- nextHop StringIp Address 
- The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
RouteTableResponse  
- Etag string
- A unique read-only string that changes whenever the resource is updated.
- Name string
- Resource name.
- Type string
- Resource type.
- Routes
List<Pulumi.Azure Native. Azure Stack HCI. Inputs. Route Response> 
- Collection of routes contained within a route table.
- Etag string
- A unique read-only string that changes whenever the resource is updated.
- Name string
- Resource name.
- Type string
- Resource type.
- Routes
[]RouteResponse 
- Collection of routes contained within a route table.
- etag String
- A unique read-only string that changes whenever the resource is updated.
- name String
- Resource name.
- type String
- Resource type.
- routes
List<RouteResponse> 
- Collection of routes contained within a route table.
- etag string
- A unique read-only string that changes whenever the resource is updated.
- name string
- Resource name.
- type string
- Resource type.
- routes
RouteResponse[] 
- Collection of routes contained within a route table.
- etag str
- A unique read-only string that changes whenever the resource is updated.
- name str
- Resource name.
- type str
- Resource type.
- routes
Sequence[RouteResponse] 
- Collection of routes contained within a route table.
- etag String
- A unique read-only string that changes whenever the resource is updated.
- name String
- Resource name.
- type String
- Resource type.
- routes List<Property Map>
- Collection of routes contained within a route table.
SubnetPropertiesFormatResponseIpConfigurationReferences      
- Id string
- IPConfigurationID
- Id string
- IPConfigurationID
- id String
- IPConfigurationID
- id string
- IPConfigurationID
- id str
- IPConfigurationID
- id String
- IPConfigurationID
SubnetResponse 
- AddressPrefix string
- The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6.
- AddressPrefixes List<string>
- List of address prefixes for the subnet.
- IpAllocation stringMethod 
- IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'
- IpConfiguration List<Pulumi.References Azure Native. Azure Stack HCI. Inputs. Subnet Properties Format Response Ip Configuration References> 
- IPConfigurationReferences - list of IPConfigurationReferences
- IpPools List<Pulumi.Azure Native. Azure Stack HCI. Inputs. IPPool Response> 
- network associated pool of IP Addresses
- Name string
- Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
- RouteTable Pulumi.Azure Native. Azure Stack HCI. Inputs. Route Table Response 
- Route table resource.
- Vlan int
- Vlan to use for the subnet
- AddressPrefix string
- The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6.
- AddressPrefixes []string
- List of address prefixes for the subnet.
- IpAllocation stringMethod 
- IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'
- IpConfiguration []SubnetReferences Properties Format Response Ip Configuration References 
- IPConfigurationReferences - list of IPConfigurationReferences
- IpPools []IPPoolResponse 
- network associated pool of IP Addresses
- Name string
- Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
- RouteTable RouteTable Response 
- Route table resource.
- Vlan int
- Vlan to use for the subnet
- addressPrefix String
- The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6.
- addressPrefixes List<String>
- List of address prefixes for the subnet.
- ipAllocation StringMethod 
- IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'
- ipConfiguration List<SubnetReferences Properties Format Response Ip Configuration References> 
- IPConfigurationReferences - list of IPConfigurationReferences
- ipPools List<IPPoolResponse> 
- network associated pool of IP Addresses
- name String
- Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
- routeTable RouteTable Response 
- Route table resource.
- vlan Integer
- Vlan to use for the subnet
- addressPrefix string
- The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6.
- addressPrefixes string[]
- List of address prefixes for the subnet.
- ipAllocation stringMethod 
- IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'
- ipConfiguration SubnetReferences Properties Format Response Ip Configuration References[] 
- IPConfigurationReferences - list of IPConfigurationReferences
- ipPools IPPoolResponse[] 
- network associated pool of IP Addresses
- name string
- Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
- routeTable RouteTable Response 
- Route table resource.
- vlan number
- Vlan to use for the subnet
- address_prefix str
- The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6.
- address_prefixes Sequence[str]
- List of address prefixes for the subnet.
- ip_allocation_ strmethod 
- IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'
- ip_configuration_ Sequence[Subnetreferences Properties Format Response Ip Configuration References] 
- IPConfigurationReferences - list of IPConfigurationReferences
- ip_pools Sequence[IPPoolResponse] 
- network associated pool of IP Addresses
- name str
- Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
- route_table RouteTable Response 
- Route table resource.
- vlan int
- Vlan to use for the subnet
- addressPrefix String
- The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6.
- addressPrefixes List<String>
- List of address prefixes for the subnet.
- ipAllocation StringMethod 
- IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'
- ipConfiguration List<Property Map>References 
- IPConfigurationReferences - list of IPConfigurationReferences
- ipPools List<Property Map>
- network associated pool of IP Addresses
- name String
- Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
- routeTable Property Map
- Route table resource.
- vlan Number
- Vlan to use for the subnet
SystemDataResponse  
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- 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_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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 v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi