Microsoft.MobileNetwork (preview:2022-03-01)

2025/11/24 • 55 deleted methods

AttachedDataNetworks_Delete (removed)
Description :  Deletes the specified attached data network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCoreDataPlanes/{packetCoreDataPlaneName}/attachedDataNetworks/{attachedDataNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
packetCoreControlPlaneName:
{
Description: The name of the packet core control plane. ,
Required: True ,
}
string ,
packetCoreDataPlaneName:
{
Description: The name of the packet core data plane. ,
Required: True ,
}
string ,
attachedDataNetworkName:
{
Description: The name of the attached data network. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AttachedDataNetworks_Get (removed)
Description :  Gets information about the specified attached data network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCoreDataPlanes/{packetCoreDataPlaneName}/attachedDataNetworks/{attachedDataNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
packetCoreControlPlaneName:
{
Description: The name of the packet core control plane. ,
Required: True ,
}
string ,
packetCoreDataPlaneName:
{
Description: The name of the packet core data plane. ,
Required: True ,
}
string ,
attachedDataNetworkName:
{
Description: The name of the attached data network. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Data network properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the attached data network resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
userPlaneDataInterface:
{
Description: The user plane interface on the data network. In 5G networks this is called as N6 interface whereas in 4G networks this is called as SGi interface. ,
Required: True ,
}
{
name:
{
Description: The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. ,
Required: True ,
}
string ,
ipv4Address:
{
Description: The IPv4 address. ,
Required: False ,
}
string ,
ipv4Subnet:
{
Description: The IPv4 subnet. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The default IPv4 gateway (router). ,
Required: False ,
}
string ,
}
,
naptConfiguration:
{
Description: The Network Address and Port Translation configuration. If not specified the attached data network uses a default NAPT configuration with NAPT enabled. ,
Required: False ,
}
{
enabled:
{
Description: Whether NAPT is enabled for connections to this attachedDataNetwork. ,
Enum:
{
Enabled: NAPT is enabled ,
Disabled: NAPT is disabled ,
}
,
Required: False ,
}
enum ,
portRange:
{
Description: Range of port numbers to use as translated ports on each translated address. If not specified and NAPT is enabled, this range defaults to 1,024 - 65,535. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA.) ,
Required: False ,
}
{
minPort:
{
Description: The minimum port number ,
Format: int32 ,
Required: False ,
}
integer ,
maxPort:
{
Description: The maximum port number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
portReuseHoldTime:
{
Description: The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by another pinhole. All hold times must be minimum 1 second. ,
Required: False ,
}
{
tcp:
{
Description: Minimum time in seconds that will pass before a TCP port that was used by a closed pinhole can be reused. Default for TCP is 2 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
udp:
{
Description: Minimum time in seconds that will pass before a UDP port that was used by a closed pinhole can be reused. Default for UDP is 1 minute. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
pinholeLimits:
{
Description: Maximum number of UDP and TCP pinholes that can be open simultaneously on the core interface. ,
Format: int32 ,
Required: False ,
}
integer ,
pinholeTimeouts:
{
Description: Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second. ,
Required: False ,
}
{
tcp:
{
Description: Pinhole timeout for TCP pinholes in seconds. Default for TCP is 2 hours 4 minutes per RFC 5382 section 5. ,
Format: int32 ,
Required: False ,
}
integer ,
udp:
{
Description: Pinhole timeout for UDP pinholes in seconds. Default for UDP is 5 minutes per RFC 4787 section 4.3. ,
Format: int32 ,
Required: False ,
}
integer ,
icmp:
{
Description: Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 60 seconds per RFC 5508 section 3.2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
userEquipmentAddressPoolPrefix:
{
Description: The user equipment address pool prefixes for the attached data network that are dynamically assigned by the core to UEs when they set up a PDU session. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. ,
Required: False ,
}
[
string ,
]
,
userEquipmentStaticAddressPoolPrefix:
{
Description: The user equipment address pool prefixes for the attached data network that are statically assigned by the core to UEs when they set up a PDU session. The mapping of static IP to sim is configured in staticIpConfiguration on the sim resource. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AttachedDataNetworks_CreateOrUpdate (removed)
Description :  Creates or updates an attached data network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCoreDataPlanes/{packetCoreDataPlaneName}/attachedDataNetworks/{attachedDataNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
packetCoreControlPlaneName:
{
Description: The name of the packet core control plane. ,
Required: True ,
}
string ,
packetCoreDataPlaneName:
{
Description: The name of the packet core data plane. ,
Required: True ,
}
string ,
attachedDataNetworkName:
{
Description: The name of the attached data network. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update attached data network operation. ,
Required: True ,
}
{
properties:
{
Description: Data network properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the attached data network resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
userPlaneDataInterface:
{
Description: The user plane interface on the data network. In 5G networks this is called as N6 interface whereas in 4G networks this is called as SGi interface. ,
Required: True ,
}
{
name:
{
Description: The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. ,
Required: True ,
}
string ,
ipv4Address:
{
Description: The IPv4 address. ,
Required: False ,
}
string ,
ipv4Subnet:
{
Description: The IPv4 subnet. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The default IPv4 gateway (router). ,
Required: False ,
}
string ,
}
,
naptConfiguration:
{
Description: The Network Address and Port Translation configuration. If not specified the attached data network uses a default NAPT configuration with NAPT enabled. ,
Required: False ,
}
{
enabled:
{
Description: Whether NAPT is enabled for connections to this attachedDataNetwork. ,
Enum:
{
Enabled: NAPT is enabled ,
Disabled: NAPT is disabled ,
}
,
Required: False ,
}
enum ,
portRange:
{
Description: Range of port numbers to use as translated ports on each translated address. If not specified and NAPT is enabled, this range defaults to 1,024 - 65,535. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA.) ,
Required: False ,
}
{
minPort:
{
Description: The minimum port number ,
Format: int32 ,
Required: False ,
}
integer ,
maxPort:
{
Description: The maximum port number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
portReuseHoldTime:
{
Description: The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by another pinhole. All hold times must be minimum 1 second. ,
Required: False ,
}
{
tcp:
{
Description: Minimum time in seconds that will pass before a TCP port that was used by a closed pinhole can be reused. Default for TCP is 2 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
udp:
{
Description: Minimum time in seconds that will pass before a UDP port that was used by a closed pinhole can be reused. Default for UDP is 1 minute. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
pinholeLimits:
{
Description: Maximum number of UDP and TCP pinholes that can be open simultaneously on the core interface. ,
Format: int32 ,
Required: False ,
}
integer ,
pinholeTimeouts:
{
Description: Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second. ,
Required: False ,
}
{
tcp:
{
Description: Pinhole timeout for TCP pinholes in seconds. Default for TCP is 2 hours 4 minutes per RFC 5382 section 5. ,
Format: int32 ,
Required: False ,
}
integer ,
udp:
{
Description: Pinhole timeout for UDP pinholes in seconds. Default for UDP is 5 minutes per RFC 4787 section 4.3. ,
Format: int32 ,
Required: False ,
}
integer ,
icmp:
{
Description: Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 60 seconds per RFC 5508 section 3.2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
userEquipmentAddressPoolPrefix:
{
Description: The user equipment address pool prefixes for the attached data network that are dynamically assigned by the core to UEs when they set up a PDU session. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. ,
Required: False ,
}
[
string ,
]
,
userEquipmentStaticAddressPoolPrefix:
{
Description: The user equipment address pool prefixes for the attached data network that are statically assigned by the core to UEs when they set up a PDU session. The mapping of static IP to sim is configured in staticIpConfiguration on the sim resource. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Data network properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the attached data network resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
userPlaneDataInterface:
{
Description: The user plane interface on the data network. In 5G networks this is called as N6 interface whereas in 4G networks this is called as SGi interface. ,
Required: True ,
}
{
name:
{
Description: The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. ,
Required: True ,
}
string ,
ipv4Address:
{
Description: The IPv4 address. ,
Required: False ,
}
string ,
ipv4Subnet:
{
Description: The IPv4 subnet. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The default IPv4 gateway (router). ,
Required: False ,
}
string ,
}
,
naptConfiguration:
{
Description: The Network Address and Port Translation configuration. If not specified the attached data network uses a default NAPT configuration with NAPT enabled. ,
Required: False ,
}
{
enabled:
{
Description: Whether NAPT is enabled for connections to this attachedDataNetwork. ,
Enum:
{
Enabled: NAPT is enabled ,
Disabled: NAPT is disabled ,
}
,
Required: False ,
}
enum ,
portRange:
{
Description: Range of port numbers to use as translated ports on each translated address. If not specified and NAPT is enabled, this range defaults to 1,024 - 65,535. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA.) ,
Required: False ,
}
{
minPort:
{
Description: The minimum port number ,
Format: int32 ,
Required: False ,
}
integer ,
maxPort:
{
Description: The maximum port number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
portReuseHoldTime:
{
Description: The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by another pinhole. All hold times must be minimum 1 second. ,
Required: False ,
}
{
tcp:
{
Description: Minimum time in seconds that will pass before a TCP port that was used by a closed pinhole can be reused. Default for TCP is 2 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
udp:
{
Description: Minimum time in seconds that will pass before a UDP port that was used by a closed pinhole can be reused. Default for UDP is 1 minute. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
pinholeLimits:
{
Description: Maximum number of UDP and TCP pinholes that can be open simultaneously on the core interface. ,
Format: int32 ,
Required: False ,
}
integer ,
pinholeTimeouts:
{
Description: Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second. ,
Required: False ,
}
{
tcp:
{
Description: Pinhole timeout for TCP pinholes in seconds. Default for TCP is 2 hours 4 minutes per RFC 5382 section 5. ,
Format: int32 ,
Required: False ,
}
integer ,
udp:
{
Description: Pinhole timeout for UDP pinholes in seconds. Default for UDP is 5 minutes per RFC 4787 section 4.3. ,
Format: int32 ,
Required: False ,
}
integer ,
icmp:
{
Description: Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 60 seconds per RFC 5508 section 3.2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
userEquipmentAddressPoolPrefix:
{
Description: The user equipment address pool prefixes for the attached data network that are dynamically assigned by the core to UEs when they set up a PDU session. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. ,
Required: False ,
}
[
string ,
]
,
userEquipmentStaticAddressPoolPrefix:
{
Description: The user equipment address pool prefixes for the attached data network that are statically assigned by the core to UEs when they set up a PDU session. The mapping of static IP to sim is configured in staticIpConfiguration on the sim resource. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Data network properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the attached data network resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
userPlaneDataInterface:
{
Description: The user plane interface on the data network. In 5G networks this is called as N6 interface whereas in 4G networks this is called as SGi interface. ,
Required: True ,
}
{
name:
{
Description: The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. ,
Required: True ,
}
string ,
ipv4Address:
{
Description: The IPv4 address. ,
Required: False ,
}
string ,
ipv4Subnet:
{
Description: The IPv4 subnet. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The default IPv4 gateway (router). ,
Required: False ,
}
string ,
}
,
naptConfiguration:
{
Description: The Network Address and Port Translation configuration. If not specified the attached data network uses a default NAPT configuration with NAPT enabled. ,
Required: False ,
}
{
enabled:
{
Description: Whether NAPT is enabled for connections to this attachedDataNetwork. ,
Enum:
{
Enabled: NAPT is enabled ,
Disabled: NAPT is disabled ,
}
,
Required: False ,
}
enum ,
portRange:
{
Description: Range of port numbers to use as translated ports on each translated address. If not specified and NAPT is enabled, this range defaults to 1,024 - 65,535. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA.) ,
Required: False ,
}
{
minPort:
{
Description: The minimum port number ,
Format: int32 ,
Required: False ,
}
integer ,
maxPort:
{
Description: The maximum port number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
portReuseHoldTime:
{
Description: The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by another pinhole. All hold times must be minimum 1 second. ,
Required: False ,
}
{
tcp:
{
Description: Minimum time in seconds that will pass before a TCP port that was used by a closed pinhole can be reused. Default for TCP is 2 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
udp:
{
Description: Minimum time in seconds that will pass before a UDP port that was used by a closed pinhole can be reused. Default for UDP is 1 minute. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
pinholeLimits:
{
Description: Maximum number of UDP and TCP pinholes that can be open simultaneously on the core interface. ,
Format: int32 ,
Required: False ,
}
integer ,
pinholeTimeouts:
{
Description: Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second. ,
Required: False ,
}
{
tcp:
{
Description: Pinhole timeout for TCP pinholes in seconds. Default for TCP is 2 hours 4 minutes per RFC 5382 section 5. ,
Format: int32 ,
Required: False ,
}
integer ,
udp:
{
Description: Pinhole timeout for UDP pinholes in seconds. Default for UDP is 5 minutes per RFC 4787 section 4.3. ,
Format: int32 ,
Required: False ,
}
integer ,
icmp:
{
Description: Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 60 seconds per RFC 5508 section 3.2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
userEquipmentAddressPoolPrefix:
{
Description: The user equipment address pool prefixes for the attached data network that are dynamically assigned by the core to UEs when they set up a PDU session. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. ,
Required: False ,
}
[
string ,
]
,
userEquipmentStaticAddressPoolPrefix:
{
Description: The user equipment address pool prefixes for the attached data network that are statically assigned by the core to UEs when they set up a PDU session. The mapping of static IP to sim is configured in staticIpConfiguration on the sim resource. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AttachedDataNetworks_UpdateTags (removed)
Description :  Updates an attached data network update tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCoreDataPlanes/{packetCoreDataPlaneName}/attachedDataNetworks/{attachedDataNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
packetCoreControlPlaneName:
{
Description: The name of the packet core control plane. ,
Required: True ,
}
string ,
packetCoreDataPlaneName:
{
Description: The name of the packet core data plane. ,
Required: True ,
}
string ,
attachedDataNetworkName:
{
Description: The name of the attached data network. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update attached data network tags. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Data network properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the attached data network resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
userPlaneDataInterface:
{
Description: The user plane interface on the data network. In 5G networks this is called as N6 interface whereas in 4G networks this is called as SGi interface. ,
Required: True ,
}
{
name:
{
Description: The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. ,
Required: True ,
}
string ,
ipv4Address:
{
Description: The IPv4 address. ,
Required: False ,
}
string ,
ipv4Subnet:
{
Description: The IPv4 subnet. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The default IPv4 gateway (router). ,
Required: False ,
}
string ,
}
,
naptConfiguration:
{
Description: The Network Address and Port Translation configuration. If not specified the attached data network uses a default NAPT configuration with NAPT enabled. ,
Required: False ,
}
{
enabled:
{
Description: Whether NAPT is enabled for connections to this attachedDataNetwork. ,
Enum:
{
Enabled: NAPT is enabled ,
Disabled: NAPT is disabled ,
}
,
Required: False ,
}
enum ,
portRange:
{
Description: Range of port numbers to use as translated ports on each translated address. If not specified and NAPT is enabled, this range defaults to 1,024 - 65,535. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA.) ,
Required: False ,
}
{
minPort:
{
Description: The minimum port number ,
Format: int32 ,
Required: False ,
}
integer ,
maxPort:
{
Description: The maximum port number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
portReuseHoldTime:
{
Description: The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by another pinhole. All hold times must be minimum 1 second. ,
Required: False ,
}
{
tcp:
{
Description: Minimum time in seconds that will pass before a TCP port that was used by a closed pinhole can be reused. Default for TCP is 2 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
udp:
{
Description: Minimum time in seconds that will pass before a UDP port that was used by a closed pinhole can be reused. Default for UDP is 1 minute. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
pinholeLimits:
{
Description: Maximum number of UDP and TCP pinholes that can be open simultaneously on the core interface. ,
Format: int32 ,
Required: False ,
}
integer ,
pinholeTimeouts:
{
Description: Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second. ,
Required: False ,
}
{
tcp:
{
Description: Pinhole timeout for TCP pinholes in seconds. Default for TCP is 2 hours 4 minutes per RFC 5382 section 5. ,
Format: int32 ,
Required: False ,
}
integer ,
udp:
{
Description: Pinhole timeout for UDP pinholes in seconds. Default for UDP is 5 minutes per RFC 4787 section 4.3. ,
Format: int32 ,
Required: False ,
}
integer ,
icmp:
{
Description: Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 60 seconds per RFC 5508 section 3.2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
userEquipmentAddressPoolPrefix:
{
Description: The user equipment address pool prefixes for the attached data network that are dynamically assigned by the core to UEs when they set up a PDU session. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. ,
Required: False ,
}
[
string ,
]
,
userEquipmentStaticAddressPoolPrefix:
{
Description: The user equipment address pool prefixes for the attached data network that are statically assigned by the core to UEs when they set up a PDU session. The mapping of static IP to sim is configured in staticIpConfiguration on the sim resource. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AttachedDataNetworks_ListByPacketCoreDataPlane (removed)
Description :  Gets all the data networks associated with a packet core data plane.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCoreDataPlanes/{packetCoreDataPlaneName}/attachedDataNetworks
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
packetCoreControlPlaneName:
{
Description: The name of the packet core control plane. ,
Required: True ,
}
string ,
packetCoreDataPlaneName:
{
Description: The name of the packet core data plane. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of data networks in a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: Data network properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the attached data network resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
userPlaneDataInterface:
{
Description: The user plane interface on the data network. In 5G networks this is called as N6 interface whereas in 4G networks this is called as SGi interface. ,
Required: True ,
}
{
name:
{
Description: The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. ,
Required: True ,
}
string ,
ipv4Address:
{
Description: The IPv4 address. ,
Required: False ,
}
string ,
ipv4Subnet:
{
Description: The IPv4 subnet. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The default IPv4 gateway (router). ,
Required: False ,
}
string ,
}
,
naptConfiguration:
{
Description: The Network Address and Port Translation configuration. If not specified the attached data network uses a default NAPT configuration with NAPT enabled. ,
Required: False ,
}
{
enabled:
{
Description: Whether NAPT is enabled for connections to this attachedDataNetwork. ,
Enum:
{
Enabled: NAPT is enabled ,
Disabled: NAPT is disabled ,
}
,
Required: False ,
}
enum ,
portRange:
{
Description: Range of port numbers to use as translated ports on each translated address. If not specified and NAPT is enabled, this range defaults to 1,024 - 65,535. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA.) ,
Required: False ,
}
{
minPort:
{
Description: The minimum port number ,
Format: int32 ,
Required: False ,
}
integer ,
maxPort:
{
Description: The maximum port number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
portReuseHoldTime:
{
Description: The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by another pinhole. All hold times must be minimum 1 second. ,
Required: False ,
}
{
tcp:
{
Description: Minimum time in seconds that will pass before a TCP port that was used by a closed pinhole can be reused. Default for TCP is 2 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
udp:
{
Description: Minimum time in seconds that will pass before a UDP port that was used by a closed pinhole can be reused. Default for UDP is 1 minute. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
pinholeLimits:
{
Description: Maximum number of UDP and TCP pinholes that can be open simultaneously on the core interface. ,
Format: int32 ,
Required: False ,
}
integer ,
pinholeTimeouts:
{
Description: Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second. ,
Required: False ,
}
{
tcp:
{
Description: Pinhole timeout for TCP pinholes in seconds. Default for TCP is 2 hours 4 minutes per RFC 5382 section 5. ,
Format: int32 ,
Required: False ,
}
integer ,
udp:
{
Description: Pinhole timeout for UDP pinholes in seconds. Default for UDP is 5 minutes per RFC 4787 section 4.3. ,
Format: int32 ,
Required: False ,
}
integer ,
icmp:
{
Description: Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 60 seconds per RFC 5508 section 3.2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
userEquipmentAddressPoolPrefix:
{
Description: The user equipment address pool prefixes for the attached data network that are dynamically assigned by the core to UEs when they set up a PDU session. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. ,
Required: False ,
}
[
string ,
]
,
userEquipmentStaticAddressPoolPrefix:
{
Description: The user equipment address pool prefixes for the attached data network that are statically assigned by the core to UEs when they set up a PDU session. The mapping of static IP to sim is configured in staticIpConfiguration on the sim resource. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataNetworks_Delete (removed)
Description :  Deletes the specified mobile network dataNetwork.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/dataNetworks/{dataNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
dataNetworkName:
{
Description: The name of the mobile network dataNetwork. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataNetworks_Get (removed)
Description :  Gets information about the specified mobile network dataNetwork.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/dataNetworks/{dataNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
dataNetworkName:
{
Description: The name of the mobile network dataNetwork. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Data network properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the data network resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: An optional description for this data network. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataNetworks_CreateOrUpdate (removed)
Description :  Creates or updates a mobile network dataNetwork.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/dataNetworks/{dataNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
dataNetworkName:
{
Description: The name of the mobile network dataNetwork. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update mobile network dataNetwork operation. ,
Required: True ,
}
{
properties:
{
Description: Data network properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the data network resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: An optional description for this data network. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Data network properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the data network resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: An optional description for this data network. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Data network properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the data network resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: An optional description for this data network. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataNetworks_UpdateTags (removed)
Description :  Update data network tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/dataNetworks/{dataNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
dataNetworkName:
{
Description: The name of the mobile network dataNetwork. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update data network tags. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Data network properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the data network resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: An optional description for this data network. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataNetworks_ListByMobileNetwork (removed)
Description :  Lists all dataNetworks in the mobile network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/dataNetworks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of data networks in a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: Data network properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the data network resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: An optional description for this data network. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MobileNetworks_Delete (removed)
Description :  Deletes the specified mobile network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MobileNetworks_Get (removed)
Description :  Gets information about the specified mobile network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Mobile network properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the mobile network resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
publicLandMobileNetworkIdentifier:
{
Description: The unique public land mobile network identifier for the network. This is made up of the Mobile Country Code and Mobile Network Code, as defined in https://www.itu.int/rec/T-REC-E.212. The values 001-01 and 001-001 can be used for testing and the values 999-99 and 999-999 can be used on internal private networks. ,
Required: True ,
}
{
mcc:
{
Description: Mobile Country Code (MCC). ,
Required: True ,
}
string ,
mnc:
{
Description: Mobile Network Code (MNC). ,
Required: True ,
}
string ,
}
,
serviceKey:
{
Description: The mobile network resource identifier ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MobileNetworks_CreateOrUpdate (removed)
Description :  Creates or updates a mobile network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update mobile network operation. ,
Required: True ,
}
{
properties:
{
Description: Mobile network properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the mobile network resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
publicLandMobileNetworkIdentifier:
{
Description: The unique public land mobile network identifier for the network. This is made up of the Mobile Country Code and Mobile Network Code, as defined in https://www.itu.int/rec/T-REC-E.212. The values 001-01 and 001-001 can be used for testing and the values 999-99 and 999-999 can be used on internal private networks. ,
Required: True ,
}
{
mcc:
{
Description: Mobile Country Code (MCC). ,
Required: True ,
}
string ,
mnc:
{
Description: Mobile Network Code (MNC). ,
Required: True ,
}
string ,
}
,
serviceKey:
{
Description: The mobile network resource identifier ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Mobile network properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the mobile network resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
publicLandMobileNetworkIdentifier:
{
Description: The unique public land mobile network identifier for the network. This is made up of the Mobile Country Code and Mobile Network Code, as defined in https://www.itu.int/rec/T-REC-E.212. The values 001-01 and 001-001 can be used for testing and the values 999-99 and 999-999 can be used on internal private networks. ,
Required: True ,
}
{
mcc:
{
Description: Mobile Country Code (MCC). ,
Required: True ,
}
string ,
mnc:
{
Description: Mobile Network Code (MNC). ,
Required: True ,
}
string ,
}
,
serviceKey:
{
Description: The mobile network resource identifier ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Mobile network properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the mobile network resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
publicLandMobileNetworkIdentifier:
{
Description: The unique public land mobile network identifier for the network. This is made up of the Mobile Country Code and Mobile Network Code, as defined in https://www.itu.int/rec/T-REC-E.212. The values 001-01 and 001-001 can be used for testing and the values 999-99 and 999-999 can be used on internal private networks. ,
Required: True ,
}
{
mcc:
{
Description: Mobile Country Code (MCC). ,
Required: True ,
}
string ,
mnc:
{
Description: Mobile Network Code (MNC). ,
Required: True ,
}
string ,
}
,
serviceKey:
{
Description: The mobile network resource identifier ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MobileNetworks_UpdateTags (removed)
Description :  Updates a mobile network update tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update mobile network tags. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Mobile network properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the mobile network resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
publicLandMobileNetworkIdentifier:
{
Description: The unique public land mobile network identifier for the network. This is made up of the Mobile Country Code and Mobile Network Code, as defined in https://www.itu.int/rec/T-REC-E.212. The values 001-01 and 001-001 can be used for testing and the values 999-99 and 999-999 can be used on internal private networks. ,
Required: True ,
}
{
mcc:
{
Description: Mobile Country Code (MCC). ,
Required: True ,
}
string ,
mnc:
{
Description: Mobile Network Code (MNC). ,
Required: True ,
}
string ,
}
,
serviceKey:
{
Description: The mobile network resource identifier ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MobileNetworks_ListBySubscription (removed)
Description :  Lists all the mobile networks in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MobileNetwork/mobileNetworks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of mobile networks in a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: Mobile network properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the mobile network resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
publicLandMobileNetworkIdentifier:
{
Description: The unique public land mobile network identifier for the network. This is made up of the Mobile Country Code and Mobile Network Code, as defined in https://www.itu.int/rec/T-REC-E.212. The values 001-01 and 001-001 can be used for testing and the values 999-99 and 999-999 can be used on internal private networks. ,
Required: True ,
}
{
mcc:
{
Description: Mobile Country Code (MCC). ,
Required: True ,
}
string ,
mnc:
{
Description: Mobile Network Code (MNC). ,
Required: True ,
}
string ,
}
,
serviceKey:
{
Description: The mobile network resource identifier ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MobileNetworks_ListByResourceGroup (removed)
Description :  Lists all the mobile networks in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of mobile networks in a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: Mobile network properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the mobile network resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
publicLandMobileNetworkIdentifier:
{
Description: The unique public land mobile network identifier for the network. This is made up of the Mobile Country Code and Mobile Network Code, as defined in https://www.itu.int/rec/T-REC-E.212. The values 001-01 and 001-001 can be used for testing and the values 999-99 and 999-999 can be used on internal private networks. ,
Required: True ,
}
{
mcc:
{
Description: Mobile Country Code (MCC). ,
Required: True ,
}
string ,
mnc:
{
Description: Mobile Network Code (MNC). ,
Required: True ,
}
string ,
}
,
serviceKey:
{
Description: The mobile network resource identifier ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MobileNetworks_ListSimIds (removed)
Description :  List sim ids under a mobile network.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/listSimIds
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of sim profile ids in a resource group. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
value:
{
Description: A list of sim profile ids in a resource group. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Sites_Delete (removed)
Description :  Deletes the specified mobile network site.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/sites/{siteName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
siteName:
{
Description: The name of the mobile network site. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Sites_Get (removed)
Description :  Gets information about the specified mobile network site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/sites/{siteName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
siteName:
{
Description: The name of the mobile network site. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Site properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the site resource. **TODO**: Confirm if this is needed ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
networkFunctions:
{
Description: An array of ids of the network functions deployed on the site, maintained by the user. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Sites_CreateOrUpdate (removed)
Description :  Creates or updates a mobile network site.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/sites/{siteName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
siteName:
{
Description: The name of the mobile network site. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update mobile network site operation. ,
Required: True ,
}
{
properties:
{
Description: Site properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the site resource. **TODO**: Confirm if this is needed ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
networkFunctions:
{
Description: An array of ids of the network functions deployed on the site, maintained by the user. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Site properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the site resource. **TODO**: Confirm if this is needed ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
networkFunctions:
{
Description: An array of ids of the network functions deployed on the site, maintained by the user. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Site properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the site resource. **TODO**: Confirm if this is needed ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
networkFunctions:
{
Description: An array of ids of the network functions deployed on the site, maintained by the user. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Sites_UpdateTags (removed)
Description :  Updates a site update tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/sites/{siteName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
siteName:
{
Description: The name of the mobile network site. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update network site tags. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Site properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the site resource. **TODO**: Confirm if this is needed ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
networkFunctions:
{
Description: An array of ids of the network functions deployed on the site, maintained by the user. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Sites_ListByMobileNetwork (removed)
Description :  Lists all sites in the mobile network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/sites
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of sites in a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: Site properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the site resource. **TODO**: Confirm if this is needed ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
networkFunctions:
{
Description: An array of ids of the network functions deployed on the site, maintained by the user. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Sims_Delete (removed)
Description :  Deletes the specified sim.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/sims/{simName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
simName:
{
Description: The name of the SIM. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Sims_Get (removed)
Description :  Gets information about the specified sim.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/sims/{simName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
simName:
{
Description: The name of the SIM. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Sim Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the sim resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
simState:
{
Description: The state of the sim resource. ,
Enum:
{
Disabled: The sim is disabled because not all configuration required for enabling is present. ,
Enabled: The sim is enabled. ,
Invalid: The sim cannot be enabled because some of the associated configuration is invalid. ,
}
,
Required: False ,
}
enum ,
internationalMobileSubscriberIdentity:
{
Description: The International Mobile Subscriber Identity (IMSI) for the sim. ,
Required: True ,
}
string ,
integratedCircuitCardIdentifier:
{
Description: The Integrated Circuit Card ID (ICC Id) for the sim. ,
Required: False ,
}
string ,
authenticationKey:
{
Description: The ki value for the sim. ,
Required: False ,
}
string ,
operatorKeyCode:
{
Description: The Opc value for the sim. ,
Required: False ,
}
string ,
mobileNetwork:
{
Description: Mobile network that this sim belongs to ,
Required: False ,
}
{
id:
{
Description: Mobile Network resource ID. ,
Required: True ,
}
string ,
}
,
deviceType:
{
Description: An optional free-form text field that can be used to record the device type this sim is associated with, for example 'Video camera'. The Azure portal allows Sims to be grouped and filtered based on this value. ,
Required: False ,
}
string ,
simPolicy:
{
Description: The simPolicy used by this sim. ,
Required: False ,
}
{
id:
{
Description: SIM Policy resource ID. ,
Required: True ,
}
string ,
}
,
staticIpConfiguration:
{
Description: A list of static IP addresses assigned to this sim. Each address is assigned at a defined network scope, made up of {attached data network, slice}. ,
Required: False ,
}
[
{
attachedDataNetwork:
{
Description: The attached data network on which the static IP address will be used. The combination of attachedDataNetwork and slice defines the network scope of the IP address. ,
Required: False ,
}
{
id:
{
Description: Attached Data Network resource ID. ,
Required: True ,
}
string ,
}
,
slice:
{
Description: The network slice on which the static IP address will be used. The combination of attachedDataNetwork and slice defines the network scope of the IP address. ,
Required: False ,
}
{
id:
{
Description: Slice resource ID. ,
Required: True ,
}
string ,
}
,
staticIp:
{
Description: The static IP configuration for the sim to use at the defined network scope. ,
Required: False ,
}
{
ipv4Address:
{
Description: The IPv4 address assigned to the sim at this network scope. This address must be in the userEquipmentStaticAddressPoolPrefix defined in the attachedDataNetwork. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Sims_CreateOrUpdate (removed)
Description :  Creates or updates a Sim.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/sims/{simName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
simName:
{
Description: The name of the SIM. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update sim operation. ,
Required: True ,
}
{
properties:
{
Description: Sim Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the sim resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
simState:
{
Description: The state of the sim resource. ,
Enum:
{
Disabled: The sim is disabled because not all configuration required for enabling is present. ,
Enabled: The sim is enabled. ,
Invalid: The sim cannot be enabled because some of the associated configuration is invalid. ,
}
,
Required: False ,
}
enum ,
internationalMobileSubscriberIdentity:
{
Description: The International Mobile Subscriber Identity (IMSI) for the sim. ,
Required: True ,
}
string ,
integratedCircuitCardIdentifier:
{
Description: The Integrated Circuit Card ID (ICC Id) for the sim. ,
Required: False ,
}
string ,
authenticationKey:
{
Description: The ki value for the sim. ,
Required: False ,
}
string ,
operatorKeyCode:
{
Description: The Opc value for the sim. ,
Required: False ,
}
string ,
mobileNetwork:
{
Description: Mobile network that this sim belongs to ,
Required: False ,
}
{
id:
{
Description: Mobile Network resource ID. ,
Required: True ,
}
string ,
}
,
deviceType:
{
Description: An optional free-form text field that can be used to record the device type this sim is associated with, for example 'Video camera'. The Azure portal allows Sims to be grouped and filtered based on this value. ,
Required: False ,
}
string ,
simPolicy:
{
Description: The simPolicy used by this sim. ,
Required: False ,
}
{
id:
{
Description: SIM Policy resource ID. ,
Required: True ,
}
string ,
}
,
staticIpConfiguration:
{
Description: A list of static IP addresses assigned to this sim. Each address is assigned at a defined network scope, made up of {attached data network, slice}. ,
Required: False ,
}
[
{
attachedDataNetwork:
{
Description: The attached data network on which the static IP address will be used. The combination of attachedDataNetwork and slice defines the network scope of the IP address. ,
Required: False ,
}
{
id:
{
Description: Attached Data Network resource ID. ,
Required: True ,
}
string ,
}
,
slice:
{
Description: The network slice on which the static IP address will be used. The combination of attachedDataNetwork and slice defines the network scope of the IP address. ,
Required: False ,
}
{
id:
{
Description: Slice resource ID. ,
Required: True ,
}
string ,
}
,
staticIp:
{
Description: The static IP configuration for the sim to use at the defined network scope. ,
Required: False ,
}
{
ipv4Address:
{
Description: The IPv4 address assigned to the sim at this network scope. This address must be in the userEquipmentStaticAddressPoolPrefix defined in the attachedDataNetwork. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Sim Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the sim resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
simState:
{
Description: The state of the sim resource. ,
Enum:
{
Disabled: The sim is disabled because not all configuration required for enabling is present. ,
Enabled: The sim is enabled. ,
Invalid: The sim cannot be enabled because some of the associated configuration is invalid. ,
}
,
Required: False ,
}
enum ,
internationalMobileSubscriberIdentity:
{
Description: The International Mobile Subscriber Identity (IMSI) for the sim. ,
Required: True ,
}
string ,
integratedCircuitCardIdentifier:
{
Description: The Integrated Circuit Card ID (ICC Id) for the sim. ,
Required: False ,
}
string ,
authenticationKey:
{
Description: The ki value for the sim. ,
Required: False ,
}
string ,
operatorKeyCode:
{
Description: The Opc value for the sim. ,
Required: False ,
}
string ,
mobileNetwork:
{
Description: Mobile network that this sim belongs to ,
Required: False ,
}
{
id:
{
Description: Mobile Network resource ID. ,
Required: True ,
}
string ,
}
,
deviceType:
{
Description: An optional free-form text field that can be used to record the device type this sim is associated with, for example 'Video camera'. The Azure portal allows Sims to be grouped and filtered based on this value. ,
Required: False ,
}
string ,
simPolicy:
{
Description: The simPolicy used by this sim. ,
Required: False ,
}
{
id:
{
Description: SIM Policy resource ID. ,
Required: True ,
}
string ,
}
,
staticIpConfiguration:
{
Description: A list of static IP addresses assigned to this sim. Each address is assigned at a defined network scope, made up of {attached data network, slice}. ,
Required: False ,
}
[
{
attachedDataNetwork:
{
Description: The attached data network on which the static IP address will be used. The combination of attachedDataNetwork and slice defines the network scope of the IP address. ,
Required: False ,
}
{
id:
{
Description: Attached Data Network resource ID. ,
Required: True ,
}
string ,
}
,
slice:
{
Description: The network slice on which the static IP address will be used. The combination of attachedDataNetwork and slice defines the network scope of the IP address. ,
Required: False ,
}
{
id:
{
Description: Slice resource ID. ,
Required: True ,
}
string ,
}
,
staticIp:
{
Description: The static IP configuration for the sim to use at the defined network scope. ,
Required: False ,
}
{
ipv4Address:
{
Description: The IPv4 address assigned to the sim at this network scope. This address must be in the userEquipmentStaticAddressPoolPrefix defined in the attachedDataNetwork. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Sim Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the sim resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
simState:
{
Description: The state of the sim resource. ,
Enum:
{
Disabled: The sim is disabled because not all configuration required for enabling is present. ,
Enabled: The sim is enabled. ,
Invalid: The sim cannot be enabled because some of the associated configuration is invalid. ,
}
,
Required: False ,
}
enum ,
internationalMobileSubscriberIdentity:
{
Description: The International Mobile Subscriber Identity (IMSI) for the sim. ,
Required: True ,
}
string ,
integratedCircuitCardIdentifier:
{
Description: The Integrated Circuit Card ID (ICC Id) for the sim. ,
Required: False ,
}
string ,
authenticationKey:
{
Description: The ki value for the sim. ,
Required: False ,
}
string ,
operatorKeyCode:
{
Description: The Opc value for the sim. ,
Required: False ,
}
string ,
mobileNetwork:
{
Description: Mobile network that this sim belongs to ,
Required: False ,
}
{
id:
{
Description: Mobile Network resource ID. ,
Required: True ,
}
string ,
}
,
deviceType:
{
Description: An optional free-form text field that can be used to record the device type this sim is associated with, for example 'Video camera'. The Azure portal allows Sims to be grouped and filtered based on this value. ,
Required: False ,
}
string ,
simPolicy:
{
Description: The simPolicy used by this sim. ,
Required: False ,
}
{
id:
{
Description: SIM Policy resource ID. ,
Required: True ,
}
string ,
}
,
staticIpConfiguration:
{
Description: A list of static IP addresses assigned to this sim. Each address is assigned at a defined network scope, made up of {attached data network, slice}. ,
Required: False ,
}
[
{
attachedDataNetwork:
{
Description: The attached data network on which the static IP address will be used. The combination of attachedDataNetwork and slice defines the network scope of the IP address. ,
Required: False ,
}
{
id:
{
Description: Attached Data Network resource ID. ,
Required: True ,
}
string ,
}
,
slice:
{
Description: The network slice on which the static IP address will be used. The combination of attachedDataNetwork and slice defines the network scope of the IP address. ,
Required: False ,
}
{
id:
{
Description: Slice resource ID. ,
Required: True ,
}
string ,
}
,
staticIp:
{
Description: The static IP configuration for the sim to use at the defined network scope. ,
Required: False ,
}
{
ipv4Address:
{
Description: The IPv4 address assigned to the sim at this network scope. This address must be in the userEquipmentStaticAddressPoolPrefix defined in the attachedDataNetwork. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Sims_UpdateTags (removed)
Description :  Updates a sim update tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/sims/{simName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
simName:
{
Description: The name of the SIM. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update sim tags. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Sim Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the sim resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
simState:
{
Description: The state of the sim resource. ,
Enum:
{
Disabled: The sim is disabled because not all configuration required for enabling is present. ,
Enabled: The sim is enabled. ,
Invalid: The sim cannot be enabled because some of the associated configuration is invalid. ,
}
,
Required: False ,
}
enum ,
internationalMobileSubscriberIdentity:
{
Description: The International Mobile Subscriber Identity (IMSI) for the sim. ,
Required: True ,
}
string ,
integratedCircuitCardIdentifier:
{
Description: The Integrated Circuit Card ID (ICC Id) for the sim. ,
Required: False ,
}
string ,
authenticationKey:
{
Description: The ki value for the sim. ,
Required: False ,
}
string ,
operatorKeyCode:
{
Description: The Opc value for the sim. ,
Required: False ,
}
string ,
mobileNetwork:
{
Description: Mobile network that this sim belongs to ,
Required: False ,
}
{
id:
{
Description: Mobile Network resource ID. ,
Required: True ,
}
string ,
}
,
deviceType:
{
Description: An optional free-form text field that can be used to record the device type this sim is associated with, for example 'Video camera'. The Azure portal allows Sims to be grouped and filtered based on this value. ,
Required: False ,
}
string ,
simPolicy:
{
Description: The simPolicy used by this sim. ,
Required: False ,
}
{
id:
{
Description: SIM Policy resource ID. ,
Required: True ,
}
string ,
}
,
staticIpConfiguration:
{
Description: A list of static IP addresses assigned to this sim. Each address is assigned at a defined network scope, made up of {attached data network, slice}. ,
Required: False ,
}
[
{
attachedDataNetwork:
{
Description: The attached data network on which the static IP address will be used. The combination of attachedDataNetwork and slice defines the network scope of the IP address. ,
Required: False ,
}
{
id:
{
Description: Attached Data Network resource ID. ,
Required: True ,
}
string ,
}
,
slice:
{
Description: The network slice on which the static IP address will be used. The combination of attachedDataNetwork and slice defines the network scope of the IP address. ,
Required: False ,
}
{
id:
{
Description: Slice resource ID. ,
Required: True ,
}
string ,
}
,
staticIp:
{
Description: The static IP configuration for the sim to use at the defined network scope. ,
Required: False ,
}
{
ipv4Address:
{
Description: The IPv4 address assigned to the sim at this network scope. This address must be in the userEquipmentStaticAddressPoolPrefix defined in the attachedDataNetwork. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Sims_ListBySubscription (removed)
Description :  Gets all the sims in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MobileNetwork/sims
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Sims in a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: Sim Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the sim resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
simState:
{
Description: The state of the sim resource. ,
Enum:
{
Disabled: The sim is disabled because not all configuration required for enabling is present. ,
Enabled: The sim is enabled. ,
Invalid: The sim cannot be enabled because some of the associated configuration is invalid. ,
}
,
Required: False ,
}
enum ,
internationalMobileSubscriberIdentity:
{
Description: The International Mobile Subscriber Identity (IMSI) for the sim. ,
Required: True ,
}
string ,
integratedCircuitCardIdentifier:
{
Description: The Integrated Circuit Card ID (ICC Id) for the sim. ,
Required: False ,
}
string ,
authenticationKey:
{
Description: The ki value for the sim. ,
Required: False ,
}
string ,
operatorKeyCode:
{
Description: The Opc value for the sim. ,
Required: False ,
}
string ,
mobileNetwork:
{
Description: Mobile network that this sim belongs to ,
Required: False ,
}
{
id:
{
Description: Mobile Network resource ID. ,
Required: True ,
}
string ,
}
,
deviceType:
{
Description: An optional free-form text field that can be used to record the device type this sim is associated with, for example 'Video camera'. The Azure portal allows Sims to be grouped and filtered based on this value. ,
Required: False ,
}
string ,
simPolicy:
{
Description: The simPolicy used by this sim. ,
Required: False ,
}
{
id:
{
Description: SIM Policy resource ID. ,
Required: True ,
}
string ,
}
,
staticIpConfiguration:
{
Description: A list of static IP addresses assigned to this sim. Each address is assigned at a defined network scope, made up of {attached data network, slice}. ,
Required: False ,
}
[
{
attachedDataNetwork:
{
Description: The attached data network on which the static IP address will be used. The combination of attachedDataNetwork and slice defines the network scope of the IP address. ,
Required: False ,
}
{
id:
{
Description: Attached Data Network resource ID. ,
Required: True ,
}
string ,
}
,
slice:
{
Description: The network slice on which the static IP address will be used. The combination of attachedDataNetwork and slice defines the network scope of the IP address. ,
Required: False ,
}
{
id:
{
Description: Slice resource ID. ,
Required: True ,
}
string ,
}
,
staticIp:
{
Description: The static IP configuration for the sim to use at the defined network scope. ,
Required: False ,
}
{
ipv4Address:
{
Description: The IPv4 address assigned to the sim at this network scope. This address must be in the userEquipmentStaticAddressPoolPrefix defined in the attachedDataNetwork. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Sims_ListByResourceGroup (removed)
Description :  Gets all the Sims in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/sims
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Sims in a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: Sim Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the sim resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
simState:
{
Description: The state of the sim resource. ,
Enum:
{
Disabled: The sim is disabled because not all configuration required for enabling is present. ,
Enabled: The sim is enabled. ,
Invalid: The sim cannot be enabled because some of the associated configuration is invalid. ,
}
,
Required: False ,
}
enum ,
internationalMobileSubscriberIdentity:
{
Description: The International Mobile Subscriber Identity (IMSI) for the sim. ,
Required: True ,
}
string ,
integratedCircuitCardIdentifier:
{
Description: The Integrated Circuit Card ID (ICC Id) for the sim. ,
Required: False ,
}
string ,
authenticationKey:
{
Description: The ki value for the sim. ,
Required: False ,
}
string ,
operatorKeyCode:
{
Description: The Opc value for the sim. ,
Required: False ,
}
string ,
mobileNetwork:
{
Description: Mobile network that this sim belongs to ,
Required: False ,
}
{
id:
{
Description: Mobile Network resource ID. ,
Required: True ,
}
string ,
}
,
deviceType:
{
Description: An optional free-form text field that can be used to record the device type this sim is associated with, for example 'Video camera'. The Azure portal allows Sims to be grouped and filtered based on this value. ,
Required: False ,
}
string ,
simPolicy:
{
Description: The simPolicy used by this sim. ,
Required: False ,
}
{
id:
{
Description: SIM Policy resource ID. ,
Required: True ,
}
string ,
}
,
staticIpConfiguration:
{
Description: A list of static IP addresses assigned to this sim. Each address is assigned at a defined network scope, made up of {attached data network, slice}. ,
Required: False ,
}
[
{
attachedDataNetwork:
{
Description: The attached data network on which the static IP address will be used. The combination of attachedDataNetwork and slice defines the network scope of the IP address. ,
Required: False ,
}
{
id:
{
Description: Attached Data Network resource ID. ,
Required: True ,
}
string ,
}
,
slice:
{
Description: The network slice on which the static IP address will be used. The combination of attachedDataNetwork and slice defines the network scope of the IP address. ,
Required: False ,
}
{
id:
{
Description: Slice resource ID. ,
Required: True ,
}
string ,
}
,
staticIp:
{
Description: The static IP configuration for the sim to use at the defined network scope. ,
Required: False ,
}
{
ipv4Address:
{
Description: The IPv4 address assigned to the sim at this network scope. This address must be in the userEquipmentStaticAddressPoolPrefix defined in the attachedDataNetwork. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Gets a list of the operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.MobileNetwork/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Microsoft.MobileNetwork operations. ,
Required: False ,
}
[
{
isDataAction:
{
Description: Indicates whether the operation applies to data-plane. ,
Required: False ,
}
boolean ,
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.MobileNetwork ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Registration definition, registration assignment etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PacketCoreControlPlanes_Delete (removed)
Description :  Deletes the specified packet core control plane.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
packetCoreControlPlaneName:
{
Description: The name of the packet core control plane. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PacketCoreControlPlanes_Get (removed)
Description :  Gets information about the specified packet core control plane.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
packetCoreControlPlaneName:
{
Description: The name of the packet core control plane. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Packet core control plane Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet core control plane resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
mobileNetwork:
{
Description: Mobile network that this packet core control plane belongs to ,
Required: True ,
}
{
id:
{
Description: Mobile Network resource ID. ,
Required: True ,
}
string ,
}
,
customLocation:
{
Description: Azure ARC custom location where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure ARC custom location resource ID. ,
Required: True ,
}
string ,
}
,
coreNetworkTechnology:
{
Description: The core network technology generation. ,
Enum:
{
5GC: 5G core ,
EPC: EPC / 4G core ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the packet core software that is deployed. ,
Required: False ,
}
string ,
controlPlaneAccessInterface:
{
Description: The control plane interface on the access network. In 5G networks this is called as N2 interface whereas in 4G networks this is called as S1-MME interface. ,
Required: True ,
}
{
name:
{
Description: The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. ,
Required: True ,
}
string ,
ipv4Address:
{
Description: The IPv4 address. ,
Required: False ,
}
string ,
ipv4Subnet:
{
Description: The IPv4 subnet. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The default IPv4 gateway (router). ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PacketCoreControlPlanes_CreateOrUpdate (removed)
Description :  Creates or updates a PacketCoreControlPlane.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
packetCoreControlPlaneName:
{
Description: The name of the packet core control plane. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update packet core control plane operation. ,
Required: True ,
}
{
properties:
{
Description: Packet core control plane Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet core control plane resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
mobileNetwork:
{
Description: Mobile network that this packet core control plane belongs to ,
Required: True ,
}
{
id:
{
Description: Mobile Network resource ID. ,
Required: True ,
}
string ,
}
,
customLocation:
{
Description: Azure ARC custom location where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure ARC custom location resource ID. ,
Required: True ,
}
string ,
}
,
coreNetworkTechnology:
{
Description: The core network technology generation. ,
Enum:
{
5GC: 5G core ,
EPC: EPC / 4G core ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the packet core software that is deployed. ,
Required: False ,
}
string ,
controlPlaneAccessInterface:
{
Description: The control plane interface on the access network. In 5G networks this is called as N2 interface whereas in 4G networks this is called as S1-MME interface. ,
Required: True ,
}
{
name:
{
Description: The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. ,
Required: True ,
}
string ,
ipv4Address:
{
Description: The IPv4 address. ,
Required: False ,
}
string ,
ipv4Subnet:
{
Description: The IPv4 subnet. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The default IPv4 gateway (router). ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Packet core control plane Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet core control plane resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
mobileNetwork:
{
Description: Mobile network that this packet core control plane belongs to ,
Required: True ,
}
{
id:
{
Description: Mobile Network resource ID. ,
Required: True ,
}
string ,
}
,
customLocation:
{
Description: Azure ARC custom location where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure ARC custom location resource ID. ,
Required: True ,
}
string ,
}
,
coreNetworkTechnology:
{
Description: The core network technology generation. ,
Enum:
{
5GC: 5G core ,
EPC: EPC / 4G core ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the packet core software that is deployed. ,
Required: False ,
}
string ,
controlPlaneAccessInterface:
{
Description: The control plane interface on the access network. In 5G networks this is called as N2 interface whereas in 4G networks this is called as S1-MME interface. ,
Required: True ,
}
{
name:
{
Description: The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. ,
Required: True ,
}
string ,
ipv4Address:
{
Description: The IPv4 address. ,
Required: False ,
}
string ,
ipv4Subnet:
{
Description: The IPv4 subnet. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The default IPv4 gateway (router). ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Packet core control plane Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet core control plane resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
mobileNetwork:
{
Description: Mobile network that this packet core control plane belongs to ,
Required: True ,
}
{
id:
{
Description: Mobile Network resource ID. ,
Required: True ,
}
string ,
}
,
customLocation:
{
Description: Azure ARC custom location where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure ARC custom location resource ID. ,
Required: True ,
}
string ,
}
,
coreNetworkTechnology:
{
Description: The core network technology generation. ,
Enum:
{
5GC: 5G core ,
EPC: EPC / 4G core ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the packet core software that is deployed. ,
Required: False ,
}
string ,
controlPlaneAccessInterface:
{
Description: The control plane interface on the access network. In 5G networks this is called as N2 interface whereas in 4G networks this is called as S1-MME interface. ,
Required: True ,
}
{
name:
{
Description: The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. ,
Required: True ,
}
string ,
ipv4Address:
{
Description: The IPv4 address. ,
Required: False ,
}
string ,
ipv4Subnet:
{
Description: The IPv4 subnet. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The default IPv4 gateway (router). ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PacketCoreControlPlanes_UpdateTags (removed)
Description :  Updates a PacketCoreControlPlane update tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
packetCoreControlPlaneName:
{
Description: The name of the packet core control plane. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update PacketCoreControlPlane tags. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Packet core control plane Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet core control plane resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
mobileNetwork:
{
Description: Mobile network that this packet core control plane belongs to ,
Required: True ,
}
{
id:
{
Description: Mobile Network resource ID. ,
Required: True ,
}
string ,
}
,
customLocation:
{
Description: Azure ARC custom location where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure ARC custom location resource ID. ,
Required: True ,
}
string ,
}
,
coreNetworkTechnology:
{
Description: The core network technology generation. ,
Enum:
{
5GC: 5G core ,
EPC: EPC / 4G core ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the packet core software that is deployed. ,
Required: False ,
}
string ,
controlPlaneAccessInterface:
{
Description: The control plane interface on the access network. In 5G networks this is called as N2 interface whereas in 4G networks this is called as S1-MME interface. ,
Required: True ,
}
{
name:
{
Description: The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. ,
Required: True ,
}
string ,
ipv4Address:
{
Description: The IPv4 address. ,
Required: False ,
}
string ,
ipv4Subnet:
{
Description: The IPv4 subnet. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The default IPv4 gateway (router). ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PacketCoreControlPlanes_ListBySubscription (removed)
Description :  Lists all the packetCoreControlPlanes in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of packet core control planes in a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: Packet core control plane Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet core control plane resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
mobileNetwork:
{
Description: Mobile network that this packet core control plane belongs to ,
Required: True ,
}
{
id:
{
Description: Mobile Network resource ID. ,
Required: True ,
}
string ,
}
,
customLocation:
{
Description: Azure ARC custom location where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure ARC custom location resource ID. ,
Required: True ,
}
string ,
}
,
coreNetworkTechnology:
{
Description: The core network technology generation. ,
Enum:
{
5GC: 5G core ,
EPC: EPC / 4G core ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the packet core software that is deployed. ,
Required: False ,
}
string ,
controlPlaneAccessInterface:
{
Description: The control plane interface on the access network. In 5G networks this is called as N2 interface whereas in 4G networks this is called as S1-MME interface. ,
Required: True ,
}
{
name:
{
Description: The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. ,
Required: True ,
}
string ,
ipv4Address:
{
Description: The IPv4 address. ,
Required: False ,
}
string ,
ipv4Subnet:
{
Description: The IPv4 subnet. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The default IPv4 gateway (router). ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PacketCoreControlPlanes_ListByResourceGroup (removed)
Description :  Lists all the packetCoreControlPlanes in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of packet core control planes in a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: Packet core control plane Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet core control plane resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
mobileNetwork:
{
Description: Mobile network that this packet core control plane belongs to ,
Required: True ,
}
{
id:
{
Description: Mobile Network resource ID. ,
Required: True ,
}
string ,
}
,
customLocation:
{
Description: Azure ARC custom location where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure ARC custom location resource ID. ,
Required: True ,
}
string ,
}
,
coreNetworkTechnology:
{
Description: The core network technology generation. ,
Enum:
{
5GC: 5G core ,
EPC: EPC / 4G core ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the packet core software that is deployed. ,
Required: False ,
}
string ,
controlPlaneAccessInterface:
{
Description: The control plane interface on the access network. In 5G networks this is called as N2 interface whereas in 4G networks this is called as S1-MME interface. ,
Required: True ,
}
{
name:
{
Description: The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. ,
Required: True ,
}
string ,
ipv4Address:
{
Description: The IPv4 address. ,
Required: False ,
}
string ,
ipv4Subnet:
{
Description: The IPv4 subnet. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The default IPv4 gateway (router). ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PacketCoreDataPlanes_Delete (removed)
Description :  Deletes the specified packet core data plane.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCoreDataPlanes/{packetCoreDataPlaneName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
packetCoreControlPlaneName:
{
Description: The name of the packet core control plane. ,
Required: True ,
}
string ,
packetCoreDataPlaneName:
{
Description: The name of the packet core data plane. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PacketCoreDataPlanes_Get (removed)
Description :  Gets information about the specified packet core data plane.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCoreDataPlanes/{packetCoreDataPlaneName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
packetCoreControlPlaneName:
{
Description: The name of the packet core control plane. ,
Required: True ,
}
string ,
packetCoreDataPlaneName:
{
Description: The name of the packet core data plane. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Packet core data plane Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet core data plane resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
userPlaneAccessInterface:
{
Description: The user plane interface on the access network. In 5G networks this is called as N3 interface whereas in 4G networks this is called the S1-U interface. ,
Required: True ,
}
{
name:
{
Description: The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. ,
Required: True ,
}
string ,
ipv4Address:
{
Description: The IPv4 address. ,
Required: False ,
}
string ,
ipv4Subnet:
{
Description: The IPv4 subnet. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The default IPv4 gateway (router). ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PacketCoreDataPlanes_CreateOrUpdate (removed)
Description :  Creates or updates a PacketCoreDataPlane.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCoreDataPlanes/{packetCoreDataPlaneName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
packetCoreControlPlaneName:
{
Description: The name of the packet core control plane. ,
Required: True ,
}
string ,
packetCoreDataPlaneName:
{
Description: The name of the packet core data plane. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update packet core data plane operation. ,
Required: True ,
}
{
properties:
{
Description: Packet core data plane Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet core data plane resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
userPlaneAccessInterface:
{
Description: The user plane interface on the access network. In 5G networks this is called as N3 interface whereas in 4G networks this is called the S1-U interface. ,
Required: True ,
}
{
name:
{
Description: The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. ,
Required: True ,
}
string ,
ipv4Address:
{
Description: The IPv4 address. ,
Required: False ,
}
string ,
ipv4Subnet:
{
Description: The IPv4 subnet. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The default IPv4 gateway (router). ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Packet core data plane Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet core data plane resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
userPlaneAccessInterface:
{
Description: The user plane interface on the access network. In 5G networks this is called as N3 interface whereas in 4G networks this is called the S1-U interface. ,
Required: True ,
}
{
name:
{
Description: The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. ,
Required: True ,
}
string ,
ipv4Address:
{
Description: The IPv4 address. ,
Required: False ,
}
string ,
ipv4Subnet:
{
Description: The IPv4 subnet. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The default IPv4 gateway (router). ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Packet core data plane Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet core data plane resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
userPlaneAccessInterface:
{
Description: The user plane interface on the access network. In 5G networks this is called as N3 interface whereas in 4G networks this is called the S1-U interface. ,
Required: True ,
}
{
name:
{
Description: The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. ,
Required: True ,
}
string ,
ipv4Address:
{
Description: The IPv4 address. ,
Required: False ,
}
string ,
ipv4Subnet:
{
Description: The IPv4 subnet. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The default IPv4 gateway (router). ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PacketCoreDataPlanes_UpdateTags (removed)
Description :  Updates a PacketCoreDataPlane update tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCoreDataPlanes/{packetCoreDataPlaneName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
packetCoreControlPlaneName:
{
Description: The name of the packet core control plane. ,
Required: True ,
}
string ,
packetCoreDataPlaneName:
{
Description: The name of the packet core data plane. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update PacketCoreDataPlane tags. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Packet core data plane Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet core data plane resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
userPlaneAccessInterface:
{
Description: The user plane interface on the access network. In 5G networks this is called as N3 interface whereas in 4G networks this is called the S1-U interface. ,
Required: True ,
}
{
name:
{
Description: The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. ,
Required: True ,
}
string ,
ipv4Address:
{
Description: The IPv4 address. ,
Required: False ,
}
string ,
ipv4Subnet:
{
Description: The IPv4 subnet. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The default IPv4 gateway (router). ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PacketCoreDataPlanes_ListByPacketCoreControlPlane (removed)
Description :  Lists all the packetCoreDataPlanes associated with a packetCoreControlPlane.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCoreDataPlanes
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
packetCoreControlPlaneName:
{
Description: The name of the packet core control plane. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of packet core data planes in a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: Packet core data plane Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet core data plane resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
userPlaneAccessInterface:
{
Description: The user plane interface on the access network. In 5G networks this is called as N3 interface whereas in 4G networks this is called the S1-U interface. ,
Required: True ,
}
{
name:
{
Description: The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. ,
Required: True ,
}
string ,
ipv4Address:
{
Description: The IPv4 address. ,
Required: False ,
}
string ,
ipv4Subnet:
{
Description: The IPv4 subnet. ,
Required: False ,
}
string ,
ipv4Gateway:
{
Description: The default IPv4 gateway (router). ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Services_Delete (removed)
Description :  Deletes the specified service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/services/{serviceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the service. You must not use any of the following reserved strings - `default`, `requested` or `service` ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Services_Get (removed)
Description :  Gets information about the specified service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/services/{serviceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the service. You must not use any of the following reserved strings - `default`, `requested` or `service` ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Service Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the service resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Format: int32 ,
Required: True ,
}
integer ,
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 simPolicy will define the QoS settings. ,
Required: False ,
}
{
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 selecting a GBR (Guaranteed Bit Rate) QoS. 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. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
Enum:
{
NotPreempt: Cannot preempt ,
MayPreempt: May preempt ,
}
,
Required: False ,
}
enum ,
preemptionVulnerability:
{
Description: QoS Flow preemption vulnerability. The Preemption Vulnerability of a QoS Flow controls whether it can be preempted by QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
Enum:
{
NotPreemptable: Cannot be preempted ,
Preemptable: May be preempted ,
}
,
Required: False ,
}
enum ,
maximumBitRate:
{
Description: The Maximum Bit Rate (MBR) for all service data flows that use this PCC Rule or Service. ,
Required: True ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
}
,
pccRules:
{
Description: The set of PCC Rules that make up this service. ,
Required: True ,
}
[
{
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`. ,
Required: True ,
}
string ,
rulePrecedence:
{
Description: A precedence value that is used to decide between PCC 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 PCC Rules configured in the Mobile Network. ,
Format: int32 ,
Required: True ,
}
integer ,
ruleQosPolicy:
{
Description: The QoS policy to use for packets matching this rule. If this field is null then the Service will define the QoS settings. ,
Required: False ,
}
{
guaranteedBitRate:
{
Description: The Guaranteed Bit Rate (GBR) for all service data flows that use this PCC Rule. This is an optional setting. If you do not provide a value, there will be no GBR set for the PCC Rule that uses this QoS definition. ,
Required: False ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
}
,
trafficControl:
{
Description: Determines whether flows that match this PCC Rule are permitted. ,
Enum:
{
Enabled: Traffic matching this rule is allowed to flow. ,
Blocked: Traffic matching this rule is not allowed to flow. ,
}
,
Required: False ,
}
enum ,
serviceDataFlowTemplates:
{
Description: The set of service data flow templates to use for this PCC Rule. ,
Required: True ,
}
[
{
templateName:
{
Description: The name of the SDF template. This must be unique within the parent PccRuleConfiguration. You must not use any of the following reserved strings - `default`, `requested` or `service`. ,
Required: True ,
}
string ,
direction:
{
Description: The direction of this flow. ,
Enum:
{
Uplink: Traffic flowing from the UE to the data network. ,
Downlink: Traffic flowing from the data network to the UE. ,
Bidirectional: Traffic flowing both to and from the UE. ,
}
,
Required: True ,
}
enum ,
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. ,
Required: True ,
}
[
string ,
]
,
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 Fusion Core will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). ,
Required: True ,
}
[
string ,
]
,
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 -. For example: [`8080`, `8082-8085`]. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Services_CreateOrUpdate (removed)
Description :  Creates or updates a Service.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/services/{serviceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the service. You must not use any of the following reserved strings - `default`, `requested` or `service` ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update service operation. ,
Required: True ,
}
{
properties:
{
Description: Service Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the service resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Format: int32 ,
Required: True ,
}
integer ,
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 simPolicy will define the QoS settings. ,
Required: False ,
}
{
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 selecting a GBR (Guaranteed Bit Rate) QoS. 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. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
Enum:
{
NotPreempt: Cannot preempt ,
MayPreempt: May preempt ,
}
,
Required: False ,
}
enum ,
preemptionVulnerability:
{
Description: QoS Flow preemption vulnerability. The Preemption Vulnerability of a QoS Flow controls whether it can be preempted by QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
Enum:
{
NotPreemptable: Cannot be preempted ,
Preemptable: May be preempted ,
}
,
Required: False ,
}
enum ,
maximumBitRate:
{
Description: The Maximum Bit Rate (MBR) for all service data flows that use this PCC Rule or Service. ,
Required: True ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
}
,
pccRules:
{
Description: The set of PCC Rules that make up this service. ,
Required: True ,
}
[
{
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`. ,
Required: True ,
}
string ,
rulePrecedence:
{
Description: A precedence value that is used to decide between PCC 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 PCC Rules configured in the Mobile Network. ,
Format: int32 ,
Required: True ,
}
integer ,
ruleQosPolicy:
{
Description: The QoS policy to use for packets matching this rule. If this field is null then the Service will define the QoS settings. ,
Required: False ,
}
{
guaranteedBitRate:
{
Description: The Guaranteed Bit Rate (GBR) for all service data flows that use this PCC Rule. This is an optional setting. If you do not provide a value, there will be no GBR set for the PCC Rule that uses this QoS definition. ,
Required: False ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
}
,
trafficControl:
{
Description: Determines whether flows that match this PCC Rule are permitted. ,
Enum:
{
Enabled: Traffic matching this rule is allowed to flow. ,
Blocked: Traffic matching this rule is not allowed to flow. ,
}
,
Required: False ,
}
enum ,
serviceDataFlowTemplates:
{
Description: The set of service data flow templates to use for this PCC Rule. ,
Required: True ,
}
[
{
templateName:
{
Description: The name of the SDF template. This must be unique within the parent PccRuleConfiguration. You must not use any of the following reserved strings - `default`, `requested` or `service`. ,
Required: True ,
}
string ,
direction:
{
Description: The direction of this flow. ,
Enum:
{
Uplink: Traffic flowing from the UE to the data network. ,
Downlink: Traffic flowing from the data network to the UE. ,
Bidirectional: Traffic flowing both to and from the UE. ,
}
,
Required: True ,
}
enum ,
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. ,
Required: True ,
}
[
string ,
]
,
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 Fusion Core will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). ,
Required: True ,
}
[
string ,
]
,
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 -. For example: [`8080`, `8082-8085`]. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Service Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the service resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Format: int32 ,
Required: True ,
}
integer ,
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 simPolicy will define the QoS settings. ,
Required: False ,
}
{
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 selecting a GBR (Guaranteed Bit Rate) QoS. 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. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
Enum:
{
NotPreempt: Cannot preempt ,
MayPreempt: May preempt ,
}
,
Required: False ,
}
enum ,
preemptionVulnerability:
{
Description: QoS Flow preemption vulnerability. The Preemption Vulnerability of a QoS Flow controls whether it can be preempted by QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
Enum:
{
NotPreemptable: Cannot be preempted ,
Preemptable: May be preempted ,
}
,
Required: False ,
}
enum ,
maximumBitRate:
{
Description: The Maximum Bit Rate (MBR) for all service data flows that use this PCC Rule or Service. ,
Required: True ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
}
,
pccRules:
{
Description: The set of PCC Rules that make up this service. ,
Required: True ,
}
[
{
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`. ,
Required: True ,
}
string ,
rulePrecedence:
{
Description: A precedence value that is used to decide between PCC 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 PCC Rules configured in the Mobile Network. ,
Format: int32 ,
Required: True ,
}
integer ,
ruleQosPolicy:
{
Description: The QoS policy to use for packets matching this rule. If this field is null then the Service will define the QoS settings. ,
Required: False ,
}
{
guaranteedBitRate:
{
Description: The Guaranteed Bit Rate (GBR) for all service data flows that use this PCC Rule. This is an optional setting. If you do not provide a value, there will be no GBR set for the PCC Rule that uses this QoS definition. ,
Required: False ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
}
,
trafficControl:
{
Description: Determines whether flows that match this PCC Rule are permitted. ,
Enum:
{
Enabled: Traffic matching this rule is allowed to flow. ,
Blocked: Traffic matching this rule is not allowed to flow. ,
}
,
Required: False ,
}
enum ,
serviceDataFlowTemplates:
{
Description: The set of service data flow templates to use for this PCC Rule. ,
Required: True ,
}
[
{
templateName:
{
Description: The name of the SDF template. This must be unique within the parent PccRuleConfiguration. You must not use any of the following reserved strings - `default`, `requested` or `service`. ,
Required: True ,
}
string ,
direction:
{
Description: The direction of this flow. ,
Enum:
{
Uplink: Traffic flowing from the UE to the data network. ,
Downlink: Traffic flowing from the data network to the UE. ,
Bidirectional: Traffic flowing both to and from the UE. ,
}
,
Required: True ,
}
enum ,
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. ,
Required: True ,
}
[
string ,
]
,
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 Fusion Core will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). ,
Required: True ,
}
[
string ,
]
,
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 -. For example: [`8080`, `8082-8085`]. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Service Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the service resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Format: int32 ,
Required: True ,
}
integer ,
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 simPolicy will define the QoS settings. ,
Required: False ,
}
{
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 selecting a GBR (Guaranteed Bit Rate) QoS. 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. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
Enum:
{
NotPreempt: Cannot preempt ,
MayPreempt: May preempt ,
}
,
Required: False ,
}
enum ,
preemptionVulnerability:
{
Description: QoS Flow preemption vulnerability. The Preemption Vulnerability of a QoS Flow controls whether it can be preempted by QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
Enum:
{
NotPreemptable: Cannot be preempted ,
Preemptable: May be preempted ,
}
,
Required: False ,
}
enum ,
maximumBitRate:
{
Description: The Maximum Bit Rate (MBR) for all service data flows that use this PCC Rule or Service. ,
Required: True ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
}
,
pccRules:
{
Description: The set of PCC Rules that make up this service. ,
Required: True ,
}
[
{
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`. ,
Required: True ,
}
string ,
rulePrecedence:
{
Description: A precedence value that is used to decide between PCC 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 PCC Rules configured in the Mobile Network. ,
Format: int32 ,
Required: True ,
}
integer ,
ruleQosPolicy:
{
Description: The QoS policy to use for packets matching this rule. If this field is null then the Service will define the QoS settings. ,
Required: False ,
}
{
guaranteedBitRate:
{
Description: The Guaranteed Bit Rate (GBR) for all service data flows that use this PCC Rule. This is an optional setting. If you do not provide a value, there will be no GBR set for the PCC Rule that uses this QoS definition. ,
Required: False ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
}
,
trafficControl:
{
Description: Determines whether flows that match this PCC Rule are permitted. ,
Enum:
{
Enabled: Traffic matching this rule is allowed to flow. ,
Blocked: Traffic matching this rule is not allowed to flow. ,
}
,
Required: False ,
}
enum ,
serviceDataFlowTemplates:
{
Description: The set of service data flow templates to use for this PCC Rule. ,
Required: True ,
}
[
{
templateName:
{
Description: The name of the SDF template. This must be unique within the parent PccRuleConfiguration. You must not use any of the following reserved strings - `default`, `requested` or `service`. ,
Required: True ,
}
string ,
direction:
{
Description: The direction of this flow. ,
Enum:
{
Uplink: Traffic flowing from the UE to the data network. ,
Downlink: Traffic flowing from the data network to the UE. ,
Bidirectional: Traffic flowing both to and from the UE. ,
}
,
Required: True ,
}
enum ,
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. ,
Required: True ,
}
[
string ,
]
,
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 Fusion Core will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). ,
Required: True ,
}
[
string ,
]
,
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 -. For example: [`8080`, `8082-8085`]. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Services_UpdateTags (removed)
Description :  Update service tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/services/{serviceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the service. You must not use any of the following reserved strings - `default`, `requested` or `service` ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update service tags. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Service Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the service resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Format: int32 ,
Required: True ,
}
integer ,
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 simPolicy will define the QoS settings. ,
Required: False ,
}
{
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 selecting a GBR (Guaranteed Bit Rate) QoS. 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. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
Enum:
{
NotPreempt: Cannot preempt ,
MayPreempt: May preempt ,
}
,
Required: False ,
}
enum ,
preemptionVulnerability:
{
Description: QoS Flow preemption vulnerability. The Preemption Vulnerability of a QoS Flow controls whether it can be preempted by QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
Enum:
{
NotPreemptable: Cannot be preempted ,
Preemptable: May be preempted ,
}
,
Required: False ,
}
enum ,
maximumBitRate:
{
Description: The Maximum Bit Rate (MBR) for all service data flows that use this PCC Rule or Service. ,
Required: True ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
}
,
pccRules:
{
Description: The set of PCC Rules that make up this service. ,
Required: True ,
}
[
{
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`. ,
Required: True ,
}
string ,
rulePrecedence:
{
Description: A precedence value that is used to decide between PCC 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 PCC Rules configured in the Mobile Network. ,
Format: int32 ,
Required: True ,
}
integer ,
ruleQosPolicy:
{
Description: The QoS policy to use for packets matching this rule. If this field is null then the Service will define the QoS settings. ,
Required: False ,
}
{
guaranteedBitRate:
{
Description: The Guaranteed Bit Rate (GBR) for all service data flows that use this PCC Rule. This is an optional setting. If you do not provide a value, there will be no GBR set for the PCC Rule that uses this QoS definition. ,
Required: False ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
}
,
trafficControl:
{
Description: Determines whether flows that match this PCC Rule are permitted. ,
Enum:
{
Enabled: Traffic matching this rule is allowed to flow. ,
Blocked: Traffic matching this rule is not allowed to flow. ,
}
,
Required: False ,
}
enum ,
serviceDataFlowTemplates:
{
Description: The set of service data flow templates to use for this PCC Rule. ,
Required: True ,
}
[
{
templateName:
{
Description: The name of the SDF template. This must be unique within the parent PccRuleConfiguration. You must not use any of the following reserved strings - `default`, `requested` or `service`. ,
Required: True ,
}
string ,
direction:
{
Description: The direction of this flow. ,
Enum:
{
Uplink: Traffic flowing from the UE to the data network. ,
Downlink: Traffic flowing from the data network to the UE. ,
Bidirectional: Traffic flowing both to and from the UE. ,
}
,
Required: True ,
}
enum ,
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. ,
Required: True ,
}
[
string ,
]
,
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 Fusion Core will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). ,
Required: True ,
}
[
string ,
]
,
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 -. For example: [`8080`, `8082-8085`]. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Services_ListByMobileNetwork (removed)
Description :  Gets all the services in a mobile network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/services
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Services. ,
Required: False ,
}
[
{
properties:
{
Description: Service Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the service resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Format: int32 ,
Required: True ,
}
integer ,
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 simPolicy will define the QoS settings. ,
Required: False ,
}
{
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 selecting a GBR (Guaranteed Bit Rate) QoS. 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. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
Enum:
{
NotPreempt: Cannot preempt ,
MayPreempt: May preempt ,
}
,
Required: False ,
}
enum ,
preemptionVulnerability:
{
Description: QoS Flow preemption vulnerability. The Preemption Vulnerability of a QoS Flow controls whether it can be preempted by QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
Enum:
{
NotPreemptable: Cannot be preempted ,
Preemptable: May be preempted ,
}
,
Required: False ,
}
enum ,
maximumBitRate:
{
Description: The Maximum Bit Rate (MBR) for all service data flows that use this PCC Rule or Service. ,
Required: True ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
}
,
pccRules:
{
Description: The set of PCC Rules that make up this service. ,
Required: True ,
}
[
{
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`. ,
Required: True ,
}
string ,
rulePrecedence:
{
Description: A precedence value that is used to decide between PCC 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 PCC Rules configured in the Mobile Network. ,
Format: int32 ,
Required: True ,
}
integer ,
ruleQosPolicy:
{
Description: The QoS policy to use for packets matching this rule. If this field is null then the Service will define the QoS settings. ,
Required: False ,
}
{
guaranteedBitRate:
{
Description: The Guaranteed Bit Rate (GBR) for all service data flows that use this PCC Rule. This is an optional setting. If you do not provide a value, there will be no GBR set for the PCC Rule that uses this QoS definition. ,
Required: False ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
}
,
trafficControl:
{
Description: Determines whether flows that match this PCC Rule are permitted. ,
Enum:
{
Enabled: Traffic matching this rule is allowed to flow. ,
Blocked: Traffic matching this rule is not allowed to flow. ,
}
,
Required: False ,
}
enum ,
serviceDataFlowTemplates:
{
Description: The set of service data flow templates to use for this PCC Rule. ,
Required: True ,
}
[
{
templateName:
{
Description: The name of the SDF template. This must be unique within the parent PccRuleConfiguration. You must not use any of the following reserved strings - `default`, `requested` or `service`. ,
Required: True ,
}
string ,
direction:
{
Description: The direction of this flow. ,
Enum:
{
Uplink: Traffic flowing from the UE to the data network. ,
Downlink: Traffic flowing from the data network to the UE. ,
Bidirectional: Traffic flowing both to and from the UE. ,
}
,
Required: True ,
}
enum ,
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. ,
Required: True ,
}
[
string ,
]
,
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 Fusion Core will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). ,
Required: True ,
}
[
string ,
]
,
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 -. For example: [`8080`, `8082-8085`]. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SimPolicies_Delete (removed)
Description :  Deletes the specified sim policy.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/simPolicies/{simPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
simPolicyName:
{
Description: The name of the SIM policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SimPolicies_Get (removed)
Description :  Gets information about the specified sim policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/simPolicies/{simPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
simPolicyName:
{
Description: The name of the SIM policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Sim policy Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the sim policy resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
ueAmbr:
{
Description: Aggregate maximum bit rate across all non-GBR QoS flows of all PDU sessions of a given UE. See 3GPP TS23.501 section 5.7.2.6 for a full description of the UE-AMBR. ,
Required: True ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
defaultSlice:
{
Description: The default slice to use if the UE does not explicitly specify it. This slice must exist in the `sliceConfigurations` map. ,
Required: True ,
}
{
id:
{
Description: Slice resource ID. ,
Required: True ,
}
string ,
}
,
rfspIndex:
{
Description: RAT/Frequency Selection Priority Index, defined in 3GPP TS 36.413. This is an optional setting and by default is unspecified. ,
Format: int32 ,
Required: False ,
}
integer ,
registrationTimer:
{
Description: Interval for the UE periodic registration update procedure, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
sliceConfigurations:
{
Description: The allowed slices and the settings to use for them. The list must not contain duplicate items and must contain at least one item. ,
Required: True ,
}
[
{
slice:
{
Description: A reference to the Slice that these settings apply to ,
Required: True ,
}
{
id:
{
Description: Slice resource ID. ,
Required: True ,
}
string ,
}
,
defaultDataNetwork:
{
Description: The default data network to use if the UE does not explicitly specify it. Configuration for this object must exist in the `dataNetworkConfigurations` map. ,
Required: True ,
}
{
id:
{
Description: Data Network resource ID. ,
Required: True ,
}
string ,
}
,
dataNetworkConfigurations:
{
Description: The allowed data networks and the settings to use for them. The list must not contain duplicate items and must contain at least one item. ,
Required: True ,
}
[
{
dataNetwork:
{
Description: A reference to the Data Network that these settings apply to ,
Required: True ,
}
{
id:
{
Description: Data Network resource ID. ,
Required: True ,
}
string ,
}
,
sessionAmbr:
{
Description: Aggregate maximum bit rate across all non-GBR QoS flows of a given PDU session. See 3GPP TS23.501 section 5.7.2.6 for a full description of the Session-AMBR. ,
Required: True ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
5qi:
{
Description: Default 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 selecting a GBR (Guaranteed Bit Rate) QoS. 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. ,
Format: int32 ,
Required: False ,
}
integer ,
allocationAndRetentionPriorityLevel:
{
Description: Default 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. ,
Format: int32 ,
Required: False ,
}
integer ,
preemptionCapability:
{
Description: Default 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. ,
Enum:
{
NotPreempt: Cannot preempt ,
MayPreempt: May preempt ,
}
,
Required: False ,
}
enum ,
preemptionVulnerability:
{
Description: Default QoS Flow preemption vulnerability. The Preemption Vulnerability of a QoS Flow controls whether it can be preempted by QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
Enum:
{
NotPreemptable: Cannot be preempted ,
Preemptable: May be preempted ,
}
,
Required: False ,
}
enum ,
defaultSessionType:
{
Description: The default PDU session type, which is used if the UE does not request a specific session type. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
additionalAllowedSessionTypes:
{
Description: Allowed session types in addition to the default session type. Must not duplicate the default session type. ,
Required: False ,
}
[
string ,
]
,
allowedServices:
{
Description: List of Services that can be used as part of this Sim Policy. The list must not contain duplicate items and must contain at least one item. ,
Required: True ,
}
[
{
id:
{
Description: Service resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SimPolicies_CreateOrUpdate (removed)
Description :  Creates or updates a SimPolicy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/simPolicies/{simPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
simPolicyName:
{
Description: The name of the SIM policy. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update sim policy operation. ,
Required: True ,
}
{
properties:
{
Description: Sim policy Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the sim policy resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
ueAmbr:
{
Description: Aggregate maximum bit rate across all non-GBR QoS flows of all PDU sessions of a given UE. See 3GPP TS23.501 section 5.7.2.6 for a full description of the UE-AMBR. ,
Required: True ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
defaultSlice:
{
Description: The default slice to use if the UE does not explicitly specify it. This slice must exist in the `sliceConfigurations` map. ,
Required: True ,
}
{
id:
{
Description: Slice resource ID. ,
Required: True ,
}
string ,
}
,
rfspIndex:
{
Description: RAT/Frequency Selection Priority Index, defined in 3GPP TS 36.413. This is an optional setting and by default is unspecified. ,
Format: int32 ,
Required: False ,
}
integer ,
registrationTimer:
{
Description: Interval for the UE periodic registration update procedure, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
sliceConfigurations:
{
Description: The allowed slices and the settings to use for them. The list must not contain duplicate items and must contain at least one item. ,
Required: True ,
}
[
{
slice:
{
Description: A reference to the Slice that these settings apply to ,
Required: True ,
}
{
id:
{
Description: Slice resource ID. ,
Required: True ,
}
string ,
}
,
defaultDataNetwork:
{
Description: The default data network to use if the UE does not explicitly specify it. Configuration for this object must exist in the `dataNetworkConfigurations` map. ,
Required: True ,
}
{
id:
{
Description: Data Network resource ID. ,
Required: True ,
}
string ,
}
,
dataNetworkConfigurations:
{
Description: The allowed data networks and the settings to use for them. The list must not contain duplicate items and must contain at least one item. ,
Required: True ,
}
[
{
dataNetwork:
{
Description: A reference to the Data Network that these settings apply to ,
Required: True ,
}
{
id:
{
Description: Data Network resource ID. ,
Required: True ,
}
string ,
}
,
sessionAmbr:
{
Description: Aggregate maximum bit rate across all non-GBR QoS flows of a given PDU session. See 3GPP TS23.501 section 5.7.2.6 for a full description of the Session-AMBR. ,
Required: True ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
5qi:
{
Description: Default 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 selecting a GBR (Guaranteed Bit Rate) QoS. 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. ,
Format: int32 ,
Required: False ,
}
integer ,
allocationAndRetentionPriorityLevel:
{
Description: Default 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. ,
Format: int32 ,
Required: False ,
}
integer ,
preemptionCapability:
{
Description: Default 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. ,
Enum:
{
NotPreempt: Cannot preempt ,
MayPreempt: May preempt ,
}
,
Required: False ,
}
enum ,
preemptionVulnerability:
{
Description: Default QoS Flow preemption vulnerability. The Preemption Vulnerability of a QoS Flow controls whether it can be preempted by QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
Enum:
{
NotPreemptable: Cannot be preempted ,
Preemptable: May be preempted ,
}
,
Required: False ,
}
enum ,
defaultSessionType:
{
Description: The default PDU session type, which is used if the UE does not request a specific session type. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
additionalAllowedSessionTypes:
{
Description: Allowed session types in addition to the default session type. Must not duplicate the default session type. ,
Required: False ,
}
[
string ,
]
,
allowedServices:
{
Description: List of Services that can be used as part of this Sim Policy. The list must not contain duplicate items and must contain at least one item. ,
Required: True ,
}
[
{
id:
{
Description: Service resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Sim policy Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the sim policy resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
ueAmbr:
{
Description: Aggregate maximum bit rate across all non-GBR QoS flows of all PDU sessions of a given UE. See 3GPP TS23.501 section 5.7.2.6 for a full description of the UE-AMBR. ,
Required: True ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
defaultSlice:
{
Description: The default slice to use if the UE does not explicitly specify it. This slice must exist in the `sliceConfigurations` map. ,
Required: True ,
}
{
id:
{
Description: Slice resource ID. ,
Required: True ,
}
string ,
}
,
rfspIndex:
{
Description: RAT/Frequency Selection Priority Index, defined in 3GPP TS 36.413. This is an optional setting and by default is unspecified. ,
Format: int32 ,
Required: False ,
}
integer ,
registrationTimer:
{
Description: Interval for the UE periodic registration update procedure, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
sliceConfigurations:
{
Description: The allowed slices and the settings to use for them. The list must not contain duplicate items and must contain at least one item. ,
Required: True ,
}
[
{
slice:
{
Description: A reference to the Slice that these settings apply to ,
Required: True ,
}
{
id:
{
Description: Slice resource ID. ,
Required: True ,
}
string ,
}
,
defaultDataNetwork:
{
Description: The default data network to use if the UE does not explicitly specify it. Configuration for this object must exist in the `dataNetworkConfigurations` map. ,
Required: True ,
}
{
id:
{
Description: Data Network resource ID. ,
Required: True ,
}
string ,
}
,
dataNetworkConfigurations:
{
Description: The allowed data networks and the settings to use for them. The list must not contain duplicate items and must contain at least one item. ,
Required: True ,
}
[
{
dataNetwork:
{
Description: A reference to the Data Network that these settings apply to ,
Required: True ,
}
{
id:
{
Description: Data Network resource ID. ,
Required: True ,
}
string ,
}
,
sessionAmbr:
{
Description: Aggregate maximum bit rate across all non-GBR QoS flows of a given PDU session. See 3GPP TS23.501 section 5.7.2.6 for a full description of the Session-AMBR. ,
Required: True ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
5qi:
{
Description: Default 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 selecting a GBR (Guaranteed Bit Rate) QoS. 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. ,
Format: int32 ,
Required: False ,
}
integer ,
allocationAndRetentionPriorityLevel:
{
Description: Default 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. ,
Format: int32 ,
Required: False ,
}
integer ,
preemptionCapability:
{
Description: Default 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. ,
Enum:
{
NotPreempt: Cannot preempt ,
MayPreempt: May preempt ,
}
,
Required: False ,
}
enum ,
preemptionVulnerability:
{
Description: Default QoS Flow preemption vulnerability. The Preemption Vulnerability of a QoS Flow controls whether it can be preempted by QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
Enum:
{
NotPreemptable: Cannot be preempted ,
Preemptable: May be preempted ,
}
,
Required: False ,
}
enum ,
defaultSessionType:
{
Description: The default PDU session type, which is used if the UE does not request a specific session type. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
additionalAllowedSessionTypes:
{
Description: Allowed session types in addition to the default session type. Must not duplicate the default session type. ,
Required: False ,
}
[
string ,
]
,
allowedServices:
{
Description: List of Services that can be used as part of this Sim Policy. The list must not contain duplicate items and must contain at least one item. ,
Required: True ,
}
[
{
id:
{
Description: Service resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Sim policy Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the sim policy resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
ueAmbr:
{
Description: Aggregate maximum bit rate across all non-GBR QoS flows of all PDU sessions of a given UE. See 3GPP TS23.501 section 5.7.2.6 for a full description of the UE-AMBR. ,
Required: True ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
defaultSlice:
{
Description: The default slice to use if the UE does not explicitly specify it. This slice must exist in the `sliceConfigurations` map. ,
Required: True ,
}
{
id:
{
Description: Slice resource ID. ,
Required: True ,
}
string ,
}
,
rfspIndex:
{
Description: RAT/Frequency Selection Priority Index, defined in 3GPP TS 36.413. This is an optional setting and by default is unspecified. ,
Format: int32 ,
Required: False ,
}
integer ,
registrationTimer:
{
Description: Interval for the UE periodic registration update procedure, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
sliceConfigurations:
{
Description: The allowed slices and the settings to use for them. The list must not contain duplicate items and must contain at least one item. ,
Required: True ,
}
[
{
slice:
{
Description: A reference to the Slice that these settings apply to ,
Required: True ,
}
{
id:
{
Description: Slice resource ID. ,
Required: True ,
}
string ,
}
,
defaultDataNetwork:
{
Description: The default data network to use if the UE does not explicitly specify it. Configuration for this object must exist in the `dataNetworkConfigurations` map. ,
Required: True ,
}
{
id:
{
Description: Data Network resource ID. ,
Required: True ,
}
string ,
}
,
dataNetworkConfigurations:
{
Description: The allowed data networks and the settings to use for them. The list must not contain duplicate items and must contain at least one item. ,
Required: True ,
}
[
{
dataNetwork:
{
Description: A reference to the Data Network that these settings apply to ,
Required: True ,
}
{
id:
{
Description: Data Network resource ID. ,
Required: True ,
}
string ,
}
,
sessionAmbr:
{
Description: Aggregate maximum bit rate across all non-GBR QoS flows of a given PDU session. See 3GPP TS23.501 section 5.7.2.6 for a full description of the Session-AMBR. ,
Required: True ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
5qi:
{
Description: Default 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 selecting a GBR (Guaranteed Bit Rate) QoS. 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. ,
Format: int32 ,
Required: False ,
}
integer ,
allocationAndRetentionPriorityLevel:
{
Description: Default 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. ,
Format: int32 ,
Required: False ,
}
integer ,
preemptionCapability:
{
Description: Default 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. ,
Enum:
{
NotPreempt: Cannot preempt ,
MayPreempt: May preempt ,
}
,
Required: False ,
}
enum ,
preemptionVulnerability:
{
Description: Default QoS Flow preemption vulnerability. The Preemption Vulnerability of a QoS Flow controls whether it can be preempted by QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
Enum:
{
NotPreemptable: Cannot be preempted ,
Preemptable: May be preempted ,
}
,
Required: False ,
}
enum ,
defaultSessionType:
{
Description: The default PDU session type, which is used if the UE does not request a specific session type. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
additionalAllowedSessionTypes:
{
Description: Allowed session types in addition to the default session type. Must not duplicate the default session type. ,
Required: False ,
}
[
string ,
]
,
allowedServices:
{
Description: List of Services that can be used as part of this Sim Policy. The list must not contain duplicate items and must contain at least one item. ,
Required: True ,
}
[
{
id:
{
Description: Service resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SimPolicies_UpdateTags (removed)
Description :  Update sim policy tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/simPolicies/{simPolicyName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
simPolicyName:
{
Description: The name of the SIM policy. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update Sim Policy tags. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Sim policy Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the sim policy resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
ueAmbr:
{
Description: Aggregate maximum bit rate across all non-GBR QoS flows of all PDU sessions of a given UE. See 3GPP TS23.501 section 5.7.2.6 for a full description of the UE-AMBR. ,
Required: True ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
defaultSlice:
{
Description: The default slice to use if the UE does not explicitly specify it. This slice must exist in the `sliceConfigurations` map. ,
Required: True ,
}
{
id:
{
Description: Slice resource ID. ,
Required: True ,
}
string ,
}
,
rfspIndex:
{
Description: RAT/Frequency Selection Priority Index, defined in 3GPP TS 36.413. This is an optional setting and by default is unspecified. ,
Format: int32 ,
Required: False ,
}
integer ,
registrationTimer:
{
Description: Interval for the UE periodic registration update procedure, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
sliceConfigurations:
{
Description: The allowed slices and the settings to use for them. The list must not contain duplicate items and must contain at least one item. ,
Required: True ,
}
[
{
slice:
{
Description: A reference to the Slice that these settings apply to ,
Required: True ,
}
{
id:
{
Description: Slice resource ID. ,
Required: True ,
}
string ,
}
,
defaultDataNetwork:
{
Description: The default data network to use if the UE does not explicitly specify it. Configuration for this object must exist in the `dataNetworkConfigurations` map. ,
Required: True ,
}
{
id:
{
Description: Data Network resource ID. ,
Required: True ,
}
string ,
}
,
dataNetworkConfigurations:
{
Description: The allowed data networks and the settings to use for them. The list must not contain duplicate items and must contain at least one item. ,
Required: True ,
}
[
{
dataNetwork:
{
Description: A reference to the Data Network that these settings apply to ,
Required: True ,
}
{
id:
{
Description: Data Network resource ID. ,
Required: True ,
}
string ,
}
,
sessionAmbr:
{
Description: Aggregate maximum bit rate across all non-GBR QoS flows of a given PDU session. See 3GPP TS23.501 section 5.7.2.6 for a full description of the Session-AMBR. ,
Required: True ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
5qi:
{
Description: Default 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 selecting a GBR (Guaranteed Bit Rate) QoS. 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. ,
Format: int32 ,
Required: False ,
}
integer ,
allocationAndRetentionPriorityLevel:
{
Description: Default 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. ,
Format: int32 ,
Required: False ,
}
integer ,
preemptionCapability:
{
Description: Default 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. ,
Enum:
{
NotPreempt: Cannot preempt ,
MayPreempt: May preempt ,
}
,
Required: False ,
}
enum ,
preemptionVulnerability:
{
Description: Default QoS Flow preemption vulnerability. The Preemption Vulnerability of a QoS Flow controls whether it can be preempted by QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
Enum:
{
NotPreemptable: Cannot be preempted ,
Preemptable: May be preempted ,
}
,
Required: False ,
}
enum ,
defaultSessionType:
{
Description: The default PDU session type, which is used if the UE does not request a specific session type. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
additionalAllowedSessionTypes:
{
Description: Allowed session types in addition to the default session type. Must not duplicate the default session type. ,
Required: False ,
}
[
string ,
]
,
allowedServices:
{
Description: List of Services that can be used as part of this Sim Policy. The list must not contain duplicate items and must contain at least one item. ,
Required: True ,
}
[
{
id:
{
Description: Service resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SimPolicies_ListByMobileNetwork (removed)
Description :  Gets all the simPolicies in a mobile network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/simPolicies
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of SimPolicies. ,
Required: False ,
}
[
{
properties:
{
Description: Sim policy Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the sim policy resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
ueAmbr:
{
Description: Aggregate maximum bit rate across all non-GBR QoS flows of all PDU sessions of a given UE. See 3GPP TS23.501 section 5.7.2.6 for a full description of the UE-AMBR. ,
Required: True ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
defaultSlice:
{
Description: The default slice to use if the UE does not explicitly specify it. This slice must exist in the `sliceConfigurations` map. ,
Required: True ,
}
{
id:
{
Description: Slice resource ID. ,
Required: True ,
}
string ,
}
,
rfspIndex:
{
Description: RAT/Frequency Selection Priority Index, defined in 3GPP TS 36.413. This is an optional setting and by default is unspecified. ,
Format: int32 ,
Required: False ,
}
integer ,
registrationTimer:
{
Description: Interval for the UE periodic registration update procedure, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
sliceConfigurations:
{
Description: The allowed slices and the settings to use for them. The list must not contain duplicate items and must contain at least one item. ,
Required: True ,
}
[
{
slice:
{
Description: A reference to the Slice that these settings apply to ,
Required: True ,
}
{
id:
{
Description: Slice resource ID. ,
Required: True ,
}
string ,
}
,
defaultDataNetwork:
{
Description: The default data network to use if the UE does not explicitly specify it. Configuration for this object must exist in the `dataNetworkConfigurations` map. ,
Required: True ,
}
{
id:
{
Description: Data Network resource ID. ,
Required: True ,
}
string ,
}
,
dataNetworkConfigurations:
{
Description: The allowed data networks and the settings to use for them. The list must not contain duplicate items and must contain at least one item. ,
Required: True ,
}
[
{
dataNetwork:
{
Description: A reference to the Data Network that these settings apply to ,
Required: True ,
}
{
id:
{
Description: Data Network resource ID. ,
Required: True ,
}
string ,
}
,
sessionAmbr:
{
Description: Aggregate maximum bit rate across all non-GBR QoS flows of a given PDU session. See 3GPP TS23.501 section 5.7.2.6 for a full description of the Session-AMBR. ,
Required: True ,
}
{
uplink:
{
Description: Uplink bit rate. ,
Required: True ,
}
string ,
downlink:
{
Description: Downlink bit rate. ,
Required: True ,
}
string ,
}
,
5qi:
{
Description: Default 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 selecting a GBR (Guaranteed Bit Rate) QoS. 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. ,
Format: int32 ,
Required: False ,
}
integer ,
allocationAndRetentionPriorityLevel:
{
Description: Default 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. ,
Format: int32 ,
Required: False ,
}
integer ,
preemptionCapability:
{
Description: Default 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. ,
Enum:
{
NotPreempt: Cannot preempt ,
MayPreempt: May preempt ,
}
,
Required: False ,
}
enum ,
preemptionVulnerability:
{
Description: Default QoS Flow preemption vulnerability. The Preemption Vulnerability of a QoS Flow controls whether it can be preempted by QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
Enum:
{
NotPreemptable: Cannot be preempted ,
Preemptable: May be preempted ,
}
,
Required: False ,
}
enum ,
defaultSessionType:
{
Description: The default PDU session type, which is used if the UE does not request a specific session type. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
additionalAllowedSessionTypes:
{
Description: Allowed session types in addition to the default session type. Must not duplicate the default session type. ,
Required: False ,
}
[
string ,
]
,
allowedServices:
{
Description: List of Services that can be used as part of this Sim Policy. The list must not contain duplicate items and must contain at least one item. ,
Required: True ,
}
[
{
id:
{
Description: Service resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Slices_Delete (removed)
Description :  Deletes the specified mobile network slice.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/slices/{sliceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
sliceName:
{
Description: The name of the mobile network slice. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Slices_Get (removed)
Description :  Gets information about the specified mobile network slice.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/slices/{sliceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
sliceName:
{
Description: The name of the mobile network slice. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Slice properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the network slice resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
snssai:
{
Description: The S-NSSAI (single network slice selection assistance information). Unique at the scope of a MobileNetwork. ,
Required: True ,
}
{
sst:
{
Description: Slice/Service Type (SST). ,
Format: int32 ,
Required: True ,
}
integer ,
sd:
{
Description: Slice Differentiator (SD). ,
Required: False ,
}
string ,
}
,
description:
{
Description: An optional description for this network slice. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Slices_CreateOrUpdate (removed)
Description :  Creates or updates a mobile network slice.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/slices/{sliceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
sliceName:
{
Description: The name of the mobile network slice. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update mobile network slice operation. ,
Required: True ,
}
{
properties:
{
Description: Slice properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the network slice resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
snssai:
{
Description: The S-NSSAI (single network slice selection assistance information). Unique at the scope of a MobileNetwork. ,
Required: True ,
}
{
sst:
{
Description: Slice/Service Type (SST). ,
Format: int32 ,
Required: True ,
}
integer ,
sd:
{
Description: Slice Differentiator (SD). ,
Required: False ,
}
string ,
}
,
description:
{
Description: An optional description for this network slice. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Slice properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the network slice resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
snssai:
{
Description: The S-NSSAI (single network slice selection assistance information). Unique at the scope of a MobileNetwork. ,
Required: True ,
}
{
sst:
{
Description: Slice/Service Type (SST). ,
Format: int32 ,
Required: True ,
}
integer ,
sd:
{
Description: Slice Differentiator (SD). ,
Required: False ,
}
string ,
}
,
description:
{
Description: An optional description for this network slice. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Slice properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the network slice resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
snssai:
{
Description: The S-NSSAI (single network slice selection assistance information). Unique at the scope of a MobileNetwork. ,
Required: True ,
}
{
sst:
{
Description: Slice/Service Type (SST). ,
Format: int32 ,
Required: True ,
}
integer ,
sd:
{
Description: Slice Differentiator (SD). ,
Required: False ,
}
string ,
}
,
description:
{
Description: An optional description for this network slice. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Slices_UpdateTags (removed)
Description :  Update slice tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/slices/{sliceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
sliceName:
{
Description: The name of the mobile network slice. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update mobile network slice tags. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Slice properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the network slice resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
snssai:
{
Description: The S-NSSAI (single network slice selection assistance information). Unique at the scope of a MobileNetwork. ,
Required: True ,
}
{
sst:
{
Description: Slice/Service Type (SST). ,
Format: int32 ,
Required: True ,
}
integer ,
sd:
{
Description: Slice Differentiator (SD). ,
Required: False ,
}
string ,
}
,
description:
{
Description: An optional description for this network slice. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Slices_ListByMobileNetwork (removed)
Description :  Lists all slices in the mobile network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/slices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of data networks in a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: Slice properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the network slice resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Accepted: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
snssai:
{
Description: The S-NSSAI (single network slice selection assistance information). Unique at the scope of a MobileNetwork. ,
Required: True ,
}
{
sst:
{
Description: Slice/Service Type (SST). ,
Format: int32 ,
Required: True ,
}
integer ,
sd:
{
Description: Slice Differentiator (SD). ,
Required: False ,
}
string ,
}
,
description:
{
Description: An optional description for this network slice. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}