@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 9.33 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* A network interface in a resource group.
*
* Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-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 class NetworkInterface extends pulumi.CustomResource {
/**
* Get an existing NetworkInterface resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): NetworkInterface;
/**
* Returns true if the given object is an instance of NetworkInterface. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is NetworkInterface;
/**
* Auxiliary mode of Network Interface resource.
*/
readonly auxiliaryMode: pulumi.Output<string | undefined>;
/**
* Auxiliary sku of Network Interface resource.
*/
readonly auxiliarySku: pulumi.Output<string | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Whether default outbound connectivity for nic was configured or not.
*/
readonly defaultOutboundConnectivityEnabled: pulumi.Output<boolean>;
/**
* Indicates whether to disable tcp state tracking.
*/
readonly disableTcpStateTracking: pulumi.Output<boolean | undefined>;
/**
* The DNS settings in network interface.
*/
readonly dnsSettings: pulumi.Output<outputs.network.NetworkInterfaceDnsSettingsResponse | undefined>;
/**
* A reference to the dscp configuration to which the network interface is linked.
*/
readonly dscpConfiguration: pulumi.Output<outputs.network.SubResourceResponse>;
/**
* If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.
*/
readonly enableAcceleratedNetworking: pulumi.Output<boolean | undefined>;
/**
* Indicates whether IP forwarding is enabled on this network interface.
*/
readonly enableIPForwarding: pulumi.Output<boolean | undefined>;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: pulumi.Output<string>;
/**
* The extended location of the network interface.
*/
readonly extendedLocation: pulumi.Output<outputs.network.ExtendedLocationResponse | undefined>;
/**
* A list of references to linked BareMetal resources.
*/
readonly hostedWorkloads: pulumi.Output<string[]>;
/**
* A list of IPConfigurations of the network interface.
*/
readonly ipConfigurations: pulumi.Output<outputs.network.NetworkInterfaceIPConfigurationResponse[] | undefined>;
/**
* Resource location.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* The MAC address of the network interface.
*/
readonly macAddress: pulumi.Output<string>;
/**
* Migration phase of Network Interface resource.
*/
readonly migrationPhase: pulumi.Output<string | undefined>;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* The reference to the NetworkSecurityGroup resource.
*/
readonly networkSecurityGroup: pulumi.Output<outputs.network.NetworkSecurityGroupResponse | undefined>;
/**
* Type of Network Interface resource.
*/
readonly nicType: pulumi.Output<string | undefined>;
/**
* Whether this is a primary network interface on a virtual machine.
*/
readonly primary: pulumi.Output<boolean>;
/**
* A reference to the private endpoint to which the network interface is linked.
*/
readonly privateEndpoint: pulumi.Output<outputs.network.PrivateEndpointResponse>;
/**
* Privatelinkservice of the network interface resource.
*/
readonly privateLinkService: pulumi.Output<outputs.network.PrivateLinkServiceResponse | undefined>;
/**
* The provisioning state of the network interface resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The resource GUID property of the network interface resource.
*/
readonly resourceGuid: pulumi.Output<string>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A list of TapConfigurations of the network interface.
*/
readonly tapConfigurations: pulumi.Output<outputs.network.NetworkInterfaceTapConfigurationResponse[]>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* The reference to a virtual machine.
*/
readonly virtualMachine: pulumi.Output<outputs.network.SubResourceResponse>;
/**
* Whether the virtual machine this nic is attached to supports encryption.
*/
readonly vnetEncryptionSupported: pulumi.Output<boolean>;
/**
* WorkloadType of the NetworkInterface for BareMetal resources
*/
readonly workloadType: pulumi.Output<string | undefined>;
/**
* Create a NetworkInterface resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: NetworkInterfaceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a NetworkInterface resource.
*/
export interface NetworkInterfaceArgs {
/**
* Auxiliary mode of Network Interface resource.
*/
auxiliaryMode?: pulumi.Input<string | enums.network.NetworkInterfaceAuxiliaryMode>;
/**
* Auxiliary sku of Network Interface resource.
*/
auxiliarySku?: pulumi.Input<string | enums.network.NetworkInterfaceAuxiliarySku>;
/**
* Indicates whether to disable tcp state tracking.
*/
disableTcpStateTracking?: pulumi.Input<boolean>;
/**
* The DNS settings in network interface.
*/
dnsSettings?: pulumi.Input<inputs.network.NetworkInterfaceDnsSettingsArgs>;
/**
* If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.
*/
enableAcceleratedNetworking?: pulumi.Input<boolean>;
/**
* Indicates whether IP forwarding is enabled on this network interface.
*/
enableIPForwarding?: pulumi.Input<boolean>;
/**
* The extended location of the network interface.
*/
extendedLocation?: pulumi.Input<inputs.network.ExtendedLocationArgs>;
/**
* Resource ID.
*/
id?: pulumi.Input<string>;
/**
* A list of IPConfigurations of the network interface.
*/
ipConfigurations?: pulumi.Input<pulumi.Input<inputs.network.NetworkInterfaceIPConfigurationArgs>[]>;
/**
* Resource location.
*/
location?: pulumi.Input<string>;
/**
* Migration phase of Network Interface resource.
*/
migrationPhase?: pulumi.Input<string | enums.network.NetworkInterfaceMigrationPhase>;
/**
* The name of the network interface.
*/
networkInterfaceName?: pulumi.Input<string>;
/**
* The reference to the NetworkSecurityGroup resource.
*/
networkSecurityGroup?: pulumi.Input<inputs.network.NetworkSecurityGroupArgs>;
/**
* Type of Network Interface resource.
*/
nicType?: pulumi.Input<string | enums.network.NetworkInterfaceNicType>;
/**
* Privatelinkservice of the network interface resource.
*/
privateLinkService?: pulumi.Input<inputs.network.PrivateLinkServiceArgs>;
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* WorkloadType of the NetworkInterface for BareMetal resources
*/
workloadType?: pulumi.Input<string>;
}