Microsoft Azure Networks API

openapi: 3.2.0
info:
  title: Microsoft Azure SeaBreezeManagementClient Networks API
  description: APIs to deploy and manage resources to SeaBreeze.
  version: 2018-07-01-preview
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Networks
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks/{networkName}
  : put:
      operationId: microsoftAzureNetworkCreate
      x-ms-examples:
        Network_Create:
          $ref: ./examples/NetworkCreateOrUpdate.json
      summary: Microsoft Azure Creates Or Updates A Network Resource
      description: 'Creates a network resource with the specified name and description. If a network with the same name already exists, then its description is updated to the one indicated in this request.


        Use network resources to create private network and configure public connectivity for services within your application.'
      parameters:
      - $ref: '#/components/parameters/subscriptionIdRequiredPathParam'
      - $ref: '#/components/parameters/api-versionRequiredQueryParam'
      - $ref: '#/components/parameters/ResourceGroupNameRequiredPathParam'
      - $ref: '#/components/parameters/NetworkNameRequiredPathParam'
      - $ref: '#/components/parameters/NetworkResourceDescriptionRequiredBodyParam'
      tags:
      - Networks
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkResourceDescription'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkResourceDescription'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
    get:
      operationId: microsoftAzureNetworkGet
      x-ms-examples:
        NetworkGet:
          $ref: ./examples/NetworkGet.json
      summary: Microsoft Azure Gets The Network Resource
      description: Gets the information about the network resource with a given name. This information includes the network description and other runtime information.
      parameters:
      - $ref: '#/components/parameters/subscriptionIdRequiredPathParam'
      - $ref: '#/components/parameters/api-versionRequiredQueryParam'
      - $ref: '#/components/parameters/ResourceGroupNameRequiredPathParam'
      - $ref: '#/components/parameters/NetworkNameRequiredPathParam'
      tags:
      - Networks
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkResourceDescription'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
    delete:
      operationId: microsoftAzureNetworkDelete
      x-ms-examples:
        NetworkDelete:
          $ref: ./examples/NetworkDelete.json
      summary: Microsoft Azure Deletes The Network Resource
      description: Deletes the network resource identified by the name.
      parameters:
      - $ref: '#/components/parameters/subscriptionIdRequiredPathParam'
      - $ref: '#/components/parameters/api-versionRequiredQueryParam'
      - $ref: '#/components/parameters/ResourceGroupNameRequiredPathParam'
      - $ref: '#/components/parameters/NetworkNameRequiredPathParam'
      tags:
      - Networks
      responses:
        '200':
          description: OK
        '204':
          description: No Content - the specified network was not found.
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks:
    get:
      operationId: microsoftAzureNetworkListbyresourcegroup
      x-ms-examples:
        NetworksList:
          $ref: ./examples/NetworksByResourceGroup.json
      summary: Microsoft Azure Gets All The Network Resources In A Given Resource Group
      description: Gets the information about all network resources in a given resource group. The information includes the network description and other runtime properties.
      parameters:
      - $ref: '#/components/parameters/subscriptionIdRequiredPathParam'
      - $ref: '#/components/parameters/api-versionRequiredQueryParam'
      - $ref: '#/components/parameters/ResourceGroupNameRequiredPathParam'
      tags:
      - Networks
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkResourceDescriptionList'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/networks:
    get:
      operationId: microsoftAzureNetworkListbysubscription
      x-ms-examples:
        NetworksList:
          $ref: ./examples/NetworksBySubscriptionId.json
      summary: Microsoft Azure Gets All The Network Resources In A Given Subscription
      description: Gets the information about all network resources in a given subscription. The information includes the network description and other runtime properties.
      parameters:
      - $ref: '#/components/parameters/subscriptionIdRequiredPathParam'
      - $ref: '#/components/parameters/api-versionRequiredQueryParam'
      tags:
      - Networks
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkResourceDescriptionList'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
      x-ms-pageable:
        nextLinkName: nextLink
