service.json

{
  "swagger": "2.0",
  "info": {
    "title": "MobileNetworkManagementClient",
    "description": "The resources in this swagger specification will be used to manage service resources",
    "version": "2022-04-01-preview"
  },
  "host": "management.azure.com",
  "schemes": [
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "security": [
    {
      "azure_auth": [
        "user_impersonation"
      ]
    }
  ],
  "securityDefinitions": {
    "azure_auth": {
      "type": "oauth2",
      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
      "flow": "implicit",
      "description": "Azure Active Directory OAuth2 Flow.",
      "scopes": {
        "user_impersonation": "impersonate your user account"
      }
    }
  },
  "paths": {
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/services/{serviceName}": {
      "delete": {
        "tags": [
          "Service"
        ],
        "operationId": "Services_Delete",
        "description": "Deletes the specified service.",
        "parameters": [
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
          },
          {
            "$ref": "./common.json#/parameters/MobileNetworkNameParameter"
          },
          {
            "$ref": "./common.json#/parameters/ServiceNameParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Delete successful."
          },
          "202": {
            "description": "Accepted. Sets 'Deleting' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation."
          },
          "204": {
            "description": "Request successful. Resource does not exist."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Delete service": {
            "$ref": "./examples/ServiceDelete.json"
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-long-running-operation-options": {
          "final-state-via": "location"
        }
      },
      "get": {
        "tags": [
          "Service"
        ],
        "operationId": "Services_Get",
        "description": "Gets information about the specified service.",
        "parameters": [
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
          },
          {
            "$ref": "./common.json#/parameters/MobileNetworkNameParameter"
          },
          {
            "$ref": "./common.json#/parameters/ServiceNameParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Request successful. The operation returns the resulting service resource.",
            "schema": {
              "$ref": "#/definitions/Service"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Get service": {
            "$ref": "./examples/ServiceGet.json"
          }
        }
      },
      "put": {
        "tags": [
          "Service"
        ],
        "operationId": "Services_CreateOrUpdate",
        "description": "Creates or updates a service.",
        "parameters": [
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
          },
          {
            "$ref": "./common.json#/parameters/MobileNetworkNameParameter"
          },
          {
            "$ref": "./common.json#/parameters/ServiceNameParameter"
          },
          {
            "name": "parameters",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Service"
            },
            "description": "Parameters supplied to the create or update service operation."
          },
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Update successful. The operation returns the resulting service resource.",
            "schema": {
              "$ref": "#/definitions/Service"
            }
          },
          "201": {
            "description": "Create successful. The operation returns the resulting service resource.",
            "schema": {
              "$ref": "#/definitions/Service"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Create service": {
            "$ref": "./examples/ServiceCreate.json"
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-long-running-operation-options": {
          "final-state-via": "azure-async-operation"
        }
      },
      "patch": {
        "tags": [
          "Service"
        ],
        "operationId": "Services_UpdateTags",
        "description": "Updates service tags.",
        "parameters": [
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "./common.json#/parameters/MobileNetworkNameParameter"
          },
          {
            "$ref": "./common.json#/parameters/ServiceNameParameter"
          },
          {
            "name": "parameters",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "./common.json#/definitions/TagsObject"
            },
            "description": "Parameters supplied to update service tags."
          }
        ],
        "responses": {
          "200": {
            "description": "Update successful. The operation returns the resulting service resource.",
            "schema": {
              "$ref": "#/definitions/Service"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Update service tags": {
            "$ref": "./examples/ServiceUpdateTags.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/services": {
      "get": {
        "tags": [
          "Services"
        ],
        "operationId": "Services_ListByMobileNetwork",
        "description": "Gets all the services in a mobile network.",
        "parameters": [
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
          },
          {
            "$ref": "./common.json#/parameters/MobileNetworkNameParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Request successful. The operation returns a list of service resources.",
            "schema": {
              "$ref": "#/definitions/ServiceListResult"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "List services in a mobile network": {
            "$ref": "./examples/ServiceListByMobileNetwork.json"
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        }
      }
    }
  },
  "definitions": {
    "Service": {
      "type": "object",
      "properties": {
        "properties": {
          "x-ms-client-flatten": true,
          "$ref": "#/definitions/ServicePropertiesFormat",
          "description": "Service Properties."
        },
        "systemData": {
          "x-ms-client-flatten": true,
          "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData",
          "readOnly": true,
          "description": "Metadata pertaining to creation and last modification of the resource."
        }
      },
      "allOf": [
        {
          "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
        }
      ],
      "required": [
        "properties"
      ],
      "description": "Service resource."
    },
    "ServicePropertiesFormat": {
      "description": "Service properties.",
      "type": "object",
      "properties": {
        "provisioningState": {
          "description": "The provisioning state of the service resource.",
          "$ref": "./common.json#/definitions/ProvisioningState"
        },
        "servicePrecedence": {
          "description": "A precedence value that is used to decide between services when identifying the QoS values to use for a particular SIM. A lower value means a higher priority. This value should be unique among all services configured in the mobile network.",
          "type": "integer",
          "format": "int32",
          "minimum": 0,
          "maximum": 255
        },
        "serviceQosPolicy": {
          "description": "The QoS policy to use for packets matching this service. This can be overridden for particular flows using the ruleQosPolicy field in a PccRuleConfiguration. If this field is null then the UE's SIM policy will define the QoS settings.",
          "$ref": "#/definitions/QosPolicy"
        },
        "pccRules": {
          "description": "The set of data flow policy rules that make up this service.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/PccRuleConfiguration"
          },
          "minItems": 1,
          "uniqueItems": true,
          "x-ms-identifiers": [
            "ruleName"
          ]
        }
      },
      "required": [
        "servicePrecedence",
        "pccRules"
      ]
    },
    "PccRuleConfiguration": {
      "description": "Data flow policy rule configuration",
      "type": "object",
      "properties": {
        "ruleName": {
          "description": "The name of the rule. This must be unique within the parent service. You must not use any of the following reserved strings - `default`, `requested` or `service`.",
          "type": "string",
          "pattern": "^(?!(default|requested|service)$)[a-zA-Z0-9][a-zA-Z0-9_-]*$",
          "maxLength": 64
        },
        "rulePrecedence": {
          "description": "A precedence value that is used to decide between data flow policy rules when identifying the QoS values to use for a particular SIM. A lower value means a higher priority. This value should be unique among all data flow policy rules configured in the mobile network.",
          "type": "integer",
          "format": "int32",
          "minimum": 0,
          "maximum": 255
        },
        "ruleQosPolicy": {
          "description": "The QoS policy to use for packets matching this rule. If this field is null then the parent service will define the QoS settings.",
          "$ref": "#/definitions/PccRuleQosPolicy"
        },
        "trafficControl": {
          "description": "Determines whether flows that match this data flow policy rule are permitted.",
          "$ref": "#/definitions/TrafficControlPermission",
          "default": "Enabled"
        },
        "serviceDataFlowTemplates": {
          "description": "The set of data flow templates to use for this data flow policy rule.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/ServiceDataFlowTemplate"
          },
          "minItems": 1,
          "uniqueItems": true,
          "x-ms-identifiers": [
            "templateName"
          ]
        }
      },
      "required": [
        "ruleName",
        "rulePrecedence",
        "serviceDataFlowTemplates"
      ]
    },
    "ServiceDataFlowTemplate": {
      "description": "Data flow template",
      "type": "object",
      "properties": {
        "templateName": {
          "description": "The name of the data flow template. This must be unique within the parent data flow policy rule. You must not use any of the following reserved strings - `default`, `requested` or `service`.",
          "type": "string",
          "pattern": "^(?!(default|requested|service)$)[a-zA-Z0-9][a-zA-Z0-9_-]*$",
          "maxLength": 64
        },
        "direction": {
          "description": "The direction of this flow.",
          "$ref": "#/definitions/SdfDirection"
        },
        "protocol": {
          "description": "A list of the allowed protocol(s) for this flow. If you want this flow to be able to use any protocol within the internet protocol suite, use the value `ip`. If you only want to allow a selection of protocols, you must use the corresponding IANA Assigned Internet Protocol Number for each protocol, as described in https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml. For example, for UDP, you must use 17. If you use the value `ip` then you must leave the field `port` unspecified.",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^(ip|[0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$"
          },
          "minItems": 1,
          "uniqueItems": true
        },
        "remoteIpList": {
          "description": "The remote IP address(es) to which UEs will connect for this flow. If you want to allow connections on any IP address, use the value `any`. Otherwise, you must provide each of the remote IP addresses to which the packet core instance will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24).",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^(any|(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\\/([0-9]|[1-2][0-9]|3[0-2])))$",
            "description": "IPv4 address mask or value `any`",
            "example": "198.51.0.0/16"
          },
          "minItems": 1,
          "uniqueItems": true
        },
        "ports": {
          "description": "The port(s) to which UEs will connect for this flow. You can specify zero or more ports or port ranges. If you specify one or more ports or port ranges then you must specify a value other than `ip` in the `protocol` field. This is an optional setting. If you do not specify it then connections will be allowed on all ports. Port ranges must be specified as <FirstPort>-<LastPort>. For example: [`8080`, `8082-8085`].",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])(-([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))?$"
          },
          "uniqueItems": true
        }
      },
      "required": [
        "templateName",
        "direction",
        "protocol",
        "remoteIpList"
      ]
    },
    "ServiceListResult": {
      "type": "object",
      "properties": {
        "value": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Service"
          },
          "description": "A list of services."
        },
        "nextLink": {
          "type": "string",
          "readOnly": true,
          "description": "The URL to get the next set of results."
        }
      },
      "description": "Response for services API service call."
    },
    "QosPolicy": {
      "description": "QoS policy",
      "type": "object",
      "properties": {
        "5qi": {
          "description": "QoS Flow 5G QoS Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. This must not be a standardized 5QI value corresponding to a GBR (guaranteed bit rate) QoS Flow. The illegal GBR 5QI values are: 1, 2, 3, 4, 65, 66, 67, 71, 72, 73, 74, 75, 76, 82, 83, 84, and 85. See 3GPP TS23.501 section 5.7.2.1 for a full description of the 5QI parameter, and table 5.7.4-1 for the definition of which are the GBR 5QI values.",
          "$ref": "./ts29571.json#/definitions/5QiPriorityLevel",
          "default": 9
        },
        "allocationAndRetentionPriorityLevel": {
          "description": "QoS Flow allocation and retention priority (ARP) level. Flows with higher priority preempt flows with lower priority, if the settings of `preemptionCapability` and `preemptionVulnerability` allow it. 1 is the highest level of priority. If this field is not specified then `5qi` is used to derive the ARP value. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters.",
          "$ref": "./ts29571.json#/definitions/ArpPriorityLevel",
          "default": 9
        },
        "preemptionCapability": {
          "description": "QoS Flow preemption capability. The preemption capability of a QoS Flow controls whether it can preempt another QoS Flow with a lower priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters.",
          "$ref": "./ts29571.json#/definitions/PreemptionCapability",
          "default": "NotPreempt"
        },
        "preemptionVulnerability": {
          "description": "QoS Flow preemption vulnerability. The preemption vulnerability of a QoS Flow controls whether it can be preempted by a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters.",
          "$ref": "./ts29571.json#/definitions/PreemptionVulnerability",
          "default": "Preemptable"
        },
        "maximumBitRate": {
          "description": "The maximum bit rate (MBR) for all service data flows that use this data flow policy rule or service.",
          "$ref": "./ts29571.json#/definitions/Ambr"
        }
      },
      "required": [
        "maximumBitRate"
      ]
    },
    "PccRuleQosPolicy": {
      "description": "Data flow policy rule QoS policy",
      "type": "object",
      "properties": {
        "guaranteedBitRate": {
          "description": "The guaranteed bit rate (GBR) for all service data flows that use this data flow policy rule. This is an optional setting. If you do not provide a value, there will be no GBR set for the data flow policy rule that uses this QoS definition.",
          "$ref": "./ts29571.json#/definitions/Ambr"
        }
      },
      "allOf": [
        {
          "$ref": "#/definitions/QosPolicy"
        }
      ]
    },
    "TrafficControlPermission": {
      "type": "string",
      "description": "Traffic control permission.",
      "enum": [
        "Enabled",
        "Blocked"
      ],
      "x-ms-enum": {
        "name": "TrafficControlPermission",
        "modelAsString": true,
        "values": [
          {
            "value": "Enabled",
            "description": "Traffic matching this rule is allowed to flow."
          },
          {
            "value": "Blocked",
            "description": "Traffic matching this rule is not allowed to flow."
          }
        ]
      }
    },
    "SdfDirection": {
      "type": "string",
      "description": "Service data flow direction.",
      "enum": [
        "Uplink",
        "Downlink",
        "Bidirectional"
      ],
      "x-ms-enum": {
        "name": "SdfDirection",
        "modelAsString": true,
        "values": [
          {
            "value": "Uplink",
            "description": "Traffic flowing from the UE to the data network."
          },
          {
            "value": "Downlink",
            "description": "Traffic flowing from the data network to the UE."
          },
          {
            "value": "Bidirectional",
            "description": "Traffic flowing both to and from the UE."
          }
        ]
      }
    }
  }
}