Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. hybridcontainerservice
  5. getVirtualNetworkRetrieve
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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.hybridcontainerservice.getVirtualNetworkRetrieve

Explore with Pulumi AI

azure-native logo
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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets the Hybrid AKS virtual network

    Uses Azure REST API version 2022-09-01-preview.

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

    Using getVirtualNetworkRetrieve

    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 getVirtualNetworkRetrieve(args: GetVirtualNetworkRetrieveArgs, opts?: InvokeOptions): Promise<GetVirtualNetworkRetrieveResult>
function getVirtualNetworkRetrieveOutput(args: GetVirtualNetworkRetrieveOutputArgs, opts?: InvokeOptions): Output<GetVirtualNetworkRetrieveResult>
    def get_virtual_network_retrieve(resource_group_name: Optional[str] = None,
                                 virtual_networks_name: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetVirtualNetworkRetrieveResult
def get_virtual_network_retrieve_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                 virtual_networks_name: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetVirtualNetworkRetrieveResult]
    func LookupVirtualNetworkRetrieve(ctx *Context, args *LookupVirtualNetworkRetrieveArgs, opts ...InvokeOption) (*LookupVirtualNetworkRetrieveResult, error)
func LookupVirtualNetworkRetrieveOutput(ctx *Context, args *LookupVirtualNetworkRetrieveOutputArgs, opts ...InvokeOption) LookupVirtualNetworkRetrieveResultOutput

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

    public static class GetVirtualNetworkRetrieve 
{
    public static Task<GetVirtualNetworkRetrieveResult> InvokeAsync(GetVirtualNetworkRetrieveArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualNetworkRetrieveResult> Invoke(GetVirtualNetworkRetrieveInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVirtualNetworkRetrieveResult> getVirtualNetworkRetrieve(GetVirtualNetworkRetrieveArgs args, InvokeOptions options)
public static Output<GetVirtualNetworkRetrieveResult> getVirtualNetworkRetrieve(GetVirtualNetworkRetrieveArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:hybridcontainerservice:getVirtualNetworkRetrieve
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VirtualNetworksName string
    Parameter for the name of the virtual network
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VirtualNetworksName string
    Parameter for the name of the virtual network
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    virtualNetworksName String
    Parameter for the name of the virtual network
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    virtualNetworksName string
    Parameter for the name of the virtual network
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    virtual_networks_name str
    Parameter for the name of the virtual network
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    virtualNetworksName String
    Parameter for the name of the virtual network

    getVirtualNetworkRetrieve 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. 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
    Properties Pulumi.AzureNative.HybridContainerService.Outputs.VirtualNetworksPropertiesResponse
    HybridAKSNetworkSpec defines the desired state of HybridAKSNetwork
    SystemData Pulumi.AzureNative.HybridContainerService.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    ExtendedLocation Pulumi.AzureNative.HybridContainerService.Outputs.VirtualNetworksResponseExtendedLocation
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    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
    Properties VirtualNetworksPropertiesResponse
    HybridAKSNetworkSpec defines the desired state of HybridAKSNetwork
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    ExtendedLocation VirtualNetworksResponseExtendedLocation
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    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
    properties VirtualNetworksPropertiesResponse
    HybridAKSNetworkSpec defines the desired state of HybridAKSNetwork
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extendedLocation VirtualNetworksResponseExtendedLocation
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    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
    properties VirtualNetworksPropertiesResponse
    HybridAKSNetworkSpec defines the desired state of HybridAKSNetwork
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extendedLocation VirtualNetworksResponseExtendedLocation
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    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
    properties VirtualNetworksPropertiesResponse
    HybridAKSNetworkSpec defines the desired state of HybridAKSNetwork
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extended_location VirtualNetworksResponseExtendedLocation
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    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
    properties Property Map
    HybridAKSNetworkSpec defines the desired state of HybridAKSNetwork
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extendedLocation Property Map
    tags Map<String>
    Resource tags.

    Supporting Types

    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    VirtualNetworksPropertiesResponse

    DhcpServers List<string>
    Address of the DHCP servers associated with the network
    ProvisioningState string
    Status Pulumi.AzureNative.HybridContainerService.Inputs.VirtualNetworksPropertiesResponseStatus
    HybridAKSNetworkStatus defines the observed state of HybridAKSNetwork
    VlanID string
    VLAN Id used by the network
    DnsServers List<string>
    Address of the DNS servers associated with the network
    Gateway string
    Address of the Gateway associated with the network
    InfraVnetProfile Pulumi.AzureNative.HybridContainerService.Inputs.VirtualNetworksPropertiesResponseInfraVnetProfile
    IpAddressPrefix string
    IP Address Prefix of the network
    VipPool List<Pulumi.AzureNative.HybridContainerService.Inputs.VirtualNetworksPropertiesResponseVipPool>
    Virtual IP Pool for Kubernetes
    VmipPool List<Pulumi.AzureNative.HybridContainerService.Inputs.VirtualNetworksPropertiesResponseVmipPool>
    IP Pool for Virtual Machines
    DhcpServers []string
    Address of the DHCP servers associated with the network
    ProvisioningState string
    Status VirtualNetworksPropertiesResponseStatus
    HybridAKSNetworkStatus defines the observed state of HybridAKSNetwork
    VlanID string
    VLAN Id used by the network
    DnsServers []string
    Address of the DNS servers associated with the network
    Gateway string
    Address of the Gateway associated with the network
    InfraVnetProfile VirtualNetworksPropertiesResponseInfraVnetProfile
    IpAddressPrefix string
    IP Address Prefix of the network
    VipPool []VirtualNetworksPropertiesResponseVipPool
    Virtual IP Pool for Kubernetes
    VmipPool []VirtualNetworksPropertiesResponseVmipPool
    IP Pool for Virtual Machines
    dhcpServers List<String>
    Address of the DHCP servers associated with the network
    provisioningState String
    status VirtualNetworksPropertiesResponseStatus
    HybridAKSNetworkStatus defines the observed state of HybridAKSNetwork
    vlanID String
    VLAN Id used by the network
    dnsServers List<String>
    Address of the DNS servers associated with the network
    gateway String
    Address of the Gateway associated with the network
    infraVnetProfile VirtualNetworksPropertiesResponseInfraVnetProfile
    ipAddressPrefix String
    IP Address Prefix of the network
    vipPool List<VirtualNetworksPropertiesResponseVipPool>
    Virtual IP Pool for Kubernetes
    vmipPool List<VirtualNetworksPropertiesResponseVmipPool>
    IP Pool for Virtual Machines
    dhcpServers string[]
    Address of the DHCP servers associated with the network
    provisioningState string
    status VirtualNetworksPropertiesResponseStatus
    HybridAKSNetworkStatus defines the observed state of HybridAKSNetwork
    vlanID string
    VLAN Id used by the network
    dnsServers string[]
    Address of the DNS servers associated with the network
    gateway string
    Address of the Gateway associated with the network
    infraVnetProfile VirtualNetworksPropertiesResponseInfraVnetProfile
    ipAddressPrefix string
    IP Address Prefix of the network
    vipPool VirtualNetworksPropertiesResponseVipPool[]
    Virtual IP Pool for Kubernetes
    vmipPool VirtualNetworksPropertiesResponseVmipPool[]
    IP Pool for Virtual Machines
    dhcp_servers Sequence[str]
    Address of the DHCP servers associated with the network
    provisioning_state str
    status VirtualNetworksPropertiesResponseStatus
    HybridAKSNetworkStatus defines the observed state of HybridAKSNetwork
    vlan_id str
    VLAN Id used by the network
    dns_servers Sequence[str]
    Address of the DNS servers associated with the network
    gateway str
    Address of the Gateway associated with the network
    infra_vnet_profile VirtualNetworksPropertiesResponseInfraVnetProfile
    ip_address_prefix str
    IP Address Prefix of the network
    vip_pool Sequence[VirtualNetworksPropertiesResponseVipPool]
    Virtual IP Pool for Kubernetes
    vmip_pool Sequence[VirtualNetworksPropertiesResponseVmipPool]
    IP Pool for Virtual Machines
    dhcpServers List<String>
    Address of the DHCP servers associated with the network
    provisioningState String
    status Property Map
    HybridAKSNetworkStatus defines the observed state of HybridAKSNetwork
    vlanID String
    VLAN Id used by the network
    dnsServers List<String>
    Address of the DNS servers associated with the network
    gateway String
    Address of the Gateway associated with the network
    infraVnetProfile Property Map
    ipAddressPrefix String
    IP Address Prefix of the network
    vipPool List<Property Map>
    Virtual IP Pool for Kubernetes
    vmipPool List<Property Map>
    IP Pool for Virtual Machines

    VirtualNetworksPropertiesResponseError

    Code string
    Message string
    Code string
    Message string
    code String
    message String
    code string
    message string
    code str
    message str
    code String
    message String

    VirtualNetworksPropertiesResponseHci

    MocGroup string
    Resource group in MOC(Microsoft On-premises Cloud)
    MocLocation string
    Location in MOC(Microsoft On-premises Cloud)
    MocVnetName string
    Virtual Network name in MOC(Microsoft On-premises Cloud)
    MocGroup string
    Resource group in MOC(Microsoft On-premises Cloud)
    MocLocation string
    Location in MOC(Microsoft On-premises Cloud)
    MocVnetName string
    Virtual Network name in MOC(Microsoft On-premises Cloud)
    mocGroup String
    Resource group in MOC(Microsoft On-premises Cloud)
    mocLocation String
    Location in MOC(Microsoft On-premises Cloud)
    mocVnetName String
    Virtual Network name in MOC(Microsoft On-premises Cloud)
    mocGroup string
    Resource group in MOC(Microsoft On-premises Cloud)
    mocLocation string
    Location in MOC(Microsoft On-premises Cloud)
    mocVnetName string
    Virtual Network name in MOC(Microsoft On-premises Cloud)
    moc_group str
    Resource group in MOC(Microsoft On-premises Cloud)
    moc_location str
    Location in MOC(Microsoft On-premises Cloud)
    moc_vnet_name str
    Virtual Network name in MOC(Microsoft On-premises Cloud)
    mocGroup String
    Resource group in MOC(Microsoft On-premises Cloud)
    mocLocation String
    Location in MOC(Microsoft On-premises Cloud)
    mocVnetName String
    Virtual Network name in MOC(Microsoft On-premises Cloud)

    VirtualNetworksPropertiesResponseInfraVnetProfile

    Hci VirtualNetworksPropertiesResponseHci
    Infra network profile for HCI platform
    NetworkCloud VirtualNetworksPropertiesResponseNetworkCloud
    Infra network profile for the NetworkCloud platform
    Vmware VirtualNetworksPropertiesResponseVmware
    Infra network profile for VMware platform
    hci VirtualNetworksPropertiesResponseHci
    Infra network profile for HCI platform
    networkCloud VirtualNetworksPropertiesResponseNetworkCloud
    Infra network profile for the NetworkCloud platform
    vmware VirtualNetworksPropertiesResponseVmware
    Infra network profile for VMware platform
    hci VirtualNetworksPropertiesResponseHci
    Infra network profile for HCI platform
    networkCloud VirtualNetworksPropertiesResponseNetworkCloud
    Infra network profile for the NetworkCloud platform
    vmware VirtualNetworksPropertiesResponseVmware
    Infra network profile for VMware platform
    hci VirtualNetworksPropertiesResponseHci
    Infra network profile for HCI platform
    network_cloud VirtualNetworksPropertiesResponseNetworkCloud
    Infra network profile for the NetworkCloud platform
    vmware VirtualNetworksPropertiesResponseVmware
    Infra network profile for VMware platform
    hci Property Map
    Infra network profile for HCI platform
    networkCloud Property Map
    Infra network profile for the NetworkCloud platform
    vmware Property Map
    Infra network profile for VMware platform

    VirtualNetworksPropertiesResponseNetworkCloud

    NetworkId string
    The ARM ID of Network Cloud Network Resource to Associate with this VirtualNetwork
    NetworkId string
    The ARM ID of Network Cloud Network Resource to Associate with this VirtualNetwork
    networkId String
    The ARM ID of Network Cloud Network Resource to Associate with this VirtualNetwork
    networkId string
    The ARM ID of Network Cloud Network Resource to Associate with this VirtualNetwork
    network_id str
    The ARM ID of Network Cloud Network Resource to Associate with this VirtualNetwork
    networkId String
    The ARM ID of Network Cloud Network Resource to Associate with this VirtualNetwork

    VirtualNetworksPropertiesResponseProvisioningStatus

    Error Pulumi.AzureNative.HybridContainerService.Inputs.VirtualNetworksPropertiesResponseError
    OperationId string
    Phase string
    Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.
    Status string
    Error VirtualNetworksPropertiesResponseError
    OperationId string
    Phase string
    Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.
    Status string
    error VirtualNetworksPropertiesResponseError
    operationId String
    phase String
    Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.
    status String
    error VirtualNetworksPropertiesResponseError
    operationId string
    phase string
    Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.
    status string
    error VirtualNetworksPropertiesResponseError
    operation_id str
    phase str
    Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.
    status str
    error Property Map
    operationId String
    phase String
    Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.
    status String

    VirtualNetworksPropertiesResponseStatus

    provisioningStatus Property Map
    Contains Provisioning errors

    VirtualNetworksPropertiesResponseVipPool

    EndIP string
    Ending IP address for the IP Pool
    StartIP string
    Starting IP address for the IP Pool
    EndIP string
    Ending IP address for the IP Pool
    StartIP string
    Starting IP address for the IP Pool
    endIP String
    Ending IP address for the IP Pool
    startIP String
    Starting IP address for the IP Pool
    endIP string
    Ending IP address for the IP Pool
    startIP string
    Starting IP address for the IP Pool
    end_ip str
    Ending IP address for the IP Pool
    start_ip str
    Starting IP address for the IP Pool
    endIP String
    Ending IP address for the IP Pool
    startIP String
    Starting IP address for the IP Pool

    VirtualNetworksPropertiesResponseVmipPool

    EndIP string
    Ending IP address for the IP Pool
    StartIP string
    Starting IP address for the IP Pool
    EndIP string
    Ending IP address for the IP Pool
    StartIP string
    Starting IP address for the IP Pool
    endIP String
    Ending IP address for the IP Pool
    startIP String
    Starting IP address for the IP Pool
    endIP string
    Ending IP address for the IP Pool
    startIP string
    Starting IP address for the IP Pool
    end_ip str
    Ending IP address for the IP Pool
    start_ip str
    Starting IP address for the IP Pool
    endIP String
    Ending IP address for the IP Pool
    startIP String
    Starting IP address for the IP Pool

    VirtualNetworksPropertiesResponseVmware

    SegmentName string
    Name of the network segment in VSphere
    SegmentName string
    Name of the network segment in VSphere
    segmentName String
    Name of the network segment in VSphere
    segmentName string
    Name of the network segment in VSphere
    segment_name str
    Name of the network segment in VSphere
    segmentName String
    Name of the network segment in VSphere

    VirtualNetworksResponseExtendedLocation

    Name string
    The extended location name.
    Type string
    The extended location type.
    Name string
    The extended location name.
    Type string
    The extended location type.
    name String
    The extended location name.
    type String
    The extended location type.
    name string
    The extended location name.
    type string
    The extended location type.
    name str
    The extended location name.
    type str
    The extended location type.
    name String
    The extended location name.
    type String
    The extended location type.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native