Microsoft Azure Microsoftmobile Packet Core Network Function Resource

swagger: '2.0'
info:
  title: Microsoft Azure Microsoft.MobilePacketCore Network Function resource
  version: 2023-05-15-preview
  description: Mobile Packet Core Network Function Management API
  x-typespec-generated:
    - emitter: '@azure-tools/typespec-autorest'
schemes:
  - https
host: management.azure.com
produces:
  - application/json
consumes:
  - application/json
security:
  - azure_auth:
      - user_impersonation
securityDefinitions:
  azure_auth:
    type: oauth2
    description: Azure Active Directory OAuth2 Flow.
    flow: implicit
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    scopes:
      user_impersonation: impersonate your user account
tags:
  - name: NetworkFunctions
  - name: Operations
paths:
  /providers/Microsoft.MobilePacketCore/operations:
    get:
      operationId: microsoftAzureOperationsList
      tags:
        - Operations
      description: List the operations for the provider
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult
        default:
          description: An unexpected error response.
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        OperationsList:
          $ref: ./examples/OperationList.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Mobilepacketcore Operations
  /subscriptions/{subscriptionId}/providers/Microsoft.MobilePacketCore/networkFunctions:
    get:
      operationId: microsoftAzureNetworkfunctionsListbysubscription
      tags:
        - NetworkFunctions
      description: List NetworkFunctionResource resources by subscription ID
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/NetworkFunctionResourceListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        NetworkFunctions_ListBySubscription:
          $ref: ./examples/NetworkFunctions_ListBySubscription.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Mobilepacketcore Networkfunctions
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/networkFunctions:
    get:
      operationId: microsoftAzureNetworkfunctionsListbyresourcegroup
      tags:
        - NetworkFunctions
      description: List NetworkFunctionResource resources by resource group
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/NetworkFunctionResourceListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        NetworkFunctions_ListByResourceGroup:
          $ref: ./examples/NetworkFunctions_ListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Mobilepacketcore Networkfunctions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/networkFunctions/{networkFunctionName}
  : get:
      operationId: microsoftAzureNetworkfunctionsGet
      tags:
        - NetworkFunctions
      description: Get a NetworkFunctionResource
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
        - name: networkFunctionName
          in: path
          description: The name of the network function
          required: true
          type: string
          minLength: 1
          maxLength: 63
          pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/NetworkFunctionResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        NetworkFunctions_Get:
          $ref: ./examples/NetworkFunctions_Get.json
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Mobilepacketcore Networkfunctions Networkfunctionname
    put:
      operationId: microsoftAzureNetworkfunctionsCreateorupdate
      tags:
        - NetworkFunctions
      description: Create a NetworkFunctionResource
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
        - name: networkFunctionName
          in: path
          description: The name of the network function
          required: true
          type: string
          minLength: 1
          maxLength: 63
          pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
        - name: resource
          in: body
          description: Resource create parameters.
          required: true
          schema:
            $ref: '#/definitions/NetworkFunctionResource'
      responses:
        '200':
          description: ARM resource update successful
          schema:
            $ref: '#/definitions/NetworkFunctionResource'
        '201':
          description: Azure create operation completed successfully.
          schema:
            $ref: '#/definitions/NetworkFunctionResource'
          headers:
            Retry-After:
              type: integer
              format: int32
              description: >-
                The Retry-After header can indicate how long the client should
                wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        NetworkFunctions_CreateOrUpdate:
          $ref: ./examples/NetworkFunctions_CreateOrUpdate.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: >-
        Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Mobilepacketcore Networkfunctions Networkfunctionname
    patch:
      operationId: microsoftAzureNetworkfunctionsUpdatetags
      tags:
        - NetworkFunctions
      description: Update a NetworkFunctionResource
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
        - name: networkFunctionName
          in: path
          description: The name of the network function
          required: true
          type: string
          minLength: 1
          maxLength: 63
          pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
        - name: properties
          in: body
          description: The resource properties to be updated.
          required: true
          schema:
            $ref: '#/definitions/NetworkFunctionResourceTagsUpdate'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/NetworkFunctionResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        NetworkFunctions_UpdateTags:
          $ref: ./examples/NetworkFunctions_UpdateTags.json
      summary: >-
        Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Mobilepacketcore Networkfunctions Networkfunctionname
    delete:
      operationId: microsoftAzureNetworkfunctionsDelete
      tags:
        - NetworkFunctions
      description: Delete a NetworkFunctionResource
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
        - name: networkFunctionName
          in: path
          description: The name of the network function
          required: true
          type: string
          minLength: 1
          maxLength: 63
          pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        NetworkFunctions_Delete:
          $ref: ./examples/NetworkFunctions_Delete.json
      summary: >-
        Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Mobilepacketcore Networkfunctions Networkfunctionname
