Azure Networking Services Subnets API

openapi: 3.2.0
info:
  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.
  title: NetworkManagementClient LoadBalancers Subnets API
  version: '2.0'
  x-apisguru-categories:
  - cloud
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png
  x-origin:
  - format: swagger
    url: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2019-08-01/loadBalancer.json
  x-preferred: true
  x-providerName: azure.com
  x-serviceName: network-loadBalancer
  x-tags:
  - Azure
  - Microsoft
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Subnets
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets
  : get:
      description: Gets all subnets in a virtual network.
      operationId: Subnets_List
      parameters:
      - description: The name of the resource group.
        in: path
        name: resourceGroupName
        required: true
        example: my-resource-group
        schema:
          type: string
      - description: The name of the virtual network.
        in: path
        name: virtualNetworkName
        required: true
        example: example-value
        schema:
          type: string
      - description: Client API version.
        in: query
        name: api-version
        required: true
        example: '2019-06-01'
        schema:
          type: string
      - description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
        in: path
        name: subscriptionId
        required: true
        example: 00000000-0000-0000-0000-000000000000
        schema:
          type: string
      responses:
        '200':
          description: Request successful. The operation returns a list of Subnet resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubnetListResult'
      tags:
      - Subnets
      x-ms-examples:
        List subnets:
          parameters:
            api-version: '2019-08-01'
            resourceGroupName: subnet-test
            subscriptionId: subid
            virtualNetworkName: vnetname
          responses:
            '200':
              body:
                value:
                - id: /subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1
                  name: subnet1
                  properties:
                    addressPrefix: 10.0.0.0/16
                    provisioningState: Succeeded
                - id: /subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet2
                  name: subnet2
                  properties:
                    addressPrefix: 10.0.0.0/16
                    provisioningState: Succeeded
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Azure Networking Services Subnets_ List
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
  : delete:
      description: Deletes the specified subnet.
      operationId: Subnets_Delete
      parameters:
      - description: The name of the resource group.
        in: path
        name: resourceGroupName
        required: true
        example: my-resource-group
        schema:
          type: string
      - description: The name of the virtual network.
        in: path
        name: virtualNetworkName
        required: true
        example: example-value
        schema:
          type: string
      - description: The name of the subnet.
        in: path
        name: subnetName
        required: true
        example: example-value
        schema:
          type: string
      - description: Client API version.
        in: query
        name: api-version
        required: true
        example: '2019-06-01'
        schema:
          type: string
      - description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
        in: path
        name: subscriptionId
        required: true
        example: 00000000-0000-0000-0000-000000000000
        schema:
          type: string
      responses:
        '200':
          description: Delete successful.
        '202':
          description: Accepted and the operation will complete asynchronously.
        '204':
          description: Request successful. Resource does not exist.
      tags:
      - Subnets
      x-ms-examples:
        Delete subnet:
          parameters:
            api-version: '2019-08-01'
            resourceGroupName: subnet-test
            subnetName: subnet1
            subscriptionId: subid
            virtualNetworkName: vnetname
          responses:
            '200': {}
            '202': {}
            '204': {}
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Azure Networking Services Subnets_ Delete
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      description: Gets the specified subnet by virtual network and resource group.
      operationId: Subnets_Get
      parameters:
      - description: The name of the resource group.
        in: path
        name: resourceGroupName
        required: true
        example: my-resource-group
        schema:
          type: string
      - description: The name of the virtual network.
        in: path
        name: virtualNetworkName
        required: true
        example: example-value
        schema:
          type: string
      - description: The name of the subnet.
        in: path
        name: subnetName
        required: true
        example: example-value
        schema:
          type: string
      - description: Client API version.
        in: query
        name: api-version
        required: true
        example: '2019-06-01'
        schema:
          type: string
      - description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
        in: path
        name: subscriptionId
        required: true
        example: 00000000-0000-0000-0000-000000000000
        schema:
          type: string
      - description: Expands referenced resources.
        in: query
        name: $expand
        required: false
        example: example-value
        schema:
          type: string
      responses:
        '200':
          description: Request successful. The operation returns the resulting Subnet resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subnet'
      tags:
      - Subnets
      x-ms-examples:
        Get subnet:
          parameters:
            api-version: '2019-08-01'
            resourceGroupName: subnet-test
            subnetName: subnet1
            subscriptionId: subid
            virtualNetworkName: vnetname
          responses:
            '200':
              body:
                id: /subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1
                name: subnet1
                properties:
                  addressPrefix: 10.0.0.0/16
                  provisioningState: Succeeded
        Get subnet with a delegation:
          parameters:
            api-version: '2019-08-01'
            resourceGroupName: subnet-test
            subnetName: subnet1
            subscriptionId: subId
            virtualNetworkName: vnetname
          responses:
            '200':
              body:
                id: /subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1
                name: subnet1
                properties:
                  addressPrefix: 10.0.0.0/16
                  delegations:
                  - id: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/myDelegation
                    name: myDelegation
                    properties:
                      actions: []
                      provisioningState: Succeeded
                      serviceName: Microsoft.Provider/resourceType
                  provisioningState: Succeeded
                  purpose: ''
      summary: Azure Networking Services Subnets_ Get
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      description: Creates or updates a subnet in the specified virtual network.
      operationId: Subnets_CreateOrUpdate
      parameters:
      - description: The name of the resource group.
        in: path
        name: resourceGroupName
        required: true
        example: my-resource-group
        schema:
          type: string
      - description: The name of the virtual network.
        in: path
        name: virtualNetworkName
        required: true
        example: example-value
        schema:
          type: string
      - description: The name of the subnet.
        in: path
        name: subnetName
        required: true
        example: example-value
        schema:
          type: string
      - description: Client API version.
        in: query
        name: api-version
        required: true
        example: '2019-06-01'
        schema:
          type: string
      - description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
        in: path
        name: subscriptionId
        required: true
        example: 00000000-0000-0000-0000-000000000000
        schema:
          type: string
      responses:
        '200':
          description: Update successful. The operation returns the resulting Subnet resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subnet'
        '201':
          description: Create successful. The operation returns the resulting Subnet resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subnet'
      tags:
      - Subnets
      x-ms-examples:
        Create subnet:
          parameters:
            api-version: '2019-08-01'
            resourceGroupName: subnet-test
            subnetName: subnet1
            subnetParameters:
              properties:
                addressPrefix: 10.0.0.0/16
            subscriptionId: subid
            virtualNetworkName: vnetname
          responses:
            '200':
              body:
                id: /subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1
                name: subnet1
                properties:
                  addressPrefix: 10.0.0.0/16
                  provisioningState: Succeeded
            '201':
              body:
                id: /subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1
                name: subnet1
                properties:
                  addressPrefix: 10.0.0.0/16
                  provisioningState: Succeeded
        Create subnet with a delegation:
          parameters:
            api-version: '2019-08-01'
            resourceGroupName: subnet-test
            subnetName: subnet1
            subnetParameters:
              properties:
                addressPrefix: 10.0.0.0/16
            subscriptionId: subId
            virtualNetworkName: vnetname
          responses:
            '200':
              body:
                id: /subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1
                name: subnet1
                properties:
                  addressPrefix: 10.0.0.0/16
                  delegations:
                  - id: /subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1/delegations/myDelegation
                    name: myDelegation
                    properties:
                      actions: []
                      provisioningState: Succeeded
                      serviceName: Microsoft.Provider/resourceType
                  provisioningState: Succeeded
                  purpose: ''
            '201':
              body:
                id: /subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1
                name: subnet1
                properties:
                  addressPrefix: 10.0.0.0/16
                  delegations:
                  - id: /subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1/delegations/myDelegation
                    name: myDelegation
                    properties:
                      actions: []
                      provisioningState: Succeeded
                      serviceName: Microsoft.Provider/resourceType
                  provisioningState: Succeeded
                  purpose: ''
        Create subnet with service endpoints:
          parameters:
            api-version: '2019-08-01'
            resourceGroupName: subnet-test
            subnetName: subnet1
            subnetParameters:
              properties:
                addressPrefix: 10.0.0.0/16
                serviceEndpoints:
                - service: Microsoft.Storage
            subscriptionId: subid
            virtualNetworkName: vnetname
          responses:
            '200':
              body:
                id: /subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1
                name: subnet1
                properties:
                  addressPrefix: 10.0.0.0/16
                  provisioningState: Succeeded
                  serviceEndpoints:
                  - locations:
                    - eastus2(stage)
                    - usnorth(stage)
                    provisioningState: Succeeded
                    service: Microsoft.Storage
            '201':
              body:
                id: /subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1
                name: subnet1
                properties:
                  addressPrefix: 10.0.0.0/16
                  provisioningState: Succeeded
                  serviceEndpoints:
                  - locations:
                    - eastus2(stage)
                    - usnorth(stage)
                    provisioningState: Succeeded
                    service: Microsoft.Storage
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      summary: Azure Networking Services Subnets_ Create or Update
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Subnet'
        description: Parameters supplied to the create or update subnet operation.
        required: true
