@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.7 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets information about the specified network interface.
*
* Uses Azure REST API version 2024-05-01.
*
* Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native network [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getNetworkInterface(args: GetNetworkInterfaceArgs, opts?: pulumi.InvokeOptions): Promise<GetNetworkInterfaceResult>;
export interface GetNetworkInterfaceArgs {
/**
* Expands referenced resources.
*/
expand?: string;
/**
* The name of the network interface.
*/
networkInterfaceName: string;
/**
* The name of the resource group.
*/
resourceGroupName: string;
}
/**
* A network interface in a resource group.
*/
export interface GetNetworkInterfaceResult {
/**
* Auxiliary mode of Network Interface resource.
*/
readonly auxiliaryMode?: string;
/**
* Auxiliary sku of Network Interface resource.
*/
readonly auxiliarySku?: string;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Whether default outbound connectivity for nic was configured or not.
*/
readonly defaultOutboundConnectivityEnabled: boolean;
/**
* Indicates whether to disable tcp state tracking.
*/
readonly disableTcpStateTracking?: boolean;
/**
* The DNS settings in network interface.
*/
readonly dnsSettings?: outputs.network.NetworkInterfaceDnsSettingsResponse;
/**
* A reference to the dscp configuration to which the network interface is linked.
*/
readonly dscpConfiguration: outputs.network.SubResourceResponse;
/**
* If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.
*/
readonly enableAcceleratedNetworking?: boolean;
/**
* Indicates whether IP forwarding is enabled on this network interface.
*/
readonly enableIPForwarding?: boolean;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: string;
/**
* The extended location of the network interface.
*/
readonly extendedLocation?: outputs.network.ExtendedLocationResponse;
/**
* A list of references to linked BareMetal resources.
*/
readonly hostedWorkloads: string[];
/**
* Resource ID.
*/
readonly id?: string;
/**
* A list of IPConfigurations of the network interface.
*/
readonly ipConfigurations?: outputs.network.NetworkInterfaceIPConfigurationResponse[];
/**
* Resource location.
*/
readonly location?: string;
/**
* The MAC address of the network interface.
*/
readonly macAddress: string;
/**
* Migration phase of Network Interface resource.
*/
readonly migrationPhase?: string;
/**
* Resource name.
*/
readonly name: string;
/**
* The reference to the NetworkSecurityGroup resource.
*/
readonly networkSecurityGroup?: outputs.network.NetworkSecurityGroupResponse;
/**
* Type of Network Interface resource.
*/
readonly nicType?: string;
/**
* Whether this is a primary network interface on a virtual machine.
*/
readonly primary: boolean;
/**
* A reference to the private endpoint to which the network interface is linked.
*/
readonly privateEndpoint: outputs.network.PrivateEndpointResponse;
/**
* Privatelinkservice of the network interface resource.
*/
readonly privateLinkService?: outputs.network.PrivateLinkServiceResponse;
/**
* The provisioning state of the network interface resource.
*/
readonly provisioningState: string;
/**
* The resource GUID property of the network interface resource.
*/
readonly resourceGuid: string;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* A list of TapConfigurations of the network interface.
*/
readonly tapConfigurations: outputs.network.NetworkInterfaceTapConfigurationResponse[];
/**
* Resource type.
*/
readonly type: string;
/**
* The reference to a virtual machine.
*/
readonly virtualMachine: outputs.network.SubResourceResponse;
/**
* Whether the virtual machine this nic is attached to supports encryption.
*/
readonly vnetEncryptionSupported: boolean;
/**
* WorkloadType of the NetworkInterface for BareMetal resources
*/
readonly workloadType?: string;
}
/**
* Gets information about the specified network interface.
*
* Uses Azure REST API version 2024-05-01.
*
* Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native network [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getNetworkInterfaceOutput(args: GetNetworkInterfaceOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetNetworkInterfaceResult>;
export interface GetNetworkInterfaceOutputArgs {
/**
* Expands referenced resources.
*/
expand?: pulumi.Input<string>;
/**
* The name of the network interface.
*/
networkInterfaceName: pulumi.Input<string>;
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
}