Microsoft Azure NetworkManagers API

openapi: 3.2.0
info:
  title: Microsoft Azure NetworkManager Network Managers API
  description: The Microsoft Azure Virtual Network Manager API provides a RESTful set of web services that interact with Microsoft Azure Network Manager service to manage your network resources.
  version: 2022-02-01-preview
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: NetworkManagers
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}
  : parameters:
    - $ref: ./network.json#/parameters/SubscriptionIdParameter
    - $ref: '#/components/parameters/ResourceGroupNameParameter'
    - $ref: '#/components/parameters/NetworkManagerNameParameter'
    - $ref: ./network.json#/parameters/ApiVersionParameter
    get:
      tags:
      - NetworkManagers
      operationId: microsoftAzureNetworkmanagersGet
      description: Gets the specified Network Manager.
      responses:
        '200':
          description: OK - Returns information about the network manager.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkManager'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        NetworkManagersGet:
          $ref: ./examples/NetworkManagerGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      tags:
      - NetworkManagers
      operationId: microsoftAzureNetworkmanagersCreateorupdate
      description: Creates or updates a Network Manager.
      responses:
        '200':
          description: Updated - Returns information about the network manager.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkManager'
        '201':
          description: Created - Returns information about the network manager.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkManager'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        Put Network Manager:
          $ref: ./examples/NetworkManagerPut.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkManager'
        description: Parameters supplied to specify which network manager is.
        required: true
    delete:
      tags:
      - NetworkManagers
      operationId: microsoftAzureNetworkmanagersDelete
      parameters:
      - $ref: '#/components/parameters/ForceDeleteParameter'
      description: Deletes a network manager.
      responses:
        '200':
          description: Delete Succeed.
        '204':
          description: Request successful. The resource does not exist.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        NetworkManagersDelete:
          $ref: ./examples/NetworkManagerDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
    patch:
      tags:
      - NetworkManagers
      operationId: microsoftAzureNetworkmanagersPatch
      description: Patch NetworkManager.
      responses:
        '200':
          description: Updated - Returns information about the network manager.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkManager'
        default:
          description: Resource Provider error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        NetworkManagesPatch:
          $ref: ./examples/NetworkManagerPatch.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchObject'
        description: Parameters supplied to specify which network manager is.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/commit
  : parameters:
    - $ref: ./network.json#/parameters/SubscriptionIdParameter
    - $ref: '#/components/parameters/ResourceGroupNameParameter'
    - $ref: '#/components/parameters/NetworkManagerNameParameter'
    - $ref: ./network.json#/parameters/ApiVersionParameter
    post:
      tags:
      - NetworkManagers
      operationId: microsoftAzureNetworkmanagercommitsPost
      description: Post a Network Manager Commit.
      responses:
        '202':
          description: Accepted and the operation will complete asynchronously
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkManagerCommit'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        NetworkManageCommitPost:
          $ref: ./examples/NetworkManagerCommitPost.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkManagerCommit'
        description: Parameters supplied to specify which Managed Network commit is.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/listDeploymentStatus
  : parameters:
    - $ref: ./network.json#/parameters/SubscriptionIdParameter
    - $ref: '#/components/parameters/ResourceGroupNameParameter'
    - $ref: '#/components/parameters/NetworkManagerNameParameter'
    - $ref: ./network.json#/parameters/ApiVersionParameter
    post:
      tags:
      - NetworkManagers
      operationId: microsoftAzureNetworkmanagerdeploymentstatusList
      description: Post to List of Network Manager Deployment Status.
      responses:
        '200':
          description: OK - Returns a list of deployment status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkManagerDeploymentStatusListResult'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        NetworkManagerDeploymentStatusList:
          $ref: ./examples/NetworkManagerDeploymentStatusList.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkManagerDeploymentStatusParameter'
        description: Parameters supplied to specify which Managed Network deployment status is.
        required: true
  /subscriptions/{subscriptionId}/providers/Microsoft.Network/networkManagers:
    get:
      tags:
      - NetworkManagers
      operationId: microsoftAzureNetworkmanagersListbysubscription
      description: List all network managers in a subscription.
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/ListTopParameter'
      - $ref: '#/components/parameters/ListSkipTokenParameter'
      responses:
        '200':
          description: OK - Returns information about the network managers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkManagerListResult'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        NetworkManagersList:
          $ref: ./examples/NetworkManagerListAll.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network…
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers:
    get:
      tags:
      - NetworkManagers
      operationId: microsoftAzureNetworkmanagersList
      description: List network managers in a resource group.
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/ListTopParameter'
      - $ref: '#/components/parameters/ListSkipTokenParameter'
      responses:
        '200':
          description: OK - Returns a list of network managers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkManagerListResult'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        List Network Manager:
          $ref: ./examples/NetworkManagerList.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/listEffectiveVirtualNetworks
  : post:
      tags:
      - NetworkManagers
      operationId: microsoftAzureEffectivevirtualnetworksListbynetworkmanager
      description: List effective virtual networks in a network manager.
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/NetworkManagerNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/ListTopParameter'
      - $ref: '#/components/parameters/ListSkipTokenParameter'
      responses:
        '200':
          description: OK - Returns a list of effective virtual networks.
          content:
            application/json:
              schema:
                $ref: ./networkManagerGroup.json#/definitions/EffectiveVirtualNetworksListResult
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        List Effective Virtual Networks By Network Manager:
          $ref: ./examples/NetworkManagerEffectiveVirtualNetworksListByNetworkManager.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EffectiveVirtualNetworksParameter'
        description: Effective Virtual Networks Parameter.
        required: true