definitions:
  NetworkFunctionAdministrativeState:
    type: string
    description: Network Function Administrative State enumerations
    enum:
      - Commissioned
      - Decommissioned
    x-ms-enum:
      name: NetworkFunctionAdministrativeState
      modelAsString: true
      values:
        - name: Commissioned
          value: Commissioned
          description: Resource has been commissioned
        - name: Decommissioned
          value: Decommissioned
          description: Resource has been decommissioned
  NetworkFunctionOperationalStatus:
    type: string
    description: Network Function Operational Status enumerations
    enum:
      - Inactive
      - InstantiatedNotProvisioned
      - InstantiatedProvisioned
      - Active
    x-ms-enum:
      name: NetworkFunctionOperationalStatus
      modelAsString: true
      values:
        - name: Inactive
          value: Inactive
          description: Resource is inactive
        - name: InstantiatedNotProvisioned
          value: InstantiatedNotProvisioned
          description: Resource has been deployed, awaiting provisioning
        - name: InstantiatedProvisioned
          value: InstantiatedProvisioned
          description: Resource has been deployed and provisioned, awaiting testing
        - name: Active
          value: Active
          description: Resource is fully deployed and operational
  NetworkFunctionResource:
    type: object
    description: AO5GC Network Function Resource
    properties:
      properties:
        $ref: '#/definitions/NetworkFunctionResourceProperties'
        description: The resource-specific properties for this resource.
        x-ms-client-flatten: true
        x-ms-mutability:
          - read
          - create
    allOf:
      - $ref: >-
          ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource
  NetworkFunctionResourceListResult:
    type: object
    description: The response of a NetworkFunctionResource list operation.
    properties:
      value:
        type: array
        description: The NetworkFunctionResource items on this page
        items:
          $ref: '#/definitions/NetworkFunctionResource'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
      - value
  NetworkFunctionResourceProperties:
    type: object
    description: Network Function Properties.
    properties:
      sku:
        $ref: '#/definitions/SkuDefinitions'
        description: Provisioned SKU Value.
        x-ms-mutability:
          - read
          - create
      networkFunctionType:
        $ref: '#/definitions/NetworkFunctionType'
        description: Type of network function
        x-ms-mutability:
          - read
          - create
      networkFunctionAdministrativeState:
        $ref: '#/definitions/NetworkFunctionAdministrativeState'
        description: Administrative state of the network function
      networkFunctionOperationalStatus:
        $ref: '#/definitions/NetworkFunctionOperationalStatus'
        description: Operational state of the network function
        readOnly: true
      infrastructureElementCount:
        type: integer
        format: int32
        description: >-
          Count of infrastructure elements used by this network function (vCPUs,
          in units of 8)
        readOnly: true
      capacity:
        type: integer
        format: int32
        description: >-
          Capacity of the network function in units of 10000.  This represents
          the session count or the Simultaneously Attached Users (SAU) count as
          applicable
        x-ms-mutability:
          - read
          - create
      userDescription:
        type: string
        description: User provided description
      deploymentNotes:
        type: string
        description: >-
          User provided deployment notes.  This is used to optionally provide
          details about the NF deployment
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
        readOnly: true
    required:
      - sku
      - networkFunctionType
      - networkFunctionAdministrativeState
  NetworkFunctionResourceTagsUpdate:
    type: object
    description: The type used for updating tags in NetworkFunctionResource resources.
    properties:
      tags:
        type: object
        description: Resource tags.
        additionalProperties:
          type: string
  NetworkFunctionType:
    type: string
    description: Type of Network Function
    enum:
      - AMF
      - SMF
      - UPF
      - NRF
      - NSSF
      - MME
      - SaegwControlPlane
      - SaegwUserPlane
      - Saegw
      - ePDG
      - N3IWF
      - RemotePaaS
      - EMS
      - OperationsPolicyManager
    x-ms-enum:
      name: NetworkFunctionType
      modelAsString: true
      values:
        - name: AMF
          value: AMF
          description: Access and Mobility Function
        - name: SMF
          value: SMF
          description: Session Management Function
        - name: UPF
          value: UPF
          description: User Plane Function
        - name: NRF
          value: NRF
          description: Network Repository Function
        - name: NSSF
          value: NSSF
          description: Network Slice Selection Function
        - name: MME
          value: MME
          description: Mobility Management Entity
        - name: SaegwControlPlane
          value: SaegwControlPlane
          description: >-
            System Architecture Evolution Gateway Control Plane, control and
            user plane separation (CUPS) architecture
        - name: SaegwUserPlane
          value: SaegwUserPlane
          description: >-
            System Architecture Evolution Gateway User Plane, control and user
            plane separation (CUPS) architecture
        - name: Saegw
          value: Saegw
          description: >-
            System Architecture Evolution Gateway.  This combines the Serving
            Gateway (SGW) and the Packet Data Network Gateway (PGW)
            functionality
        - name: ePDG
          value: ePDG
          description: Evolved Packet Data Gateway
        - name: N3IWF
          value: N3IWF
          description: Non-3GPP Interworking Function
        - name: RemotePaaS
          value: RemotePaaS
          description: Remote Platform As A Service Components
        - name: EMS
          value: EMS
          description: Element Management System
        - name: OperationsPolicyManager
          value: OperationsPolicyManager
          description: Operations and Policy Manager
  ProvisioningState:
    type: string
    description: Provisioning state of the resource
    enum:
      - Succeeded
      - Failed
      - Canceled
      - Provisioning
      - Updating
      - Deleting
      - Accepted
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
      values:
        - name: Succeeded
          value: Succeeded
          description: Resource has been created.
        - name: Failed
          value: Failed
          description: Resource creation failed.
        - name: Canceled
          value: Canceled
          description: Resource creation was canceled.
        - name: Provisioning
          value: Provisioning
          description: Resource is getting provisioned
        - name: Updating
          value: Updating
          description: Resource is updating
        - name: Deleting
          value: Deleting
          description: Resource is getting deleted
        - name: Accepted
          value: Accepted
          description: Resource has been accepted
  SkuDefinitions:
    type: string
    description: SKU Definitions
    enum:
      - AzureLab
      - AzureProduction
      - NexusLab
      - NexusProduction
    x-ms-enum:
      name: SkuDefinitions
      modelAsString: true
      values:
        - name: AzureLab
          value: AzureLab
          description: Azure Lab SKU
        - name: AzureProduction
          value: AzureProduction
          description: Azure Production SKU
        - name: NexusLab
          value: NexusLab
          description: Nexus Lab SKU
        - name: NexusProduction
          value: NexusProduction
          description: Nexus Production SKU
  Versions:
    type: string
    description: API Versions
    enum:
      - 2023-05-15-preview
    x-ms-enum:
      name: Versions
      modelAsString: true
      values:
        - name: v2023_05_15_preview
          value: 2023-05-15-preview
          description: May 15, 2023 Preview API Version
parameters: {}