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.71.0 published on Friday, Nov 8, 2024 by Pulumi
azure-native.hybridnetwork.getNetworkFunction
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.71.0 published on Friday, Nov 8, 2024 by Pulumi
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>
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]
func LookupNetworkFunction(ctx *Context, args *LookupNetworkFunctionArgs, opts ...InvokeOption) (*LookupNetworkFunctionResult, error)
func LookupNetworkFunctionOutput(ctx *Context, args *LookupNetworkFunctionOutputArgs, opts ...InvokeOption) LookupNetworkFunctionResultOutput
> 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)
}
public static CompletableFuture<GetNetworkFunctionResult> getNetworkFunction(GetNetworkFunctionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:hybridnetwork:getNetworkFunction
arguments:
# arguments dictionary
The following arguments are supported:
- Network
Function stringName - The name of the network function resource.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Network
Function stringName - The name of the network function resource.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- network
Function StringName - The name of the network function resource.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- network
Function stringName - The name of the network function resource.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- network_
function_ strname - The name of the network function resource.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- network
Function StringName - The name of the network function resource.
- resource
Group StringName - 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
- Managed
Application Pulumi.Azure Native. Hybrid Network. Outputs. Sub Resource Response - The resource URI of the managed application.
- Name string
- The name of the resource
- Provisioning
State string - The provisioning state of the network function resource.
- Service
Key string - The service key for the network function resource.
- Sku
Type string - The sku type for the network function.
- System
Data Pulumi.Azure Native. Hybrid Network. Outputs. System Data Response - The system meta data relating to this resource.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Vendor
Provisioning stringState - The vendor provisioning state for the network function resource.
- Device
Pulumi.
Azure Native. Hybrid Network. Outputs. Sub Resource Response - 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.
- Managed
Application objectParameters - The parameters for the managed application.
- Network
Function objectContainer Configurations - The network function container configurations from the user.
- Network
Function List<Pulumi.User Configurations Azure Native. Hybrid Network. Outputs. Network Function User Configuration Response> - The network function configurations from the user.
- Sku
Name string - The sku name for the network function. Once set, it cannot be updated.
- Dictionary<string, string>
- Resource tags.
- Vendor
Name 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
- Managed
Application SubResource Response - The resource URI of the managed application.
- Name string
- The name of the resource
- Provisioning
State string - The provisioning state of the network function resource.
- Service
Key string - The service key for the network function resource.
- Sku
Type string - The sku type for the network function.
- System
Data SystemData Response - The system meta data relating to this resource.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Vendor
Provisioning stringState - The vendor provisioning state for the network function resource.
- Device
Sub
Resource Response - 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.
- Managed
Application interface{}Parameters - The parameters for the managed application.
- Network
Function interface{}Container Configurations - The network function container configurations from the user.
- Network
Function []NetworkUser Configurations Function User Configuration Response - The network function configurations from the user.
- Sku
Name string - The sku name for the network function. Once set, it cannot be updated.
- map[string]string
- Resource tags.
- Vendor
Name 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
- managed
Application SubResource Response - The resource URI of the managed application.
- name String
- The name of the resource
- provisioning
State String - The provisioning state of the network function resource.
- service
Key String - The service key for the network function resource.
- sku
Type String - The sku type for the network function.
- system
Data SystemData Response - The system meta data relating to this resource.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- vendor
Provisioning StringState - The vendor provisioning state for the network function resource.
- device
Sub
Resource Response - 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.
- managed
Application ObjectParameters - The parameters for the managed application.
- network
Function ObjectContainer Configurations - The network function container configurations from the user.
- network
Function List<NetworkUser Configurations Function User Configuration Response> - The network function configurations from the user.
- sku
Name String - The sku name for the network function. Once set, it cannot be updated.
- Map<String,String>
- Resource tags.
- vendor
Name 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
- managed
Application SubResource Response - The resource URI of the managed application.
- name string
- The name of the resource
- provisioning
State string - The provisioning state of the network function resource.
- service
Key string - The service key for the network function resource.
- sku
Type string - The sku type for the network function.
- system
Data SystemData Response - The system meta data relating to this resource.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- vendor
Provisioning stringState - The vendor provisioning state for the network function resource.
- device
Sub
Resource Response - 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.
- managed
Application anyParameters - The parameters for the managed application.
- network
Function anyContainer Configurations - The network function container configurations from the user.
- network
Function NetworkUser Configurations Function User Configuration Response[] - The network function configurations from the user.
- sku
Name string - The sku name for the network function. Once set, it cannot be updated.
- {[key: string]: string}
- Resource tags.
- vendor
Name 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 SubResource Response - 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 SystemData Response - 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_ strstate - The vendor provisioning state for the network function resource.
- device
Sub
Resource Response - 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_ Anyparameters - The parameters for the managed application.
- network_
function_ Anycontainer_ configurations - The network function container configurations from the user.
- network_
function_ Sequence[Networkuser_ configurations Function User Configuration Response] - The network function configurations from the user.
- sku_
name str - The sku name for the network function. Once set, it cannot be updated.
- 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
- managed
Application Property Map - The resource URI of the managed application.
- name String
- The name of the resource
- provisioning
State String - The provisioning state of the network function resource.
- service
Key String - The service key for the network function resource.
- sku
Type String - The sku type for the network function.
- system
Data 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"
- vendor
Provisioning StringState - 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.
- managed
Application AnyParameters - The parameters for the managed application.
- network
Function AnyContainer Configurations - The network function container configurations from the user.
- network
Function List<Property Map>User Configurations - The network function configurations from the user.
- sku
Name String - The sku name for the network function. Once set, it cannot be updated.
- Map<String>
- Resource tags.
- vendor
Name String - The vendor name for the network function. Once set, it cannot be updated.
Supporting Types
NetworkFunctionUserConfigurationResponse
- Network
Interfaces List<Pulumi.Azure Native. Hybrid Network. Inputs. Network Interface Response> - The network interface configuration.
- Os
Profile Pulumi.Azure Native. Hybrid Network. Inputs. Network Function User Configuration Response Os Profile - Specifies the operating system settings for the role instance.
- Role
Name string - The name of the network function role.
- User
Data objectParameters - The user data parameters from the customer.
- Network
Interfaces []NetworkInterface Response - The network interface configuration.
- Os
Profile NetworkFunction User Configuration Response Os Profile - Specifies the operating system settings for the role instance.
- Role
Name string - The name of the network function role.
- User
Data interface{}Parameters - The user data parameters from the customer.
- network
Interfaces List<NetworkInterface Response> - The network interface configuration.
- os
Profile NetworkFunction User Configuration Response Os Profile - Specifies the operating system settings for the role instance.
- role
Name String - The name of the network function role.
- user
Data ObjectParameters - The user data parameters from the customer.
- network
Interfaces NetworkInterface Response[] - The network interface configuration.
- os
Profile NetworkFunction User Configuration Response Os Profile - Specifies the operating system settings for the role instance.
- role
Name string - The name of the network function role.
- user
Data anyParameters - The user data parameters from the customer.
- network_
interfaces Sequence[NetworkInterface Response] - The network interface configuration.
- os_
profile NetworkFunction User Configuration Response Os Profile - Specifies the operating system settings for the role instance.
- role_
name str - The name of the network function role.
- user_
data_ Anyparameters - The user data parameters from the customer.
- network
Interfaces List<Property Map> - The network interface configuration.
- os
Profile Property Map - Specifies the operating system settings for the role instance.
- role
Name String - The name of the network function role.
- user
Data AnyParameters - The user data parameters from the customer.
NetworkFunctionUserConfigurationResponseOsProfile
- Custom
Data 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 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 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 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
- custom
Data 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
- Dns
Servers List<string> - The list of DNS servers IP addresses.
- Gateway string
- The value of the gateway.
- Ip
Address string - The value of the IP address.
- Ip
Allocation stringMethod - IP address allocation method.
- Ip
Version string - IP address version.
- Subnet string
- The value of the subnet.
- Dns
Servers []string - The list of DNS servers IP addresses.
- Gateway string
- The value of the gateway.
- Ip
Address string - The value of the IP address.
- Ip
Allocation stringMethod - IP address allocation method.
- Ip
Version string - IP address version.
- Subnet string
- The value of the subnet.
- dns
Servers List<String> - The list of DNS servers IP addresses.
- gateway String
- The value of the gateway.
- ip
Address String - The value of the IP address.
- ip
Allocation StringMethod - IP address allocation method.
- ip
Version String - IP address version.
- subnet String
- The value of the subnet.
- dns
Servers string[] - The list of DNS servers IP addresses.
- gateway string
- The value of the gateway.
- ip
Address string - The value of the IP address.
- ip
Allocation stringMethod - IP address allocation method.
- ip
Version 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_ strmethod - IP address allocation method.
- ip_
version str - IP address version.
- subnet str
- The value of the subnet.
- dns
Servers List<String> - The list of DNS servers IP addresses.
- gateway String
- The value of the gateway.
- ip
Address String - The value of the IP address.
- ip
Allocation StringMethod - IP address allocation method.
- ip
Version String - IP address version.
- subnet String
- The value of the subnet.
NetworkInterfaceResponse
- Ip
Configurations List<Pulumi.Azure Native. Hybrid Network. Inputs. Network Interface IPConfiguration Response> - A list of IP configurations of the network interface.
- Mac
Address string - The MAC address of the network interface.
- Network
Interface stringName - The name of the network interface.
- Vm
Switch stringType - The type of the VM switch.
- Ip
Configurations []NetworkInterface IPConfiguration Response - A list of IP configurations of the network interface.
- Mac
Address string - The MAC address of the network interface.
- Network
Interface stringName - The name of the network interface.
- Vm
Switch stringType - The type of the VM switch.
- ip
Configurations List<NetworkInterface IPConfiguration Response> - A list of IP configurations of the network interface.
- mac
Address String - The MAC address of the network interface.
- network
Interface StringName - The name of the network interface.
- vm
Switch StringType - The type of the VM switch.
- ip
Configurations NetworkInterface IPConfiguration Response[] - A list of IP configurations of the network interface.
- mac
Address string - The MAC address of the network interface.
- network
Interface stringName - The name of the network interface.
- vm
Switch stringType - The type of the VM switch.
- ip_
configurations Sequence[NetworkInterface IPConfiguration Response] - A list of IP configurations of the network interface.
- mac_
address str - The MAC address of the network interface.
- network_
interface_ strname - The name of the network interface.
- vm_
switch_ strtype - The type of the VM switch.
- ip
Configurations List<Property Map> - A list of IP configurations of the network interface.
- mac
Address String - The MAC address of the network interface.
- network
Interface StringName - The name of the network interface.
- vm
Switch StringType - 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
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified 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.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified 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.71.0 published on Friday, Nov 8, 2024 by Pulumi