swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector NetworkInterfaces API
schemes:
- https
tags:
- name: NetworkInterfaces
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}
  : delete:
      tags:
      - NetworkInterfaces
      operationId: microsoftAzureNetworkinterfacesDelete
      description: The delete networkInterface operation deletes the specified networkInterface.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: networkInterfaceName
        in: path
        required: true
        type: string
        description: The name of the network interface.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
        '202':
          description: ''
        '204':
          description: ''
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkinterfaces Networkinterfacename
    get:
      tags:
      - NetworkInterfaces
      operationId: microsoftAzureNetworkinterfacesGet
      description: The Get network interface operation retrieves information about the specified network interface.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: networkInterfaceName
        in: path
        required: true
        type: string
        description: The name of the network interface.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/NetworkInterface'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkinterfaces Networkinterfacename
    put:
      tags:
      - NetworkInterfaces
      operationId: microsoftAzureNetworkinterfacesCreateorupdate
      description: The Put NetworkInterface operation creates/updates a networkInterface
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: networkInterfaceName
        in: path
        required: true
        type: string
        description: The name of the network interface.
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/NetworkInterface'
        description: Parameters supplied to the create/update NetworkInterface operation
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/NetworkInterface'
        '201':
          description: ''
          schema:
            $ref: '#/definitions/NetworkInterface'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkinterfaces Networkinterfacename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces
  : get:
      tags:
      - NetworkInterfaces
      operationId: microsoftAzureNetworkinterfacesListvirtualmachinescalesetvmnetworkinterfaces
      description: The list network interface operation retrieves information about all network interfaces in a virtual machine from a virtual machine scale set.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: virtualMachineScaleSetName
        in: path
        required: true
        type: string
        description: The name of the virtual machine scale set.
      - name: virtualmachineIndex
        in: path
        required: true
        type: string
        description: The virtual machine index.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/NetworkInterfaceListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Virtualmachinescalesets Virtualmachinescalesetname Virtualmachines Virtualmachineindex Networkinterfaces
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/networkInterfaces
  : get:
      tags:
      - NetworkInterfaces
      operationId: microsoftAzureNetworkinterfacesListvirtualmachinescalesetnetworkinterfaces
      description: The list network interface operation retrieves information about all network interfaces in a virtual machine scale set.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: virtualMachineScaleSetName
        in: path
        required: true
        type: string
        description: The name of the virtual machine scale set.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/NetworkInterfaceListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Virtualmachinescalesets Virtualmachinescalesetname Networkinterfaces
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}
  : get:
      tags:
      - NetworkInterfaces
      operationId: microsoftAzureNetworkinterfacesGetvirtualmachinescalesetnetworkinterface
      description: The Get network interface operation retrieves information about the specified network interface in a virtual machine scale set.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: virtualMachineScaleSetName
        in: path
        required: true
        type: string
        description: The name of the virtual machine scale set.
      - name: virtualmachineIndex
        in: path
        required: true
        type: string
        description: The virtual machine index.
      - name: networkInterfaceName
        in: path
        required: true
        type: string
        description: The name of the network interface.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/NetworkInterface'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Virtualmachinescalesets Virtualmachinescalesetname Virtualmachines Virtualmachineindex Networkinterfaces Networkinterfacename
  /subscriptions/{subscriptionId}/providers/Microsoft.Network/networkInterfaces:
    get:
      tags:
      - NetworkInterfaces
      operationId: microsoftAzureNetworkinterfacesListall
      description: The List networkInterfaces operation retrieves all the networkInterfaces in a subscription.
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/NetworkInterfaceListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Networkinterfaces
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces:
    get:
      tags:
      - NetworkInterfaces
      operationId: microsoftAzureNetworkinterfacesList
      description: The List networkInterfaces operation retrieves all the networkInterfaces in a resource group.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/NetworkInterfaceListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkinterfaces
definitions:
  Resource:
    properties:
      id:
        readOnly: true
        type: string
        description: Resource Id
      name:
        readOnly: true
        type: string
        description: Resource name
      type:
        readOnly: true
        type: string
        description: Resource type
      location:
        type: string
        description: Resource location
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags
    required:
    - location
    x-ms-azure-resource: true
  NetworkInterface:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/NetworkInterfacePropertiesFormat'
      etag:
        type: string
        description: Gets a unique read-only string that changes whenever the resource is updated
    allOf:
    - $ref: '#/definitions/Resource'
    description: A NetworkInterface in a resource group
  NetworkInterfaceIpConfiguration:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/NetworkInterfaceIpConfigurationPropertiesFormat'
      name:
        type: string
        description: Gets name of the resource that is unique within a resource group. This name can be used to access the resource
      etag:
        type: string
        description: A unique read-only string that changes whenever the resource is updated
    allOf:
    - $ref: '#/definitions/SubResource'
    description: IPConfiguration in a NetworkInterface
  NetworkInterfaceIpConfigurationPropertiesFormat:
    properties:
      privateIPAddress:
        type: string
        description: Gets or sets the privateIPAddress of the Network Interface IP Configuration
      privateIPAllocationMethod:
        type: string
        description: Gets or sets PrivateIP allocation method (Static/Dynamic)
        enum:
        - Static
        - Dynamic
        x-ms-enum:
          name: IpAllocationMethod
          modelAsString: true
      subnet:
        $ref: '#/definitions/SubResource'
        description: Gets or sets the reference of the subnet resource
      publicIPAddress:
        $ref: '#/definitions/SubResource'
        description: Gets or sets the reference of the PublicIP resource
      loadBalancerBackendAddressPools:
        type: array
        items:
          $ref: '#/definitions/SubResource'
        description: Gets or sets the reference of LoadBalancerBackendAddressPool resource
      loadBalancerInboundNatRules:
        type: array
        items:
          $ref: '#/definitions/SubResource'
        description: Gets or sets list of references of LoadBalancerInboundNatRules
      provisioningState:
        type: string
        description: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
    description: Properties of IPConfiguration
  NetworkInterfacePropertiesFormat:
    properties:
      virtualMachine:
        $ref: '#/definitions/SubResource'
        description: Gets or sets the reference of a VirtualMachine
      networkSecurityGroup:
        $ref: '#/definitions/SubResource'
        description: Gets or sets the reference of the NetworkSecurityGroup resource
      ipConfigurations:
        type: array
        items:
          $ref: '#/definitions/NetworkInterfaceIpConfiguration'
        description: Gets or sets list of IPConfigurations of the NetworkInterface
      dnsSettings:
        $ref: '#/definitions/NetworkInterfaceDnsSettings'
        description: Gets or sets DNS Settings in  NetworkInterface
      macAddress:
        type: string
        description: Gets the MAC Address of the network interface
      primary:
        type: boolean
        description: Gets whether this is a primary NIC on a virtual machine
      enableIPForwarding:
        type: boolean
        description: Gets or sets whether IPForwarding is enabled on the NIC
      resourceGuid:
        type: string
        description: Gets or sets resource guid property of the network interface resource
      provisioningState:
        type: string
        description: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
    description: 'NetworkInterface properties. '
  NetworkInterfaceListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/NetworkInterface'
        description: Gets or sets list of NetworkInterfaces in a resource group
      nextLink:
        type: string
        description: Gets the URL to get the next set of results.
    description: Response for ListNetworkInterface Api service call
  SubResource:
    properties:
      id:
        type: string
        description: Resource Id
    x-ms-azure-resource: true
  NetworkInterfaceDnsSettings:
    properties:
      dnsServers:
        type: array
        items:
          type: string
        description: Gets or sets list of DNS servers IP addresses
      appliedDnsServers:
        type: array
        items:
          type: string
        description: Gets or sets list of Applied DNS servers IP addresses
      internalDnsNameLabel:
        type: string
        description: Gets or sets the Internal DNS name
      internalFqdn:
        type: string
        description: Gets or sets full IDNS name in the form, DnsName.VnetId.ZoneId.TopLevelSuffix. This is set when the NIC is associated to a VM
    description: Dns Settings of a network interface
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'