Microsoft Azure Network Interfaces API

openapi: 3.2.0
info:
  title: Microsoft Azure NetworkResourceProviderClient Network…
  description: The Windows Azure Network management API provides a RESTful set of web services that interact with Windows Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Windows Azure Networks service.
  version: 2015-05-01-preview
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Network Interfaces
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}
  : delete:
      tags:
      - Network Interfaces
      operationId: microsoftAzureNetworkinterfacesDelete
      description: The delete networkInterface operation deletes the specified networkInterface.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: networkInterfaceName
        in: path
        required: true
        description: The name of the network interface.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
        '202':
          description: ''
        '204':
          description: ''
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
    get:
      tags:
      - Network Interfaces
      operationId: microsoftAzureNetworkinterfacesGet
      description: The Get network interface operation retrieves information about the specified network interface.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: networkInterfaceName
        in: path
        required: true
        description: The name of the network interface.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterface'
            text/json:
              schema:
                $ref: '#/components/schemas/NetworkInterface'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      tags:
      - Network Interfaces
      operationId: microsoftAzureNetworkinterfacesCreateorupdate
      description: The Put NetworkInterface operation creates/updates a networkInterface
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: networkInterfaceName
        in: path
        required: true
        description: The name of the network interface.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterface'
            text/json:
              schema:
                $ref: '#/components/schemas/NetworkInterface'
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterface'
            text/json:
              schema:
                $ref: '#/components/schemas/NetworkInterface'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkInterface'
          text/json:
            schema:
              $ref: '#/components/schemas/NetworkInterface'
        description: Parameters supplied to the create/update NetworkInterface operation
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces
  : get:
      tags:
      - Network Interfaces
      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
        description: The name of the resource group.
        schema:
          type: string
      - name: virtualMachineScaleSetName
        in: path
        required: true
        description: The name of the virtual machine scale set.
        schema:
          type: string
      - name: virtualmachineIndex
        in: path
        required: true
        description: The virtual machine index.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceListResult'
            text/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/networkInterfaces
  : get:
      tags:
      - Network Interfaces
      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
        description: The name of the resource group.
        schema:
          type: string
      - name: virtualMachineScaleSetName
        in: path
        required: true
        description: The name of the virtual machine scale set.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceListResult'
            text/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}
  : get:
      tags:
      - Network Interfaces
      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
        description: The name of the resource group.
        schema:
          type: string
      - name: virtualMachineScaleSetName
        in: path
        required: true
        description: The name of the virtual machine scale set.
        schema:
          type: string
      - name: virtualmachineIndex
        in: path
        required: true
        description: The virtual machine index.
        schema:
          type: string
      - name: networkInterfaceName
        in: path
        required: true
        description: The name of the network interface.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterface'
            text/json:
              schema:
                $ref: '#/components/schemas/NetworkInterface'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  /subscriptions/{subscriptionId}/providers/Microsoft.Network/networkInterfaces:
    get:
      tags:
      - Network Interfaces
      operationId: microsoftAzureNetworkinterfacesListall
      description: The List networkInterfaces operation retrieves all the networkInterfaces in a subscription.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceListResult'
            text/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network…
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces:
    get:
      tags:
      - Network Interfaces
      operationId: microsoftAzureNetworkinterfacesList
      description: The List networkInterfaces operation retrieves all the networkInterfaces in a resource group.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceListResult'
            text/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
components:
  schemas:
    SubResource:
      properties:
        id:
          type: string
          description: Resource Id
      x-ms-azure-resource: true
    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: '#/components/schemas/SubResource'
          description: Gets or sets the reference of the subnet resource
        publicIPAddress:
          $ref: '#/components/schemas/SubResource'
          description: Gets or sets the reference of the PublicIP resource
        loadBalancerBackendAddressPools:
          type: array
          items:
            $ref: '#/components/schemas/SubResource'
          description: Gets or sets the reference of LoadBalancerBackendAddressPool resource
        loadBalancerInboundNatRules:
          type: array
          items:
            $ref: '#/components/schemas/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
    NetworkInterface:
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/NetworkInterfacePropertiesFormat'
        etag:
          type: string
          description: Gets a unique read-only string that changes whenever the resource is updated
      allOf:
      - $ref: '#/components/schemas/Resource'
      description: A NetworkInterface in a resource group
    NetworkInterfacePropertiesFormat:
      properties:
        virtualMachine:
          $ref: '#/components/schemas/SubResource'
          description: Gets or sets the reference of a VirtualMachine
        networkSecurityGroup:
          $ref: '#/components/schemas/SubResource'
          description: Gets or sets the reference of the NetworkSecurityGroup resource
        ipConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/NetworkInterfaceIpConfiguration'
          description: Gets or sets list of IPConfigurations of the NetworkInterface
        dnsSettings:
          $ref: '#/components/schemas/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: '#/components/schemas/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
    NetworkInterfaceIpConfiguration:
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/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: '#/components/schemas/SubResource'
      description: IPConfiguration in a NetworkInterface
    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
    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
      description: Client Api Version.
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow