Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. hybridnetwork
  5. getNetworkFunction
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
pulumi/pulumi-azure-native

azure-native-v2.hybridnetwork.getNetworkFunction

Explore with Pulumi AI

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
pulumi/pulumi-azure-native

Gets information about the specified network function resource. Azure REST API version: 2022-01-01-preview.

Other available API versions: 2023-09-01, 2024-04-15.

Using getNetworkFunction

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 getNetworkFunction(args: GetNetworkFunctionArgs, opts?: InvokeOptions): Promise<GetNetworkFunctionResult>
function getNetworkFunctionOutput(args: GetNetworkFunctionOutputArgs, opts?: InvokeOptions): Output<GetNetworkFunctionResult>
Copy
def get_network_function(network_function_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetNetworkFunctionResult
def get_network_function_output(network_function_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetNetworkFunctionResult]
Copy
func LookupNetworkFunction(ctx *Context, args *LookupNetworkFunctionArgs, opts ...InvokeOption) (*LookupNetworkFunctionResult, error)
func LookupNetworkFunctionOutput(ctx *Context, args *LookupNetworkFunctionOutputArgs, opts ...InvokeOption) LookupNetworkFunctionResultOutput
Copy

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

public static class GetNetworkFunction 
{
    public static Task<GetNetworkFunctionResult> InvokeAsync(GetNetworkFunctionArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkFunctionResult> Invoke(GetNetworkFunctionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNetworkFunctionResult> getNetworkFunction(GetNetworkFunctionArgs args, InvokeOptions options)
public static Output<GetNetworkFunctionResult> getNetworkFunction(GetNetworkFunctionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:hybridnetwork:getNetworkFunction
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

NetworkFunctionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network function resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
NetworkFunctionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network function resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
networkFunctionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network function resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
networkFunctionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network function resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
network_function_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the network function resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
networkFunctionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network function resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getNetworkFunction 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
ManagedApplication Pulumi.AzureNative.HybridNetwork.Outputs.SubResourceResponse
The resource URI of the managed application.
Name string
The name of the resource
ProvisioningState string
The provisioning state of the network function resource.
ServiceKey string
The service key for the network function resource.
SkuType string
The sku type for the network function.
SystemData Pulumi.AzureNative.HybridNetwork.Outputs.SystemDataResponse
The system meta data relating to this resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
VendorProvisioningState string
The vendor provisioning state for the network function resource.
Device Pulumi.AzureNative.HybridNetwork.Outputs.SubResourceResponse
The reference to the device resource. Once set, it cannot be updated.
Etag string
A unique read-only string that changes whenever the resource is updated.
ManagedApplicationParameters object
The parameters for the managed application.
NetworkFunctionContainerConfigurations object
The network function container configurations from the user.
NetworkFunctionUserConfigurations List<Pulumi.AzureNative.HybridNetwork.Outputs.NetworkFunctionUserConfigurationResponse>
The network function configurations from the user.
SkuName string
The sku name for the network function. Once set, it cannot be updated.
Tags Dictionary<string, string>
Resource tags.
VendorName string
The vendor name for the network function. Once set, it cannot be updated.
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
ManagedApplication SubResourceResponse
The resource URI of the managed application.
Name string
The name of the resource
ProvisioningState string
The provisioning state of the network function resource.
ServiceKey string
The service key for the network function resource.
SkuType string
The sku type for the network function.
SystemData SystemDataResponse
The system meta data relating to this resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
VendorProvisioningState string
The vendor provisioning state for the network function resource.
Device SubResourceResponse
The reference to the device resource. Once set, it cannot be updated.
Etag string
A unique read-only string that changes whenever the resource is updated.
ManagedApplicationParameters interface{}
The parameters for the managed application.
NetworkFunctionContainerConfigurations interface{}
The network function container configurations from the user.
NetworkFunctionUserConfigurations []NetworkFunctionUserConfigurationResponse
The network function configurations from the user.
SkuName string
The sku name for the network function. Once set, it cannot be updated.
Tags map[string]string
Resource tags.
VendorName string
The vendor name for the network function. Once set, it cannot be updated.
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
managedApplication SubResourceResponse
The resource URI of the managed application.
name String
The name of the resource
provisioningState String
The provisioning state of the network function resource.
serviceKey String
The service key for the network function resource.
skuType String
The sku type for the network function.
systemData SystemDataResponse
The system meta data relating to this resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
vendorProvisioningState String
The vendor provisioning state for the network function resource.
device SubResourceResponse
The reference to the device resource. Once set, it cannot be updated.
etag String
A unique read-only string that changes whenever the resource is updated.
managedApplicationParameters Object
The parameters for the managed application.
networkFunctionContainerConfigurations Object
The network function container configurations from the user.
networkFunctionUserConfigurations List<NetworkFunctionUserConfigurationResponse>
The network function configurations from the user.
skuName String
The sku name for the network function. Once set, it cannot be updated.
tags Map<String,String>
Resource tags.
vendorName String
The vendor name for the network function. Once set, it cannot be updated.
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
managedApplication SubResourceResponse
The resource URI of the managed application.
name string
The name of the resource
provisioningState string
The provisioning state of the network function resource.
serviceKey string
The service key for the network function resource.
skuType string
The sku type for the network function.
systemData SystemDataResponse
The system meta data relating to this resource.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
vendorProvisioningState string
The vendor provisioning state for the network function resource.
device SubResourceResponse
The reference to the device resource. Once set, it cannot be updated.
etag string
A unique read-only string that changes whenever the resource is updated.
managedApplicationParameters any
The parameters for the managed application.
networkFunctionContainerConfigurations any
The network function container configurations from the user.
networkFunctionUserConfigurations NetworkFunctionUserConfigurationResponse[]
The network function configurations from the user.
skuName string
The sku name for the network function. Once set, it cannot be updated.
tags {[key: string]: string}
Resource tags.
vendorName string
The vendor name for the network function. Once set, it cannot be updated.
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
managed_application SubResourceResponse
The resource URI of the managed application.
name str
The name of the resource
provisioning_state str
The provisioning state of the network function resource.
service_key str
The service key for the network function resource.
sku_type str
The sku type for the network function.
system_data SystemDataResponse
The system meta data relating to this resource.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
vendor_provisioning_state str
The vendor provisioning state for the network function resource.
device SubResourceResponse
The reference to the device resource. Once set, it cannot be updated.
etag str
A unique read-only string that changes whenever the resource is updated.
managed_application_parameters Any
The parameters for the managed application.
network_function_container_configurations Any
The network function container configurations from the user.
network_function_user_configurations Sequence[NetworkFunctionUserConfigurationResponse]
The network function configurations from the user.
sku_name str
The sku name for the network function. Once set, it cannot be updated.
tags Mapping[str, str]
Resource tags.
vendor_name str
The vendor name for the network function. Once set, it cannot be updated.
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
managedApplication Property Map
The resource URI of the managed application.
name String
The name of the resource
provisioningState String
The provisioning state of the network function resource.
serviceKey String
The service key for the network function resource.
skuType String
The sku type for the network function.
systemData Property Map
The system meta data relating to this resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
vendorProvisioningState String
The vendor provisioning state for the network function resource.
device Property Map
The reference to the device resource. Once set, it cannot be updated.
etag String
A unique read-only string that changes whenever the resource is updated.
managedApplicationParameters Any
The parameters for the managed application.
networkFunctionContainerConfigurations Any
The network function container configurations from the user.
networkFunctionUserConfigurations List<Property Map>
The network function configurations from the user.
skuName String
The sku name for the network function. Once set, it cannot be updated.
tags Map<String>
Resource tags.
vendorName String
The vendor name for the network function. Once set, it cannot be updated.

Supporting Types

NetworkFunctionUserConfigurationResponse

NetworkInterfaces List<Pulumi.AzureNative.HybridNetwork.Inputs.NetworkInterfaceResponse>
The network interface configuration.
OsProfile Pulumi.AzureNative.HybridNetwork.Inputs.NetworkFunctionUserConfigurationResponseOsProfile
Specifies the operating system settings for the role instance.
RoleName string
The name of the network function role.
UserDataParameters object
The user data parameters from the customer.
NetworkInterfaces []NetworkInterfaceResponse
The network interface configuration.
OsProfile NetworkFunctionUserConfigurationResponseOsProfile
Specifies the operating system settings for the role instance.
RoleName string
The name of the network function role.
UserDataParameters interface{}
The user data parameters from the customer.
networkInterfaces List<NetworkInterfaceResponse>
The network interface configuration.
osProfile NetworkFunctionUserConfigurationResponseOsProfile
Specifies the operating system settings for the role instance.
roleName String
The name of the network function role.
userDataParameters Object
The user data parameters from the customer.
networkInterfaces NetworkInterfaceResponse[]
The network interface configuration.
osProfile NetworkFunctionUserConfigurationResponseOsProfile
Specifies the operating system settings for the role instance.
roleName string
The name of the network function role.
userDataParameters any
The user data parameters from the customer.
network_interfaces Sequence[NetworkInterfaceResponse]
The network interface configuration.
os_profile NetworkFunctionUserConfigurationResponseOsProfile
Specifies the operating system settings for the role instance.
role_name str
The name of the network function role.
user_data_parameters Any
The user data parameters from the customer.
networkInterfaces List<Property Map>
The network interface configuration.
osProfile Property Map
Specifies the operating system settings for the role instance.
roleName String
The name of the network function role.
userDataParameters Any
The user data parameters from the customer.

NetworkFunctionUserConfigurationResponseOsProfile

CustomData string
Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the virtual machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property This property cannot be updated after the VM is created. customData is passed to the VM to be saved as a file. For more information see Custom Data on Azure VMs For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation
CustomData string
Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the virtual machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property This property cannot be updated after the VM is created. customData is passed to the VM to be saved as a file. For more information see Custom Data on Azure VMs For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation
customData String
Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the virtual machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property This property cannot be updated after the VM is created. customData is passed to the VM to be saved as a file. For more information see Custom Data on Azure VMs For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation
customData string
Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the virtual machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property This property cannot be updated after the VM is created. customData is passed to the VM to be saved as a file. For more information see Custom Data on Azure VMs For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation
custom_data str
Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the virtual machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property This property cannot be updated after the VM is created. customData is passed to the VM to be saved as a file. For more information see Custom Data on Azure VMs For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation
customData String
Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the virtual machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property This property cannot be updated after the VM is created. customData is passed to the VM to be saved as a file. For more information see Custom Data on Azure VMs For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation

NetworkInterfaceIPConfigurationResponse

DnsServers List<string>
The list of DNS servers IP addresses.
Gateway string
The value of the gateway.
IpAddress string
The value of the IP address.
IpAllocationMethod string
IP address allocation method.
IpVersion string
IP address version.
Subnet string
The value of the subnet.
DnsServers []string
The list of DNS servers IP addresses.
Gateway string
The value of the gateway.
IpAddress string
The value of the IP address.
IpAllocationMethod string
IP address allocation method.
IpVersion string
IP address version.
Subnet string
The value of the subnet.
dnsServers List<String>
The list of DNS servers IP addresses.
gateway String
The value of the gateway.
ipAddress String
The value of the IP address.
ipAllocationMethod String
IP address allocation method.
ipVersion String
IP address version.
subnet String
The value of the subnet.
dnsServers string[]
The list of DNS servers IP addresses.
gateway string
The value of the gateway.
ipAddress string
The value of the IP address.
ipAllocationMethod string
IP address allocation method.
ipVersion string
IP address version.
subnet string
The value of the subnet.
dns_servers Sequence[str]
The list of DNS servers IP addresses.
gateway str
The value of the gateway.
ip_address str
The value of the IP address.
ip_allocation_method str
IP address allocation method.
ip_version str
IP address version.
subnet str
The value of the subnet.
dnsServers List<String>
The list of DNS servers IP addresses.
gateway String
The value of the gateway.
ipAddress String
The value of the IP address.
ipAllocationMethod String
IP address allocation method.
ipVersion String
IP address version.
subnet String
The value of the subnet.

NetworkInterfaceResponse

IpConfigurations List<Pulumi.AzureNative.HybridNetwork.Inputs.NetworkInterfaceIPConfigurationResponse>
A list of IP configurations of the network interface.
MacAddress string
The MAC address of the network interface.
NetworkInterfaceName string
The name of the network interface.
VmSwitchType string
The type of the VM switch.
IpConfigurations []NetworkInterfaceIPConfigurationResponse
A list of IP configurations of the network interface.
MacAddress string
The MAC address of the network interface.
NetworkInterfaceName string
The name of the network interface.
VmSwitchType string
The type of the VM switch.
ipConfigurations List<NetworkInterfaceIPConfigurationResponse>
A list of IP configurations of the network interface.
macAddress String
The MAC address of the network interface.
networkInterfaceName String
The name of the network interface.
vmSwitchType String
The type of the VM switch.
ipConfigurations NetworkInterfaceIPConfigurationResponse[]
A list of IP configurations of the network interface.
macAddress string
The MAC address of the network interface.
networkInterfaceName string
The name of the network interface.
vmSwitchType string
The type of the VM switch.
ip_configurations Sequence[NetworkInterfaceIPConfigurationResponse]
A list of IP configurations of the network interface.
mac_address str
The MAC address of the network interface.
network_interface_name str
The name of the network interface.
vm_switch_type str
The type of the VM switch.
ipConfigurations List<Property Map>
A list of IP configurations of the network interface.
macAddress String
The MAC address of the network interface.
networkInterfaceName String
The name of the network interface.
vmSwitchType String
The type of the VM switch.

SubResourceResponse

Id string
Resource ID.
Id string
Resource ID.
id String
Resource ID.
id string
Resource ID.
id str
Resource ID.
id String
Resource ID.

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.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
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
pulumi/pulumi-azure-native