components:
  schemas:
    NetworkResourceProperties:
      description: Describes properties of a network resource.
      allOf:
      - $ref: '#/components/schemas/ProvisionedResourceProperties'
      - $ref: '#/components/schemas/NetworkProperties'
    TrackedResource:
      description: The resource model definition for Azure Resource Manager tracked top-level resource.
      allOf:
      - $ref: '#/components/schemas/Resource'
      properties:
        tags:
          type: object
          additionalProperties:
            type: string
          x-ms-mutability:
          - read
          - create
          - update
          description: Resource tags.
        location:
          type: string
          x-ms-mutability:
          - read
          - create
          description: The geo-location where the resource lives
      required:
      - location
    ErrorDetailsModel:
      description: Error model details information
      properties:
        code:
          type: string
        message:
          type: string
          description: Error message.
      required:
      - code
      - message
    ErrorModel:
      properties:
        error:
          $ref: '#/components/schemas/ErrorErrorModel'
          description: Error model information
      description: The error details.
      required:
      - error
    ProvisionedResourceProperties:
      description: Describes common properties of a provisioned resource.
      properties:
        provisioningState:
          type: string
          description: State of the resource.
          readOnly: true
    ErrorErrorModel:
      description: Error model information
      properties:
        code:
          type: string
        message:
          type: string
          description: Error message.
        innerError:
          type: string
        details:
          type: array
          description: List of error message details.
          items:
            $ref: '#/components/schemas/ErrorDetailsModel'
      required:
      - code
    NetworkProperties:
      description: Describes a network.
      type: object
      properties:
        description:
          description: User readable description of the network.
          type: string
        addressPrefix:
          description: the address prefix for this network.
          type: string
        ingressConfig:
          $ref: '#/components/schemas/IngressConfig'
          description: Configuration for public connectivity for this network.
      required:
      - addressPrefix
    IngressConfig:
      description: Describes public connectivity configuration for the network.
      type: object
      properties:
        qosLevel:
          type: string
          description: The QoS tier for ingress.
          enum:
          - Bronze
          x-ms-enum:
            name: IngressQoSLevel
            modelAsString: true
        layer4:
          description: Configuration for layer4 public connectivity for this network.
          type: array
          items:
            $ref: '#/components/schemas/Layer4IngressConfig'
        publicIPAddress:
          type: string
          readOnly: true
          description: The public IP address for reaching this network.
    Layer4IngressConfig:
      description: Describes the layer4 configuration for public connectivity for this network.
      type: object
      properties:
        name:
          type: string
          description: Layer4 ingress config name.
        publicPort:
          type: integer
          description: Specifies the public port at which the service endpoint below needs to be exposed.
        applicationName:
          type: string
          description: The application name which contains the service to be exposed.
        serviceName:
          type: string
          description: The service whose endpoint needs to be exposed at the public port.
        endpointName:
          type: string
          description: The service endpoint that needs to be exposed.
    Resource:
      description: The resource model definition for Azure Resource Manager resource.
      properties:
        id:
          readOnly: true
          type: string
          description: Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
          x-ms-mutability:
          - read
        name:
          readOnly: true
          type: string
          description: The name of the resource
          x-ms-mutability:
          - read
        type:
          readOnly: true
          type: string
          description: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
          x-ms-mutability:
          - read
        location:
          type: string
          x-ms-mutability:
          - read
          - create
          description: The geo-location where the resource lives
      x-ms-azure-resource: true
    NetworkResourceDescription:
      description: This type describes a network resource.
      allOf:
      - $ref: '#/components/schemas/TrackedResource'
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/NetworkResourceProperties'
          description: Describes properties of a network resource.
      required:
      - properties
    NetworkResourceDescriptionList:
      description: A pageable list of network resources.
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/NetworkResourceDescription'
          description: One page of the list.
        nextLink:
          type: string
          description: URI to fetch the next page of the list.
  parameters:
    ResourceGroupNameRequiredPathParam:
      name: resourceGroupName
      in: path
      description: Azure resource group name
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    NetworkNameRequiredPathParam:
      name: networkName
      in: path
      x-ms-parameter-location: method
      x-ms-skip-url-encoding: true
      required: true
      description: The identity of the network.
      schema:
        type: string
    subscriptionIdRequiredPathParam:
      name: subscriptionId
      in: path
      description: The customer subscription identifier
      required: true
      schema:
        type: string
    NetworkResourceDescriptionRequiredBodyParam:
      name: networkResourceDescription
      in: body
      description: Description for creating a network resource.
      required: true
      x-ms-parameter-location: method
      schema:
        $ref: '#/components/schemas/NetworkResourceDescription'
    api-versionRequiredQueryParam:
      name: api-version
      in: query
      description: The version of the API. This parameter is required and its value must be `2018-07-01-preview`.
      required: true
      x-ms-enum:
        name: 2018-07-01-preview
        modelAsString: true
        values:
        - value: 2018-07-01-preview
          description: The `2018-07-01-preview` version of the API.
      schema:
        type: string
        enum:
        - 2018-07-01-preview
        default: 2018-07-01-preview
  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