@datafire/azure_network_networkinterface
Client library for NetworkManagementClient
Installation and Usage
npm install --save @datafire/azure_network_networkinterface
let azure_network_networkinterface = require('@datafire/azure_network_networkinterface').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.
Actions
NetworkInterfaces_ListAll
Gets all network interfaces in a subscription.
azure_network_networkinterface.NetworkInterfaces_ListAll({
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - subscriptionId required
string
: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- api-version required
Output
- output NetworkInterfaceListResult
NetworkInterfaces_List
Gets all network interfaces in a resource group.
azure_network_networkinterface.NetworkInterfaces_List({
"resourceGroupName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - api-version required
string
: Client API version. - subscriptionId required
string
: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output NetworkInterfaceListResult
NetworkInterfaces_Delete
Deletes the specified network interface.
azure_network_networkinterface.NetworkInterfaces_Delete({
"resourceGroupName": "",
"networkInterfaceName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - networkInterfaceName required
string
: The name of the network interface. - api-version required
string
: Client API version. - subscriptionId required
string
: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
NetworkInterfaces_Get
Gets information about the specified network interface.
azure_network_networkinterface.NetworkInterfaces_Get({
"resourceGroupName": "",
"networkInterfaceName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - networkInterfaceName required
string
: The name of the network interface. - api-version required
string
: Client API version. - subscriptionId required
string
: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - $expand
string
: Expands referenced resources.
- resourceGroupName required
Output
- output NetworkInterface
NetworkInterfaces_UpdateTags
Updates a network interface tags.
azure_network_networkinterface.NetworkInterfaces_UpdateTags({
"resourceGroupName": "",
"networkInterfaceName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - networkInterfaceName required
string
: The name of the network interface. - parameters required
object
: Tags object for patch operations.- tags
object
: Resource tags.
- tags
- api-version required
string
: Client API version. - subscriptionId required
string
: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output NetworkInterface
NetworkInterfaces_CreateOrUpdate
Creates or updates a network interface.
azure_network_networkinterface.NetworkInterfaces_CreateOrUpdate({
"resourceGroupName": "",
"networkInterfaceName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - networkInterfaceName required
string
: The name of the network interface. - parameters required NetworkInterface
- api-version required
string
: Client API version. - subscriptionId required
string
: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output NetworkInterface
NetworkInterfaces_ListEffectiveNetworkSecurityGroups
Gets all network security groups applied to a network interface.
azure_network_networkinterface.NetworkInterfaces_ListEffectiveNetworkSecurityGroups({
"resourceGroupName": "",
"networkInterfaceName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - networkInterfaceName required
string
: The name of the network interface. - api-version required
string
: Client API version. - subscriptionId required
string
: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
NetworkInterfaces_GetEffectiveRouteTable
Gets all route tables applied to a network interface.
azure_network_networkinterface.NetworkInterfaces_GetEffectiveRouteTable({
"resourceGroupName": "",
"networkInterfaceName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - networkInterfaceName required
string
: The name of the network interface. - api-version required
string
: Client API version. - subscriptionId required
string
: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output EffectiveRouteListResult
NetworkInterfaceIPConfigurations_List
Get all ip configurations in a network interface
azure_network_networkinterface.NetworkInterfaceIPConfigurations_List({
"resourceGroupName": "",
"networkInterfaceName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - networkInterfaceName required
string
: The name of the network interface. - api-version required
string
: Client API version. - subscriptionId required
string
: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
NetworkInterfaceIPConfigurations_Get
Gets the specified network interface ip configuration.
azure_network_networkinterface.NetworkInterfaceIPConfigurations_Get({
"resourceGroupName": "",
"networkInterfaceName": "",
"ipConfigurationName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - networkInterfaceName required
string
: The name of the network interface. - ipConfigurationName required
string
: The name of the ip configuration name. - api-version required
string
: Client API version. - subscriptionId required
string
: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
NetworkInterfaceLoadBalancers_List
List all load balancers in a network interface.
azure_network_networkinterface.NetworkInterfaceLoadBalancers_List({
"resourceGroupName": "",
"networkInterfaceName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - networkInterfaceName required
string
: The name of the network interface. - api-version required
string
: Client API version. - subscriptionId required
string
: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Definitions
BackendAddressPoolPropertiesFormat
EffectiveNetworkSecurityGroup
- EffectiveNetworkSecurityGroup
object
: Effective network security group.- association EffectiveNetworkSecurityGroupAssociation
- effectiveSecurityRules
array
: A collection of effective security rules. - networkSecurityGroup
object
: Reference to another subresource.- id
string
: Resource ID.
- id
- tagMap
string
: Mapping of tags to list of IP Addresses included within the tag.
EffectiveNetworkSecurityGroupAssociation
- EffectiveNetworkSecurityGroupAssociation
object
: The effective network security group association.- networkInterface
object
: Reference to another subresource.- id
string
: Resource ID.
- id
- subnet
object
: Reference to another subresource.- id
string
: Resource ID.
- id
- networkInterface
EffectiveNetworkSecurityGroupListResult
- EffectiveNetworkSecurityGroupListResult
object
: Response for list effective network security groups API service call.- nextLink
string
: The URL to get the next set of results. - value
array
: A list of effective network security groups.
- nextLink
EffectiveNetworkSecurityRule
- EffectiveNetworkSecurityRule
object
: Effective network security rules.- access
string
(values: Allow, Deny): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - destinationAddressPrefix
string
: The destination address prefix. - destinationAddressPrefixes
array
: The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*).- items
string
- items
- destinationPortRange
string
: The destination port or range. - destinationPortRanges
array
: The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as seperator (e.g. 100-400), or an asterix (*)- items
string
- items
- direction
string
(values: Inbound, Outbound): The direction of the rule. Possible values are: 'Inbound and Outbound'. - expandedDestinationAddressPrefix
array
: Expanded destination address prefix.- items
string
- items
- expandedSourceAddressPrefix
array
: The expanded source address prefix.- items
string
- items
- name
string
: The name of the security rule specified by the user (if created by the user). - priority
integer
: The priority of the rule. - protocol
string
(values: Tcp, Udp, All): The network protocol this rule applies to. Possible values are: 'Tcp', 'Udp', and 'All'. - sourceAddressPrefix
string
: The source address prefix. - sourceAddressPrefixes
array
: The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*).- items
string
- items
- sourcePortRange
string
: The source port or range. - sourcePortRanges
array
: The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as seperator (e.g. 100-400), or an asterix (*)- items
string
- items
- access
EffectiveRoute
- EffectiveRoute
object
: Effective Route- addressPrefix
array
: The address prefixes of the effective routes in CIDR notation.- items
string
- items
- name
string
: The name of the user defined route. This is optional. - nextHopIpAddress
array
: The IP address of the next hop of the effective route.- items
string
- items
- nextHopType
string
(values: VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - source
string
(values: Unknown, User, VirtualNetworkGateway, Default): Who created the route. Possible values are: 'Unknown', 'User', 'VirtualNetworkGateway', and 'Default'. - state
string
(values: Active, Invalid): The value of effective route. Possible values are: 'Active' and 'Invalid'.
- addressPrefix
EffectiveRouteListResult
- EffectiveRouteListResult
object
: Response for list effective route API service call.- nextLink
string
: The URL to get the next set of results. - value
array
: A list of effective routes.- items EffectiveRoute
- nextLink
IPConfiguration
- IPConfiguration
object
: IP configuration- etag
string
: A unique read-only string that changes whenever the resource is updated. - name
string
: The name of the resource that is unique within a resource group. This name can be used to access the resource. - properties IPConfigurationPropertiesFormat
- id
string
: Resource ID.
- etag
IPConfigurationPropertiesFormat
- IPConfigurationPropertiesFormat
object
: Properties of IP configuration.- privateIPAddress
string
: The private IP address of the IP configuration. - privateIPAllocationMethod
string
(values: Static, Dynamic): The private IP allocation method. Possible values are 'Static' and 'Dynamic'. - provisioningState
string
: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - publicIPAddress
object
: Public IP address resource.- etag
string
: A unique read-only string that changes whenever the resource is updated. - properties PublicIPAddressPropertiesFormat
- sku
object
: SKU of a public IP address- name
string
(values: Basic, Standard): Name of a public IP address SKU.
- name
- zones
array
: A list of availability zones denoting the IP allocated for the resource needs to come from.- items
string
- items
- id
string
: Resource ID. - location
string
: Resource location. - name
string
: Resource name. - tags
object
: Resource tags. - type
string
: Resource type.
- etag
- subnet
object
: Subnet in a virtual network resource.- etag
string
: A unique read-only string that changes whenever the resource is updated. - name
string
: The name of the resource that is unique within a resource group. This name can be used to access the resource. - properties SubnetPropertiesFormat
- id
string
: Resource ID.
- etag
- privateIPAddress
InboundNatRulePropertiesFormat
NetworkInterface
- NetworkInterface
object
: A network interface in a resource group.- etag
string
: A unique read-only string that changes whenever the resource is updated. - properties NetworkInterfacePropertiesFormat
- id
string
: Resource ID. - location
string
: Resource location. - name
string
: Resource name. - tags
object
: Resource tags. - type
string
: Resource type.
- etag
NetworkInterfaceDnsSettings
- NetworkInterfaceDnsSettings
object
: DNS settings of a network interface.- appliedDnsServers
array
: If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.- items
string
- items
- dnsServers
array
: List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.- items
string
- items
- internalDnsNameLabel
string
: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. - internalDomainNameSuffix
string
: Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix. - internalFqdn
string
: Fully qualified DNS name supporting internal communications between VMs in the same virtual network.
- appliedDnsServers
NetworkInterfaceIPConfiguration
- NetworkInterfaceIPConfiguration
object
: IPConfiguration in a network interface.- etag
string
: A unique read-only string that changes whenever the resource is updated. - name
string
: The name of the resource that is unique within a resource group. This name can be used to access the resource. - properties NetworkInterfaceIPConfigurationPropertiesFormat
- id
string
: Resource ID.
- etag
NetworkInterfaceIPConfigurationListResult
- NetworkInterfaceIPConfigurationListResult
object
: Response for list ip configurations API service call.- nextLink
string
: The URL to get the next set of results. - value
array
: A list of ip configurations.
- nextLink
NetworkInterfaceIPConfigurationPropertiesFormat
- NetworkInterfaceIPConfigurationPropertiesFormat
object
: Properties of IP configuration.- applicationGatewayBackendAddressPools
array
: The reference of ApplicationGatewayBackendAddressPool resource. - applicationSecurityGroups
array
: Application security groups in which the IP configuration is included.- items
object
: An application security group in a resource group.- etag
string
: A unique read-only string that changes whenever the resource is updated. - properties
object
: Application security group properties.- provisioningState
string
: The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. - resourceGuid
string
: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups.
- provisioningState
- id
string
: Resource ID. - location
string
: Resource location. - name
string
: Resource name. - tags
object
: Resource tags. - type
string
: Resource type.
- etag
- items
- loadBalancerBackendAddressPools
array
: The reference of LoadBalancerBackendAddressPool resource.- items
object
: Pool of backend IP addresses.- etag
string
: A unique read-only string that changes whenever the resource is updated. - name
string
: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. - properties BackendAddressPoolPropertiesFormat
- id
string
: Resource ID.
- etag
- items
- loadBalancerInboundNatRules
array
: A list of references of LoadBalancerInboundNatRules.- items
object
: Inbound NAT rule of the load balancer.- etag
string
: A unique read-only string that changes whenever the resource is updated. - name
string
: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. - properties InboundNatRulePropertiesFormat
- id
string
: Resource ID.
- etag
- items
- primary
boolean
: Gets whether this is a primary customer address on the network interface. - privateIPAddress
string
: Private IP address of the IP configuration. - privateIPAddressVersion
string
(values: IPv4, IPv6): Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. - privateIPAllocationMethod
string
(values: Static, Dynamic): Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'. - provisioningState
string
: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. - publicIPAddress
object
: Public IP address resource.- etag
string
: A unique read-only string that changes whenever the resource is updated. - properties PublicIPAddressPropertiesFormat
- sku
object
: SKU of a public IP address- name
string
(values: Basic, Standard): Name of a public IP address SKU.
- name
- zones
array
: A list of availability zones denoting the IP allocated for the resource needs to come from.- items
string
- items
- id
string
: Resource ID. - location
string
: Resource location. - name
string
: Resource name. - tags
object
: Resource tags. - type
string
: Resource type.
- etag
- subnet
object
: Subnet in a virtual network resource.- etag
string
: A unique read-only string that changes whenever the resource is updated. - name
string
: The name of the resource that is unique within a resource group. This name can be used to access the resource. - properties SubnetPropertiesFormat
- id
string
: Resource ID.
- etag
- applicationGatewayBackendAddressPools
NetworkInterfaceListResult
- NetworkInterfaceListResult
object
: Response for the ListNetworkInterface API service call.- nextLink
string
: The URL to get the next set of results. - value
array
: A list of network interfaces in a resource group.- items NetworkInterface
- nextLink
NetworkInterfaceLoadBalancerListResult
- NetworkInterfaceLoadBalancerListResult
object
: Response for list ip configurations API service call.- nextLink
string
: The URL to get the next set of results. - value
array
: A list of load balancers.- items
object
: LoadBalancer resource- etag
string
: A unique read-only string that changes whenever the resource is updated. - properties
object
: Properties of the load balancer.- backendAddressPools
array
: Collection of backend address pools used by a load balancer- items
object
: Pool of backend IP addresses.
- items
- frontendIPConfigurations
array
: Object representing the frontend IPs to be used for the load balancer- items
object
: Frontend IP address of the load balancer.
- items
- inboundNatPools
array
: Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.- items
object
: Inbound NAT pool of the load balancer.
- items
- inboundNatRules
array
: Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.- items
object
: Inbound NAT rule of the load balancer.
- items
- loadBalancingRules
array
: Object collection representing the load balancing rules Gets the provisioning- items
object
: A load balancing rule for a load balancer.
- items
- outboundNatRules
array
: The outbound NAT rules.- items
object
: Outbound NAT pool of the load balancer.
- items
- probes
array
: Collection of probe objects used in the load balancer- items
object
: A load balancer probe.
- items
- provisioningState
string
: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - resourceGuid
string
: The resource GUID property of the load balancer resource.
- backendAddressPools
- sku
object
: SKU of a load balancer- name
string
(values: Basic, Standard): Name of a load balancer SKU.
- name
- id
string
: Resource ID. - location
string
: Resource location. - name
string
: Resource name. - tags
object
: Resource tags. - type
string
: Resource type.
- etag
- items
- nextLink
NetworkInterfacePropertiesFormat
- NetworkInterfacePropertiesFormat
object
: NetworkInterface properties.- dnsSettings
object
: DNS settings of a network interface.- appliedDnsServers
array
: If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.- items
string
- items
- dnsServers
array
: List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.- items
string
- items
- internalDnsNameLabel
string
: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. - internalDomainNameSuffix
string
: Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix. - internalFqdn
string
: Fully qualified DNS name supporting internal communications between VMs in the same virtual network.
- appliedDnsServers
- enableAcceleratedNetworking
boolean
: If the network interface is accelerated networking enabled. - enableIPForwarding
boolean
: Indicates whether IP forwarding is enabled on this network interface. - ipConfigurations
array
: A list of IPConfigurations of the network interface. - macAddress
string
: The MAC address of the network interface. - networkSecurityGroup
object
: NetworkSecurityGroup resource.- etag
string
: A unique read-only string that changes whenever the resource is updated. - properties NetworkSecurityGroupPropertiesFormat
- id
string
: Resource ID. - location
string
: Resource location. - name
string
: Resource name. - tags
object
: Resource tags. - type
string
: Resource type.
- etag
- primary
boolean
: Gets whether this is a primary network interface on a virtual machine. - provisioningState
string
: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - resourceGuid
string
: The resource GUID property of the network interface resource. - virtualMachine
object
: Reference to another subresource.- id
string
: Resource ID.
- id
- dnsSettings