components:
  schemas:
    EffectiveVirtualNetworksParameter:
      type: object
      properties:
        conditionalMembers:
          type: string
          description: Conditional Members.
        skipToken:
          description: Continuation token for pagination, capturing the next page size and offset, as well as the context of the query.
          type: string
      description: Effective Virtual Networks Parameter.
    NetworkManagerListResult:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/NetworkManager'
          description: Gets a page of NetworkManager
        nextLink:
          type: string
          description: Gets the URL to get the next page of results.
      description: Result of the request to list NetworkManager. It contains a list of network managers and a URL link to get the next set of results.
    NetworkManager:
      type: object
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/NetworkManagerProperties'
          description: The network manager properties
        etag:
          readOnly: true
          type: string
          description: A unique read-only string that changes whenever the resource is updated.
        systemData:
          readOnly: true
          description: The system metadata related to this resource.
          $ref: ./network.json#/definitions/SystemData
      allOf:
      - $ref: ./network.json#/definitions/Resource
      description: The Managed Network resource
    NetworkManagerCommit:
      type: object
      properties:
        commitId:
          type: string
          readOnly: true
          description: Commit Id.
        targetLocations:
          type: array
          items:
            type: string
          description: List of target locations.
        configurationIds:
          type: array
          items:
            type: string
          description: List of configuration ids.
        commitType:
          type: string
          $ref: '#/components/schemas/ConfigurationType'
          description: Commit Type.
      required:
      - targetLocations
      description: Network Manager Commit.
    ConfigurationType:
      type: string
      enum:
      - SecurityAdmin
      - SecurityUser
      - Connectivity
      x-ms-enum:
        name: ConfigurationType
        modelAsString: true
      description: Configuration Deployment Type.
    CrossTenantScopes:
      type: object
      properties:
        tenantId:
          readOnly: true
          type: string
          description: Tenant ID.
        managementGroups:
          type: array
          readOnly: true
          items:
            type: string
          description: List of management groups.
        subscriptions:
          type: array
          readOnly: true
          items:
            type: string
          description: List of subscriptions.
      description: Cross tenant scopes.
    NetworkManagerDeploymentStatus:
      type: object
      properties:
        commitTime:
          type: string
          format: date-time
          description: Commit Time.
        region:
          type: string
          description: Region Name.
        deploymentStatus:
          type: string
          enum:
          - NotStarted
          - Deploying
          - Deployed
          - Failed
          x-ms-enum:
            name: DeploymentStatus
            modelAsString: true
          description: Deployment Status.
        configurationIds:
          type: array
          items:
            type: string
          description: List of configuration ids.
        deploymentType:
          type: string
          $ref: '#/components/schemas/ConfigurationType'
        errorMessage:
          type: string
          description: Error Message.
      description: Network Manager Deployment Status.
    NetworkManagerProperties:
      type: object
      properties:
        description:
          type: string
          description: A description of the network manager.
        networkManagerScopes:
          type: object
          properties:
            managementGroups:
              type: array
              items:
                type: string
              description: List of management groups.
            subscriptions:
              type: array
              items:
                type: string
              description: List of subscriptions.
            crossTenantScopes:
              readOnly: true
              type: array
              x-ms-identifiers: []
              items:
                $ref: '#/components/schemas/CrossTenantScopes'
              description: List of cross tenant scopes.
          description: Scope of Network Manager.
        networkManagerScopeAccesses:
          type: array
          items:
            type: string
            $ref: '#/components/schemas/ConfigurationType'
          description: Scope Access.
        provisioningState:
          readOnly: true
          $ref: ./network.json#/definitions/ProvisioningState
          description: The provisioning state of the scope assignment resource.
      required:
      - networkManagerScopes
      - networkManagerScopeAccesses
      description: Properties of Managed Network
    NetworkManagerDeploymentStatusListResult:
      type: object
      properties:
        value:
          type: array
          x-ms-identifiers: []
          items:
            $ref: '#/components/schemas/NetworkManagerDeploymentStatus'
          description: Gets a page of Network Manager Deployment Status
        skipToken:
          description: When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
          type: string
      description: A list of Network Manager Deployment Status
    NetworkManagerDeploymentStatusParameter:
      type: object
      properties:
        regions:
          type: array
          items:
            type: string
          description: List of locations.
        deploymentTypes:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurationType'
          description: List of deployment types.
        skipToken:
          description: Continuation token for pagination, capturing the next page size and offset, as well as the context of the query.
          type: string
      description: Network Manager Deployment Status Parameter.
    PatchObject:
      type: object
      properties:
        tags:
          type: object
          additionalProperties:
            type: string
          description: Resource tags.
      description: Object for patch operations.
  parameters:
    ListTopParameter:
      name: $top
      description: An optional query parameter which specifies the maximum number of records to be returned by the server.
      in: query
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
        maximum: 20
        minimum: 1
    ForceDeleteParameter:
      name: force
      in: query
      required: false
      description: Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete.
      x-ms-parameter-location: method
      schema:
        type: boolean
    NetworkManagerNameParameter:
      name: networkManagerName
      in: path
      required: true
      description: The name of the network manager.
      x-ms-parameter-location: method
      schema:
        type: string
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      required: true
      description: The name of the resource group.
      x-ms-parameter-location: method
      schema:
        type: string
    ListSkipTokenParameter:
      name: $skipToken
      description: SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.
      in: query
      required: false
      x-ms-parameter-location: method
      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.