components:
  schemas:
    Subnet:
      allOf:
      - description: Reference to another subresource.
        properties:
          id:
            description: Resource ID.
            type: string
        x-ms-azure-resource: true
      description: Subnet in a virtual network resource.
      properties:
        etag:
          description: A unique read-only string that changes whenever the resource is updated.
          type: string
        name:
          description: The name of the resource that is unique within a resource group. This name can be used to access the resource.
          type: string
        properties:
          $ref: '#/components/schemas/SubnetPropertiesFormat'
          description: Properties of the subnet.
          x-ms-client-flatten: true
    SubnetPropertiesFormat:
      description: Properties of the subnet.
      properties:
        addressPrefix:
          description: The address prefix for the subnet.
          type: string
        addressPrefixes:
          description: List of address prefixes for the subnet.
          items:
            type: string
          type: array
        delegations:
          description: An array of references to the delegations on the subnet.
          items:
            allOf:
            - description: Reference to another subresource.
              properties:
                id:
                  description: Resource ID.
                  type: string
              x-ms-azure-resource: true
            description: Details the service to which the subnet is delegated.
            properties:
              etag:
                description: A unique read-only string that changes whenever the resource is updated.
                type: string
              name:
                description: The name of the resource that is unique within a subnet. This name can be used to access the resource.
                type: string
              properties:
                description: Properties of a service delegation.
                properties:
                  actions:
                    description: Describes the actions permitted to the service upon delegation.
                    items:
                      type: string
                    type: array
                  provisioningState:
                    description: The current provisioning state.
                    enum:
                    - Succeeded
                    - Updating
                    - Deleting
                    - Failed
                    readOnly: true
                    type: string
                    x-ms-enum:
                      modelAsString: true
                      name: ProvisioningState
                  serviceName:
                    description: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).
                    type: string
          type: array
        ipConfigurationProfiles:
          description: Array of IP configuration profiles which reference this subnet.
          items:
            $ref: ./networkProfile.json#/definitions/IPConfigurationProfile
          readOnly: true
          type: array
        ipConfigurations:
          description: An array of references to the network interface IP configurations using subnet.
          items:
            $ref: ./networkInterface.json#/definitions/IPConfiguration
          readOnly: true
          type: array
        natGateway:
          description: Reference to another subresource.
          properties:
            id:
              description: Resource ID.
              type: string
          x-ms-azure-resource: true
        networkSecurityGroup:
          $ref: ./networkSecurityGroup.json#/definitions/NetworkSecurityGroup
          description: The reference of the NetworkSecurityGroup resource.
        privateEndpointNetworkPolicies:
          description: Enable or Disable apply network policies on private end point in the subnet.
          type: string
        privateEndpoints:
          description: An array of references to private endpoints.
          items:
            $ref: ./privateEndpoint.json#/definitions/PrivateEndpoint
          readOnly: true
          type: array
        privateLinkServiceNetworkPolicies:
          description: Enable or Disable apply network policies on private link service in the subnet.
          type: string
        provisioningState:
          description: The current provisioning state.
          enum:
          - Succeeded
          - Updating
          - Deleting
          - Failed
          readOnly: true
          type: string
          x-ms-enum:
            modelAsString: true
            name: ProvisioningState
        purpose:
          description: A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties.
          readOnly: true
          type: string
        resourceNavigationLinks:
          description: An array of references to the external resources using subnet.
          items:
            allOf:
            - description: Reference to another subresource.
              properties:
                id:
                  description: Resource ID.
                  type: string
              x-ms-azure-resource: true
            description: ResourceNavigationLink resource.
            properties:
              etag:
                description: A unique read-only string that changes whenever the resource is updated.
                readOnly: true
                type: string
              id:
                description: Resource navigation link identifier.
                readOnly: true
                type: string
              name:
                description: Name of the resource that is unique within a resource group. This name can be used to access the resource.
                type: string
              properties:
                description: Properties of ResourceNavigationLink.
                properties:
                  link:
                    description: Link to the external resource.
                    type: string
                  linkedResourceType:
                    description: Resource type of the linked resource.
                    type: string
                  provisioningState:
                    description: The current provisioning state.
                    enum:
                    - Succeeded
                    - Updating
                    - Deleting
                    - Failed
                    readOnly: true
                    type: string
                    x-ms-enum:
                      modelAsString: true
                      name: ProvisioningState
              type:
                description: Resource type.
                readOnly: true
                type: string
          type: array
        routeTable:
          $ref: ./routeTable.json#/definitions/RouteTable
          description: The reference of the RouteTable resource.
        serviceAssociationLinks:
          description: An array of references to services injecting into this subnet.
          items:
            allOf:
            - description: Reference to another subresource.
              properties:
                id:
                  description: Resource ID.
                  type: string
              x-ms-azure-resource: true
            description: ServiceAssociationLink resource.
            properties:
              etag:
                description: A unique read-only string that changes whenever the resource is updated.
                readOnly: true
                type: string
              name:
                description: Name of the resource that is unique within a resource group. This name can be used to access the resource.
                type: string
              properties:
                description: Properties of ServiceAssociationLink.
                properties:
                  allowDelete:
                    description: If true, the resource can be deleted.
                    type: boolean
                  link:
                    description: Link to the external resource.
                    type: string
                  linkedResourceType:
                    description: Resource type of the linked resource.
                    type: string
                  locations:
                    description: A list of locations.
                    items:
                      type: string
                    type: array
                  provisioningState:
                    description: The current provisioning state.
                    enum:
                    - Succeeded
                    - Updating
                    - Deleting
                    - Failed
                    readOnly: true
                    type: string
                    x-ms-enum:
                      modelAsString: true
                      name: ProvisioningState
              type:
                description: Resource type.
                type: string
          type: array
        serviceEndpointPolicies:
          description: An array of service endpoint policies.
          items:
            $ref: ./serviceEndpointPolicy.json#/definitions/ServiceEndpointPolicy
          type: array
        serviceEndpoints:
          description: An array of service endpoints.
          items:
            description: The service endpoint properties.
            properties:
              locations:
                description: A list of locations.
                items:
                  type: string
                type: array
              provisioningState:
                description: The current provisioning state.
                enum:
                - Succeeded
                - Updating
                - Deleting
                - Failed
                readOnly: true
                type: string
                x-ms-enum:
                  modelAsString: true
                  name: ProvisioningState
              service:
                description: The type of the endpoint service.
                type: string
          type: array
    SubnetListResult:
      description: Response for ListSubnets API service callRetrieves all subnet that belongs to a virtual network.
      properties:
        nextLink:
          description: The URL to get the next set of results.
          type: string
        value:
          description: The subnets in a virtual network.
          items:
            $ref: '#/components/schemas/Subnet'
          type: array
  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.