Microsoft.MobileNetwork (stable:2024-04-01)

2025/11/24 • 85 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. The value must be an UUID. ,
Format: uuid ,
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. The value must be an UUID. ,
Format: uuid ,
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: Attached 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. For 5G networks, this is the N6 interface. For 4G networks, this is the 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 device. ,
Required: False ,
}
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 ,
vlanId:
{
Description: VLAN identifier of the network interface. Example: 501. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4AddressList:
{
Description: The list of IPv4 addresses, for a multi-node system. ,
Required: False ,
}
[
string ,
]
,
bfdIpv4Endpoints:
{
Description: The IPv4 addresses of the endpoints to send BFD probes to. ,
Required: False ,
}
[
string ,
]
,
}
,
dnsAddresses:
{
Description: The DNS servers to signal to UEs to use for this attached data network. This configuration is mandatory - if you don't want DNS servers, you must provide an empty array. ,
Required: True ,
}
[
string ,
]
,
naptConfiguration:
{
Description: The network address and port translation (NAPT) configuration. If this is not specified, the attached data network will use a default NAPT configuration with NAPT enabled. ,
Required: False ,
}
{
enabled:
{
Description: Whether NAPT is enabled for connections to this attached data network. ,
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 - 49,999. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA. Ports 50,000 and above are reserved for non-NAPT use.) ,
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 at least 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. For 5G networks, this is the N6 interface. For 4G networks, this is the SGi 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 3 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
udp:
{
Description: Pinhole timeout for UDP pinholes in seconds. Default for UDP is 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
icmp:
{
Description: Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
userEquipmentAddressPoolPrefix:
{
Description: The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will dynamically assign IP addresses to UEs. The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. You must define at least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix. If you define both, they must be of the same size. ,
Required: False ,
}
[
string ,
]
,
userEquipmentStaticAddressPoolPrefix:
{
Description: The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will assign static IP addresses to UEs. The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. The static IP address for a specific UE is set in StaticIPConfiguration on the corresponding SIM resource. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined, they must be of the same size. ,
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. Must be created in the same location as its parent packet core data plane.
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. The value must be an UUID. ,
Format: uuid ,
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: Attached 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. For 5G networks, this is the N6 interface. For 4G networks, this is the 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 device. ,
Required: False ,
}
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 ,
vlanId:
{
Description: VLAN identifier of the network interface. Example: 501. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4AddressList:
{
Description: The list of IPv4 addresses, for a multi-node system. ,
Required: False ,
}
[
string ,
]
,
bfdIpv4Endpoints:
{
Description: The IPv4 addresses of the endpoints to send BFD probes to. ,
Required: False ,
}
[
string ,
]
,
}
,
dnsAddresses:
{
Description: The DNS servers to signal to UEs to use for this attached data network. This configuration is mandatory - if you don't want DNS servers, you must provide an empty array. ,
Required: True ,
}
[
string ,
]
,
naptConfiguration:
{
Description: The network address and port translation (NAPT) configuration. If this is not specified, the attached data network will use a default NAPT configuration with NAPT enabled. ,
Required: False ,
}
{
enabled:
{
Description: Whether NAPT is enabled for connections to this attached data network. ,
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 - 49,999. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA. Ports 50,000 and above are reserved for non-NAPT use.) ,
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 at least 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. For 5G networks, this is the N6 interface. For 4G networks, this is the SGi 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 3 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
udp:
{
Description: Pinhole timeout for UDP pinholes in seconds. Default for UDP is 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
icmp:
{
Description: Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
userEquipmentAddressPoolPrefix:
{
Description: The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will dynamically assign IP addresses to UEs. The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. You must define at least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix. If you define both, they must be of the same size. ,
Required: False ,
}
[
string ,
]
,
userEquipmentStaticAddressPoolPrefix:
{
Description: The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will assign static IP addresses to UEs. The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. The static IP address for a specific UE is set in StaticIPConfiguration on the corresponding SIM resource. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined, they must be of the same size. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Attached 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. For 5G networks, this is the N6 interface. For 4G networks, this is the 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 device. ,
Required: False ,
}
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 ,
vlanId:
{
Description: VLAN identifier of the network interface. Example: 501. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4AddressList:
{
Description: The list of IPv4 addresses, for a multi-node system. ,
Required: False ,
}
[
string ,
]
,
bfdIpv4Endpoints:
{
Description: The IPv4 addresses of the endpoints to send BFD probes to. ,
Required: False ,
}
[
string ,
]
,
}
,
dnsAddresses:
{
Description: The DNS servers to signal to UEs to use for this attached data network. This configuration is mandatory - if you don't want DNS servers, you must provide an empty array. ,
Required: True ,
}
[
string ,
]
,
naptConfiguration:
{
Description: The network address and port translation (NAPT) configuration. If this is not specified, the attached data network will use a default NAPT configuration with NAPT enabled. ,
Required: False ,
}
{
enabled:
{
Description: Whether NAPT is enabled for connections to this attached data network. ,
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 - 49,999. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA. Ports 50,000 and above are reserved for non-NAPT use.) ,
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 at least 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. For 5G networks, this is the N6 interface. For 4G networks, this is the SGi 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 3 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
udp:
{
Description: Pinhole timeout for UDP pinholes in seconds. Default for UDP is 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
icmp:
{
Description: Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
userEquipmentAddressPoolPrefix:
{
Description: The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will dynamically assign IP addresses to UEs. The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. You must define at least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix. If you define both, they must be of the same size. ,
Required: False ,
}
[
string ,
]
,
userEquipmentStaticAddressPoolPrefix:
{
Description: The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will assign static IP addresses to UEs. The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. The static IP address for a specific UE is set in StaticIPConfiguration on the corresponding SIM resource. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined, they must be of the same size. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Attached 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. For 5G networks, this is the N6 interface. For 4G networks, this is the 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 device. ,
Required: False ,
}
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 ,
vlanId:
{
Description: VLAN identifier of the network interface. Example: 501. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4AddressList:
{
Description: The list of IPv4 addresses, for a multi-node system. ,
Required: False ,
}
[
string ,
]
,
bfdIpv4Endpoints:
{
Description: The IPv4 addresses of the endpoints to send BFD probes to. ,
Required: False ,
}
[
string ,
]
,
}
,
dnsAddresses:
{
Description: The DNS servers to signal to UEs to use for this attached data network. This configuration is mandatory - if you don't want DNS servers, you must provide an empty array. ,
Required: True ,
}
[
string ,
]
,
naptConfiguration:
{
Description: The network address and port translation (NAPT) configuration. If this is not specified, the attached data network will use a default NAPT configuration with NAPT enabled. ,
Required: False ,
}
{
enabled:
{
Description: Whether NAPT is enabled for connections to this attached data network. ,
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 - 49,999. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA. Ports 50,000 and above are reserved for non-NAPT use.) ,
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 at least 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. For 5G networks, this is the N6 interface. For 4G networks, this is the SGi 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 3 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
udp:
{
Description: Pinhole timeout for UDP pinholes in seconds. Default for UDP is 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
icmp:
{
Description: Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
userEquipmentAddressPoolPrefix:
{
Description: The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will dynamically assign IP addresses to UEs. The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. You must define at least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix. If you define both, they must be of the same size. ,
Required: False ,
}
[
string ,
]
,
userEquipmentStaticAddressPoolPrefix:
{
Description: The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will assign static IP addresses to UEs. The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. The static IP address for a specific UE is set in StaticIPConfiguration on the corresponding SIM resource. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined, they must be of the same size. ,
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 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. The value must be an UUID. ,
Format: uuid ,
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: Attached 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. For 5G networks, this is the N6 interface. For 4G networks, this is the 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 device. ,
Required: False ,
}
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 ,
vlanId:
{
Description: VLAN identifier of the network interface. Example: 501. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4AddressList:
{
Description: The list of IPv4 addresses, for a multi-node system. ,
Required: False ,
}
[
string ,
]
,
bfdIpv4Endpoints:
{
Description: The IPv4 addresses of the endpoints to send BFD probes to. ,
Required: False ,
}
[
string ,
]
,
}
,
dnsAddresses:
{
Description: The DNS servers to signal to UEs to use for this attached data network. This configuration is mandatory - if you don't want DNS servers, you must provide an empty array. ,
Required: True ,
}
[
string ,
]
,
naptConfiguration:
{
Description: The network address and port translation (NAPT) configuration. If this is not specified, the attached data network will use a default NAPT configuration with NAPT enabled. ,
Required: False ,
}
{
enabled:
{
Description: Whether NAPT is enabled for connections to this attached data network. ,
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 - 49,999. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA. Ports 50,000 and above are reserved for non-NAPT use.) ,
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 at least 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. For 5G networks, this is the N6 interface. For 4G networks, this is the SGi 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 3 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
udp:
{
Description: Pinhole timeout for UDP pinholes in seconds. Default for UDP is 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
icmp:
{
Description: Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
userEquipmentAddressPoolPrefix:
{
Description: The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will dynamically assign IP addresses to UEs. The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. You must define at least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix. If you define both, they must be of the same size. ,
Required: False ,
}
[
string ,
]
,
userEquipmentStaticAddressPoolPrefix:
{
Description: The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will assign static IP addresses to UEs. The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. The static IP address for a specific UE is set in StaticIPConfiguration on the corresponding SIM resource. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined, they must be of the same size. ,
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 attached 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. The value must be an UUID. ,
Format: uuid ,
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: Attached 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. For 5G networks, this is the N6 interface. For 4G networks, this is the 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 device. ,
Required: False ,
}
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 ,
vlanId:
{
Description: VLAN identifier of the network interface. Example: 501. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4AddressList:
{
Description: The list of IPv4 addresses, for a multi-node system. ,
Required: False ,
}
[
string ,
]
,
bfdIpv4Endpoints:
{
Description: The IPv4 addresses of the endpoints to send BFD probes to. ,
Required: False ,
}
[
string ,
]
,
}
,
dnsAddresses:
{
Description: The DNS servers to signal to UEs to use for this attached data network. This configuration is mandatory - if you don't want DNS servers, you must provide an empty array. ,
Required: True ,
}
[
string ,
]
,
naptConfiguration:
{
Description: The network address and port translation (NAPT) configuration. If this is not specified, the attached data network will use a default NAPT configuration with NAPT enabled. ,
Required: False ,
}
{
enabled:
{
Description: Whether NAPT is enabled for connections to this attached data network. ,
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 - 49,999. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA. Ports 50,000 and above are reserved for non-NAPT use.) ,
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 at least 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. For 5G networks, this is the N6 interface. For 4G networks, this is the SGi 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 3 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
udp:
{
Description: Pinhole timeout for UDP pinholes in seconds. Default for UDP is 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
icmp:
{
Description: Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 30 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
userEquipmentAddressPoolPrefix:
{
Description: The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will dynamically assign IP addresses to UEs. The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. You must define at least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix. If you define both, they must be of the same size. ,
Required: False ,
}
[
string ,
]
,
userEquipmentStaticAddressPoolPrefix:
{
Description: The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will assign static IP addresses to UEs. The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. The static IP address for a specific UE is set in StaticIPConfiguration on the corresponding SIM resource. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined, they must be of the same size. ,
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 data network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/dataNetworks/{dataNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 data 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 ,
}
,
]
,
}
,
}
DataNetworks_Get (removed)
Description :  Gets information about the specified data network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/dataNetworks/{dataNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 data network. ,
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 ,
}
,
}

⚐ 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 data network. Must be created in the same location as its parent mobile network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/dataNetworks/{dataNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 data network. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update data network 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 ,
}
,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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 :  Updates 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. The value must be an UUID. ,
Format: uuid ,
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 data network. ,
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 ,
}
,
}

⚐ 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 data networks 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. The value must be an UUID. ,
Format: uuid ,
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. ,
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 ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
DiagnosticsPackages_CreateOrUpdate (removed)
Description :  Creates or updates a diagnostics package.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/diagnosticsPackages/{diagnosticsPackageName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
diagnosticsPackageName:
{
Description: The name of the diagnostics package. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Diagnostics package properties. A diagnostics package file derived from the name of this resource will be uploaded to the Storage Account Container URL in the packet core control plane properties ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the diagnostics package 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 ,
status:
{
Description: The status of the diagnostics package collection. ,
Enum:
{
NotStarted: No description available. ,
Collecting: No description available. ,
Collected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the current state of the diagnostics package collection. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Diagnostics package properties. A diagnostics package file derived from the name of this resource will be uploaded to the Storage Account Container URL in the packet core control plane properties ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the diagnostics package 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 ,
status:
{
Description: The status of the diagnostics package collection. ,
Enum:
{
NotStarted: No description available. ,
Collecting: No description available. ,
Collected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the current state of the diagnostics package collection. ,
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 ,
}
,
]
,
}
,
}
DiagnosticsPackages_Get (removed)
Description :  Gets information about the specified diagnostics package.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/diagnosticsPackages/{diagnosticsPackageName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
diagnosticsPackageName:
{
Description: The name of the diagnostics package. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Diagnostics package properties. A diagnostics package file derived from the name of this resource will be uploaded to the Storage Account Container URL in the packet core control plane properties ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the diagnostics package 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 ,
status:
{
Description: The status of the diagnostics package collection. ,
Enum:
{
NotStarted: No description available. ,
Collecting: No description available. ,
Collected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the current state of the diagnostics package collection. ,
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 ,
}
,
]
,
}
,
}
DiagnosticsPackages_Delete (removed)
Description :  Deletes the specified diagnostics package.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/diagnosticsPackages/{diagnosticsPackageName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
diagnosticsPackageName:
{
Description: The name of the diagnostics package. ,
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 ,
}
,
]
,
}
,
}
DiagnosticsPackages_ListByPacketCoreControlPlane (removed)
Description :  Lists all the diagnostics packages under a packet core control plane.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/diagnosticsPackages
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of diagnostics packages under a packet core control plane. ,
Required: False ,
}
[
{
properties:
{
Description: Diagnostics package properties. A diagnostics package file derived from the name of this resource will be uploaded to the Storage Account Container URL in the packet core control plane properties ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the diagnostics package 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 ,
status:
{
Description: The status of the diagnostics package collection. ,
Enum:
{
NotStarted: No description available. ,
Collecting: No description available. ,
Collected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the current state of the diagnostics package collection. ,
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. The value must be an UUID. ,
Format: uuid ,
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. The value must be an UUID. ,
Format: uuid ,
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. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence. ,
Required: True ,
}
{
mcc:
{
Description: Mobile country code (MCC). ,
Required: True ,
}
string ,
mnc:
{
Description: Mobile network code (MNC). ,
Required: True ,
}
string ,
}
,
publicLandMobileNetworks:
{
Description: A list of public land mobile networks including their identifiers. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence. ,
Required: False ,
}
[
{
homeNetworkPublicKeys:
{
Description: Configuration relating to SUPI concealment. ,
Required: False ,
}
{
profileA:
{
Description: This provides a mapping to identify which public key has been used for SUPI concealment using the Profile A Protection Scheme. ,
Required: False ,
}
[
{
id:
{
Description: The Home Network Public Key Identifier determines which public key was used to generate the SUCI sent to the AMF. See TS 23.003 Section 2.2B Section 5. ,
Format: int32 ,
Required: True ,
}
integer ,
url:
{
Description: The URL of Azure Key Vault secret containing the private key, versioned or unversioned. For example: https://contosovault.vault.azure.net/secrets/mySuciPrivateKey/562a4bb76b524a1493a6afe8e536ee78. ,
Required: False ,
}
string ,
}
,
]
,
profileB:
{
Description: This provides a mapping to identify which public key has been used for SUPI concealment using the Profile B Protection Scheme. ,
Required: False ,
}
[
{
id:
{
Description: The Home Network Public Key Identifier determines which public key was used to generate the SUCI sent to the AMF. See TS 23.003 Section 2.2B Section 5. ,
Format: int32 ,
Required: True ,
}
integer ,
url:
{
Description: The URL of Azure Key Vault secret containing the private key, versioned or unversioned. For example: https://contosovault.vault.azure.net/secrets/mySuciPrivateKey/562a4bb76b524a1493a6afe8e536ee78. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
serviceKey:
{
Description: The mobile network resource identifier ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity used to retrieve any private keys used for SUPI concealment from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ 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. The value must be an UUID. ,
Format: uuid ,
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. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence. ,
Required: True ,
}
{
mcc:
{
Description: Mobile country code (MCC). ,
Required: True ,
}
string ,
mnc:
{
Description: Mobile network code (MNC). ,
Required: True ,
}
string ,
}
,
publicLandMobileNetworks:
{
Description: A list of public land mobile networks including their identifiers. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence. ,
Required: False ,
}
[
{
homeNetworkPublicKeys:
{
Description: Configuration relating to SUPI concealment. ,
Required: False ,
}
{
profileA:
{
Description: This provides a mapping to identify which public key has been used for SUPI concealment using the Profile A Protection Scheme. ,
Required: False ,
}
[
{
id:
{
Description: The Home Network Public Key Identifier determines which public key was used to generate the SUCI sent to the AMF. See TS 23.003 Section 2.2B Section 5. ,
Format: int32 ,
Required: True ,
}
integer ,
url:
{
Description: The URL of Azure Key Vault secret containing the private key, versioned or unversioned. For example: https://contosovault.vault.azure.net/secrets/mySuciPrivateKey/562a4bb76b524a1493a6afe8e536ee78. ,
Required: False ,
}
string ,
}
,
]
,
profileB:
{
Description: This provides a mapping to identify which public key has been used for SUPI concealment using the Profile B Protection Scheme. ,
Required: False ,
}
[
{
id:
{
Description: The Home Network Public Key Identifier determines which public key was used to generate the SUCI sent to the AMF. See TS 23.003 Section 2.2B Section 5. ,
Format: int32 ,
Required: True ,
}
integer ,
url:
{
Description: The URL of Azure Key Vault secret containing the private key, versioned or unversioned. For example: https://contosovault.vault.azure.net/secrets/mySuciPrivateKey/562a4bb76b524a1493a6afe8e536ee78. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
serviceKey:
{
Description: The mobile network resource identifier ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity used to retrieve any private keys used for SUPI concealment from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
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. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence. ,
Required: True ,
}
{
mcc:
{
Description: Mobile country code (MCC). ,
Required: True ,
}
string ,
mnc:
{
Description: Mobile network code (MNC). ,
Required: True ,
}
string ,
}
,
publicLandMobileNetworks:
{
Description: A list of public land mobile networks including their identifiers. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence. ,
Required: False ,
}
[
{
homeNetworkPublicKeys:
{
Description: Configuration relating to SUPI concealment. ,
Required: False ,
}
{
profileA:
{
Description: This provides a mapping to identify which public key has been used for SUPI concealment using the Profile A Protection Scheme. ,
Required: False ,
}
[
{
id:
{
Description: The Home Network Public Key Identifier determines which public key was used to generate the SUCI sent to the AMF. See TS 23.003 Section 2.2B Section 5. ,
Format: int32 ,
Required: True ,
}
integer ,
url:
{
Description: The URL of Azure Key Vault secret containing the private key, versioned or unversioned. For example: https://contosovault.vault.azure.net/secrets/mySuciPrivateKey/562a4bb76b524a1493a6afe8e536ee78. ,
Required: False ,
}
string ,
}
,
]
,
profileB:
{
Description: This provides a mapping to identify which public key has been used for SUPI concealment using the Profile B Protection Scheme. ,
Required: False ,
}
[
{
id:
{
Description: The Home Network Public Key Identifier determines which public key was used to generate the SUCI sent to the AMF. See TS 23.003 Section 2.2B Section 5. ,
Format: int32 ,
Required: True ,
}
integer ,
url:
{
Description: The URL of Azure Key Vault secret containing the private key, versioned or unversioned. For example: https://contosovault.vault.azure.net/secrets/mySuciPrivateKey/562a4bb76b524a1493a6afe8e536ee78. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
serviceKey:
{
Description: The mobile network resource identifier ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity used to retrieve any private keys used for SUPI concealment from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ 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. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence. ,
Required: True ,
}
{
mcc:
{
Description: Mobile country code (MCC). ,
Required: True ,
}
string ,
mnc:
{
Description: Mobile network code (MNC). ,
Required: True ,
}
string ,
}
,
publicLandMobileNetworks:
{
Description: A list of public land mobile networks including their identifiers. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence. ,
Required: False ,
}
[
{
homeNetworkPublicKeys:
{
Description: Configuration relating to SUPI concealment. ,
Required: False ,
}
{
profileA:
{
Description: This provides a mapping to identify which public key has been used for SUPI concealment using the Profile A Protection Scheme. ,
Required: False ,
}
[
{
id:
{
Description: The Home Network Public Key Identifier determines which public key was used to generate the SUCI sent to the AMF. See TS 23.003 Section 2.2B Section 5. ,
Format: int32 ,
Required: True ,
}
integer ,
url:
{
Description: The URL of Azure Key Vault secret containing the private key, versioned or unversioned. For example: https://contosovault.vault.azure.net/secrets/mySuciPrivateKey/562a4bb76b524a1493a6afe8e536ee78. ,
Required: False ,
}
string ,
}
,
]
,
profileB:
{
Description: This provides a mapping to identify which public key has been used for SUPI concealment using the Profile B Protection Scheme. ,
Required: False ,
}
[
{
id:
{
Description: The Home Network Public Key Identifier determines which public key was used to generate the SUCI sent to the AMF. See TS 23.003 Section 2.2B Section 5. ,
Format: int32 ,
Required: True ,
}
integer ,
url:
{
Description: The URL of Azure Key Vault secret containing the private key, versioned or unversioned. For example: https://contosovault.vault.azure.net/secrets/mySuciPrivateKey/562a4bb76b524a1493a6afe8e536ee78. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
serviceKey:
{
Description: The mobile network resource identifier ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity used to retrieve any private keys used for SUPI concealment from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 mobile network tags and managed identity.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 and/or identity. ,
Required: True ,
}
{
identity:
{
Description: The managed service identity associated with this resource. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
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. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence. ,
Required: True ,
}
{
mcc:
{
Description: Mobile country code (MCC). ,
Required: True ,
}
string ,
mnc:
{
Description: Mobile network code (MNC). ,
Required: True ,
}
string ,
}
,
publicLandMobileNetworks:
{
Description: A list of public land mobile networks including their identifiers. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence. ,
Required: False ,
}
[
{
homeNetworkPublicKeys:
{
Description: Configuration relating to SUPI concealment. ,
Required: False ,
}
{
profileA:
{
Description: This provides a mapping to identify which public key has been used for SUPI concealment using the Profile A Protection Scheme. ,
Required: False ,
}
[
{
id:
{
Description: The Home Network Public Key Identifier determines which public key was used to generate the SUCI sent to the AMF. See TS 23.003 Section 2.2B Section 5. ,
Format: int32 ,
Required: True ,
}
integer ,
url:
{
Description: The URL of Azure Key Vault secret containing the private key, versioned or unversioned. For example: https://contosovault.vault.azure.net/secrets/mySuciPrivateKey/562a4bb76b524a1493a6afe8e536ee78. ,
Required: False ,
}
string ,
}
,
]
,
profileB:
{
Description: This provides a mapping to identify which public key has been used for SUPI concealment using the Profile B Protection Scheme. ,
Required: False ,
}
[
{
id:
{
Description: The Home Network Public Key Identifier determines which public key was used to generate the SUCI sent to the AMF. See TS 23.003 Section 2.2B Section 5. ,
Format: int32 ,
Required: True ,
}
integer ,
url:
{
Description: The URL of Azure Key Vault secret containing the private key, versioned or unversioned. For example: https://contosovault.vault.azure.net/secrets/mySuciPrivateKey/562a4bb76b524a1493a6afe8e536ee78. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
serviceKey:
{
Description: The mobile network resource identifier ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity used to retrieve any private keys used for SUPI concealment from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ 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. The value must be an UUID. ,
Format: uuid ,
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. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence. ,
Required: True ,
}
{
mcc:
{
Description: Mobile country code (MCC). ,
Required: True ,
}
string ,
mnc:
{
Description: Mobile network code (MNC). ,
Required: True ,
}
string ,
}
,
publicLandMobileNetworks:
{
Description: A list of public land mobile networks including their identifiers. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence. ,
Required: False ,
}
[
{
homeNetworkPublicKeys:
{
Description: Configuration relating to SUPI concealment. ,
Required: False ,
}
{
profileA:
{
Description: This provides a mapping to identify which public key has been used for SUPI concealment using the Profile A Protection Scheme. ,
Required: False ,
}
[
{
id:
{
Description: The Home Network Public Key Identifier determines which public key was used to generate the SUCI sent to the AMF. See TS 23.003 Section 2.2B Section 5. ,
Format: int32 ,
Required: True ,
}
integer ,
url:
{
Description: The URL of Azure Key Vault secret containing the private key, versioned or unversioned. For example: https://contosovault.vault.azure.net/secrets/mySuciPrivateKey/562a4bb76b524a1493a6afe8e536ee78. ,
Required: False ,
}
string ,
}
,
]
,
profileB:
{
Description: This provides a mapping to identify which public key has been used for SUPI concealment using the Profile B Protection Scheme. ,
Required: False ,
}
[
{
id:
{
Description: The Home Network Public Key Identifier determines which public key was used to generate the SUCI sent to the AMF. See TS 23.003 Section 2.2B Section 5. ,
Format: int32 ,
Required: True ,
}
integer ,
url:
{
Description: The URL of Azure Key Vault secret containing the private key, versioned or unversioned. For example: https://contosovault.vault.azure.net/secrets/mySuciPrivateKey/562a4bb76b524a1493a6afe8e536ee78. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
serviceKey:
{
Description: The mobile network resource identifier ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity used to retrieve any private keys used for SUPI concealment from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
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. The value must be an UUID. ,
Format: uuid ,
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. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence. ,
Required: True ,
}
{
mcc:
{
Description: Mobile country code (MCC). ,
Required: True ,
}
string ,
mnc:
{
Description: Mobile network code (MNC). ,
Required: True ,
}
string ,
}
,
publicLandMobileNetworks:
{
Description: A list of public land mobile networks including their identifiers. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence. ,
Required: False ,
}
[
{
homeNetworkPublicKeys:
{
Description: Configuration relating to SUPI concealment. ,
Required: False ,
}
{
profileA:
{
Description: This provides a mapping to identify which public key has been used for SUPI concealment using the Profile A Protection Scheme. ,
Required: False ,
}
[
{
id:
{
Description: The Home Network Public Key Identifier determines which public key was used to generate the SUCI sent to the AMF. See TS 23.003 Section 2.2B Section 5. ,
Format: int32 ,
Required: True ,
}
integer ,
url:
{
Description: The URL of Azure Key Vault secret containing the private key, versioned or unversioned. For example: https://contosovault.vault.azure.net/secrets/mySuciPrivateKey/562a4bb76b524a1493a6afe8e536ee78. ,
Required: False ,
}
string ,
}
,
]
,
profileB:
{
Description: This provides a mapping to identify which public key has been used for SUPI concealment using the Profile B Protection Scheme. ,
Required: False ,
}
[
{
id:
{
Description: The Home Network Public Key Identifier determines which public key was used to generate the SUCI sent to the AMF. See TS 23.003 Section 2.2B Section 5. ,
Format: int32 ,
Required: True ,
}
integer ,
url:
{
Description: The URL of Azure Key Vault secret containing the private key, versioned or unversioned. For example: https://contosovault.vault.azure.net/secrets/mySuciPrivateKey/562a4bb76b524a1493a6afe8e536ee78. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
serviceKey:
{
Description: The mobile network resource identifier ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity used to retrieve any private keys used for SUPI concealment from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
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_ListSimGroups (removed)
Description :  Gets all the SIM groups assigned to a mobile network.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/listSimGroups
{
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
mobileNetworkName:
{
Description: The name of the mobile network. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of SIM groups in a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: SIM group Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the SIM group 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 ,
encryptionKey:
{
Description: A key to encrypt the SIM data that belongs to this SIM group. ,
Required: False ,
}
{
keyUrl:
{
Description: The key URL, unversioned. For example: https://contosovault.vault.azure.net/keys/azureKey. ,
Required: False ,
}
string ,
}
,
mobileNetwork:
{
Description: Mobile network that this SIM group belongs to. The mobile network must be in the same location as the SIM group. ,
Required: False ,
}
{
id:
{
Description: Mobile network resource ID. ,
Required: True ,
}
string ,
}
,
}
,
identity:
{
Description: The identity used to retrieve the encryption key from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
PacketCaptures_CreateOrUpdate (removed)
Description :  Creates or updates a packet capture.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCaptures/{packetCaptureName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
packetCaptureName:
{
Description: The name of the packet capture session. ,
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 packet capture operation. ,
Required: True ,
}
{
properties:
{
Description: Packet capture session properties. Packet capture file(s) derived from the name of this session will be uploaded to the Storage Account Container URL in the packet core control plane properties ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet capture session 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 ,
status:
{
Description: The status of the packet capture session. ,
Enum:
{
NotStarted: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason the current packet capture session state. ,
Required: False ,
}
string ,
captureStartTime:
{
Description: The start time of the packet capture session. ,
Format: date-time ,
Required: False ,
}
string ,
networkInterfaces:
{
Description: List of network interfaces to capture on. ,
Required: False ,
}
[
string ,
]
,
bytesToCapturePerPacket:
{
Description: Number of bytes captured per packet, the remaining bytes are truncated. The default "0" means the entire packet is captured. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBytesPerSession:
{
Description: Maximum size of the capture output. ,
Format: int64 ,
Required: False ,
}
integer ,
timeLimitInSeconds:
{
Description: Maximum duration of the capture session in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
outputFiles:
{
Description: The list of output files of a packet capture session. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Packet capture session properties. Packet capture file(s) derived from the name of this session will be uploaded to the Storage Account Container URL in the packet core control plane properties ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet capture session 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 ,
status:
{
Description: The status of the packet capture session. ,
Enum:
{
NotStarted: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason the current packet capture session state. ,
Required: False ,
}
string ,
captureStartTime:
{
Description: The start time of the packet capture session. ,
Format: date-time ,
Required: False ,
}
string ,
networkInterfaces:
{
Description: List of network interfaces to capture on. ,
Required: False ,
}
[
string ,
]
,
bytesToCapturePerPacket:
{
Description: Number of bytes captured per packet, the remaining bytes are truncated. The default "0" means the entire packet is captured. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBytesPerSession:
{
Description: Maximum size of the capture output. ,
Format: int64 ,
Required: False ,
}
integer ,
timeLimitInSeconds:
{
Description: Maximum duration of the capture session in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
outputFiles:
{
Description: The list of output files of a packet capture session. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Packet capture session properties. Packet capture file(s) derived from the name of this session will be uploaded to the Storage Account Container URL in the packet core control plane properties ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet capture session 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 ,
status:
{
Description: The status of the packet capture session. ,
Enum:
{
NotStarted: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason the current packet capture session state. ,
Required: False ,
}
string ,
captureStartTime:
{
Description: The start time of the packet capture session. ,
Format: date-time ,
Required: False ,
}
string ,
networkInterfaces:
{
Description: List of network interfaces to capture on. ,
Required: False ,
}
[
string ,
]
,
bytesToCapturePerPacket:
{
Description: Number of bytes captured per packet, the remaining bytes are truncated. The default "0" means the entire packet is captured. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBytesPerSession:
{
Description: Maximum size of the capture output. ,
Format: int64 ,
Required: False ,
}
integer ,
timeLimitInSeconds:
{
Description: Maximum duration of the capture session in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
outputFiles:
{
Description: The list of output files of a packet capture session. ,
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 ,
}
,
]
,
}
,
}
PacketCaptures_Get (removed)
Description :  Gets information about the specified packet capture session.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCaptures/{packetCaptureName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
packetCaptureName:
{
Description: The name of the packet capture session. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Packet capture session properties. Packet capture file(s) derived from the name of this session will be uploaded to the Storage Account Container URL in the packet core control plane properties ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet capture session 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 ,
status:
{
Description: The status of the packet capture session. ,
Enum:
{
NotStarted: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason the current packet capture session state. ,
Required: False ,
}
string ,
captureStartTime:
{
Description: The start time of the packet capture session. ,
Format: date-time ,
Required: False ,
}
string ,
networkInterfaces:
{
Description: List of network interfaces to capture on. ,
Required: False ,
}
[
string ,
]
,
bytesToCapturePerPacket:
{
Description: Number of bytes captured per packet, the remaining bytes are truncated. The default "0" means the entire packet is captured. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBytesPerSession:
{
Description: Maximum size of the capture output. ,
Format: int64 ,
Required: False ,
}
integer ,
timeLimitInSeconds:
{
Description: Maximum duration of the capture session in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
outputFiles:
{
Description: The list of output files of a packet capture session. ,
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 ,
}
,
]
,
}
,
}
PacketCaptures_Delete (removed)
Description :  Deletes the specified packet capture.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCaptures/{packetCaptureName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
packetCaptureName:
{
Description: The name of the packet capture session. ,
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 ,
}
,
]
,
}
,
}
PacketCaptures_Stop (removed)
Description :  Stop a packet capture session.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCaptures/{packetCaptureName}/stop
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
packetCaptureName:
{
Description: The name of the packet capture session. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the async operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: The operation status. ,
Required: True ,
}
string ,
resourceId:
{
Description: Fully qualified ID for the resource that this async operation status relates to. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage of the operation that is complete. ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: Properties returned by the resource provider on a successful operation ,
Required: False ,
}
object ,
error:
{
Description: If present, details of the operation error. ,
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 ,
}
,
]
,
}
,
}

⚐ Response (202)

{}

⚐ 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 ,
}
,
]
,
}
,
}
PacketCaptures_ListByPacketCoreControlPlane (removed)
Description :  Lists all the packet capture sessions under a packet core control plane.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCaptures
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of packet capture sessions under a packet core control plane. ,
Required: False ,
}
[
{
properties:
{
Description: Packet capture session properties. Packet capture file(s) derived from the name of this session will be uploaded to the Storage Account Container URL in the packet core control plane properties ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet capture session 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 ,
status:
{
Description: The status of the packet capture session. ,
Enum:
{
NotStarted: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason the current packet capture session state. ,
Required: False ,
}
string ,
captureStartTime:
{
Description: The start time of the packet capture session. ,
Format: date-time ,
Required: False ,
}
string ,
networkInterfaces:
{
Description: List of network interfaces to capture on. ,
Required: False ,
}
[
string ,
]
,
bytesToCapturePerPacket:
{
Description: Number of bytes captured per packet, the remaining bytes are truncated. The default "0" means the entire packet is captured. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBytesPerSession:
{
Description: Maximum size of the capture output. ,
Format: int64 ,
Required: False ,
}
integer ,
timeLimitInSeconds:
{
Description: Maximum duration of the capture session in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
outputFiles:
{
Description: The list of output files of a packet capture session. ,
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. The value must be an UUID. ,
Format: uuid ,
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. The value must be an UUID. ,
Format: uuid ,
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 ,
installation:
{
Description: The installation state of the packet core control plane resource. ,
Required: False ,
}
{
desiredState:
{
Description: The desired installation state ,
Enum:
{
Uninstalled: Don't install the packet core. ,
Installed: Install the packet core. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Installation state ,
Enum:
{
Uninstalled: The packet core is uninstalled. ,
Installing: The packet core is installing. ,
Installed: The packet core is installed. ,
Updating: The packet core is updating its configuration. ,
Upgrading: The packet core is upgrading to a different software version. ,
Uninstalling: The packet core is uninstalling. ,
Reinstalling: The packet core is reinstalling. ,
RollingBack: The packet core is rolling back to its previous version. ,
Failed: The packet core is in failed state. ,
}
,
Required: False ,
}
enum ,
reinstallRequired:
{
Description: Whether a reinstall of the packet core is required to pick up the latest configuration changes. ,
Enum:
{
Required: A reinstall of the packet core is required. ,
NotRequired: A reinstall of the packet core is not required. ,
}
,
Required: False ,
}
enum ,
reasons:
{
Description: Reason(s) for the current installation state of the packet core. ,
Required: False ,
}
[
string ,
]
,
operation:
{
Description: A reference to an in-progress installation operation ,
Required: False ,
}
{
id:
{
Description: Azure Async Operation ID. ,
Required: True ,
}
string ,
}
,
}
,
sites:
{
Description: Site(s) under which this packet core control plane should be deployed. The sites must be in the same location as the packet core control plane. ,
Required: True ,
}
[
{
id:
{
Description: Site resource ID. ,
Required: True ,
}
string ,
}
,
]
,
platform:
{
Description: The platform where the packet core is deployed. ,
Required: True ,
}
{
type:
{
Description: The platform type where packet core is deployed. ,
Enum:
{
AKS-HCI: If this option is chosen, you must set one of "azureStackEdgeDevice", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
3P-AZURE-STACK-HCI: If this option is chosen, you must set one of "azureStackHciCluster", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
}
,
Required: True ,
}
enum ,
azureStackEdgeDevice:
{
Description: The Azure Stack Edge device where the packet core is deployed. If the device is part of a fault tolerant pair, either device in the pair can be specified. ,
Required: False ,
}
{
id:
{
Description: Azure Stack Edge device resource ID. ,
Required: True ,
}
string ,
}
,
azureStackEdgeDevices:
{
Description: The Azure Stack Edge devices where the packet core is deployed. If the packet core is deployed across multiple devices, all devices will appear in this list. ,
Required: False ,
}
[
{
id:
{
Description: Azure Stack Edge device resource ID. ,
Required: True ,
}
string ,
}
,
]
,
azureStackHciCluster:
{
Description: The Azure Stack HCI cluster where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure Stack HCI cluster resource ID. ,
Required: True ,
}
string ,
}
,
connectedCluster:
{
Description: Azure Arc connected cluster where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure Arc connected cluster 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 (5G core or EPC / 4G core). ,
Enum:
{
5GC: 5G core ,
EPC: EPC / 4G core ,
EPC + 5GC: Combined EPC / 4G and 5G core ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The desired version of the packet core software. ,
Required: False ,
}
string ,
installedVersion:
{
Description: The currently installed version of the packet core software. ,
Required: False ,
}
string ,
rollbackVersion:
{
Description: The previous version of the packet core software that was deployed. Used when performing the rollback action. ,
Required: False ,
}
string ,
controlPlaneAccessInterface:
{
Description: The control plane interface on the access network. For 5G networks, this is the N2 interface. For 4G networks, this is the 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 device. ,
Required: False ,
}
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 ,
vlanId:
{
Description: VLAN identifier of the network interface. Example: 501. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4AddressList:
{
Description: The list of IPv4 addresses, for a multi-node system. ,
Required: False ,
}
[
string ,
]
,
bfdIpv4Endpoints:
{
Description: The IPv4 addresses of the endpoints to send BFD probes to. ,
Required: False ,
}
[
string ,
]
,
}
,
controlPlaneAccessVirtualIpv4Addresses:
{
Description: The virtual IP address(es) for the control plane on the access network in a High Availability (HA) system. In an HA deployment the access network router should be configured to anycast traffic for this address to the control plane access interfaces on the active and standby nodes. In non-HA system this list should be omitted or empty. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The SKU defining the throughput and SIM allowances for this packet core control plane deployment. ,
Enum:
{
G0: 100 Mbps, 20 active SIMs plan, 2 RANs ,
G1: 1 Gbps, 100 active SIMs plan, 5 RANs ,
G2: 2 Gbps, 200 active SIMs plan, 10 RANs ,
G5: 5 Gbps, 500 active SIMs plan ,
G10: 10 Gbps, 1000 active SIMs plan ,
}
,
Required: True ,
}
enum ,
ueMtu:
{
Description: The MTU (in bytes) signaled to the UE. The same MTU is set on the user plane data links for all data networks. The MTU set on the user plane access link is calculated to be 60 bytes greater than this value to allow for GTP encapsulation. ,
Format: int32 ,
Required: False ,
}
integer ,
localDiagnosticsAccess:
{
Description: The kubernetes ingress configuration to control access to packet core diagnostics over local APIs. ,
Required: True ,
}
{
authenticationType:
{
Description: How to authenticate users who access local diagnostics APIs. ,
Enum:
{
AAD: Use AAD SSO to authenticate the user (this requires internet access). ,
Password: Use locally stored passwords to authenticate the user. ,
}
,
Required: True ,
}
enum ,
httpsServerCertificate:
{
Description: The HTTPS server TLS certificate used to secure local access to diagnostics. ,
Required: False ,
}
{
certificateUrl:
{
Description: The certificate URL, unversioned. For example: https://contosovault.vault.azure.net/certificates/ingress. ,
Required: True ,
}
string ,
provisioning:
{
Description: The provisioning state of the certificate. ,
Required: False ,
}
{
state:
{
Description: The certificate's provisioning state ,
Enum:
{
NotProvisioned: The certificate has not been provisioned. ,
Provisioned: The certificate has been provisioned. ,
Failed: The certificate failed to be provisioned. The "reason" property explains why. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: Reason for certificate provisioning failure. ,
Required: False ,
}
string ,
}
,
}
,
}
,
diagnosticsUpload:
{
Description: Configuration for uploading packet core diagnostics ,
Required: False ,
}
{
storageAccountContainerUrl:
{
Description: The Storage Account Container URL to upload diagnostics to. ,
Required: True ,
}
string ,
}
,
eventHub:
{
Description: Configuration for sending packet core events to an Azure Event Hub. ,
Required: False ,
}
{
id:
{
Description: Resource ID of Azure Event Hub to send packet core events to. ,
Required: True ,
}
string ,
reportingInterval:
{
Description: The duration (in seconds) between UE usage reports. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
signaling:
{
Description: Signaling configuration for the packet core. ,
Required: False ,
}
{
nasReroute:
{
Description: Configuration enabling 4G NAS reroute. ,
Required: False ,
}
{
macroMmeGroupId:
{
Description: The macro network's MME group ID. This is where unknown UEs are sent to via NAS reroute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
nasEncryption:
{
Description: An ordered list of NAS encryption algorithms, used to encrypt control plane traffic between the UE and packet core, in order from most to least preferred. If not specified, the packet core will use a built-in default ordering. ,
Required: False ,
}
[
string ,
]
,
}
,
interopSettings:
{
Description: Settings to allow interoperability with third party components e.g. RANs and UEs. ,
Required: False ,
}
object ,
homeNetworkPrivateKeysProvisioning:
{
Description: The provisioning state of the secret containing private keys and keyIds for SUPI concealment. ,
Required: False ,
}
{
state:
{
Description: The provisioning state of the private keys for SUPI concealment. ,
Enum:
{
NotProvisioned: Provisioning of the private keys for SUPI concealment has not been attempted. ,
Provisioned: The private keys for SUPI concealment are successfully provisioned. ,
Failed: Provisioning of the private keys for SUPI concealment has failed. ,
}
,
Required: True ,
}
enum ,
}
,
userConsent:
{
Description: The user consent configuration for the packet core. ,
Required: False ,
}
{
allowSupportTelemetryAccess:
{
Description: Allow Microsoft to access non-PII telemetry information from the packet core. ,
Required: False ,
}
boolean ,
}
,
}
,
identity:
{
Description: The identity used to retrieve the ingress certificate from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 packet core control plane.
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 ,
installation:
{
Description: The installation state of the packet core control plane resource. ,
Required: False ,
}
{
desiredState:
{
Description: The desired installation state ,
Enum:
{
Uninstalled: Don't install the packet core. ,
Installed: Install the packet core. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Installation state ,
Enum:
{
Uninstalled: The packet core is uninstalled. ,
Installing: The packet core is installing. ,
Installed: The packet core is installed. ,
Updating: The packet core is updating its configuration. ,
Upgrading: The packet core is upgrading to a different software version. ,
Uninstalling: The packet core is uninstalling. ,
Reinstalling: The packet core is reinstalling. ,
RollingBack: The packet core is rolling back to its previous version. ,
Failed: The packet core is in failed state. ,
}
,
Required: False ,
}
enum ,
reinstallRequired:
{
Description: Whether a reinstall of the packet core is required to pick up the latest configuration changes. ,
Enum:
{
Required: A reinstall of the packet core is required. ,
NotRequired: A reinstall of the packet core is not required. ,
}
,
Required: False ,
}
enum ,
reasons:
{
Description: Reason(s) for the current installation state of the packet core. ,
Required: False ,
}
[
string ,
]
,
operation:
{
Description: A reference to an in-progress installation operation ,
Required: False ,
}
{
id:
{
Description: Azure Async Operation ID. ,
Required: True ,
}
string ,
}
,
}
,
sites:
{
Description: Site(s) under which this packet core control plane should be deployed. The sites must be in the same location as the packet core control plane. ,
Required: True ,
}
[
{
id:
{
Description: Site resource ID. ,
Required: True ,
}
string ,
}
,
]
,
platform:
{
Description: The platform where the packet core is deployed. ,
Required: True ,
}
{
type:
{
Description: The platform type where packet core is deployed. ,
Enum:
{
AKS-HCI: If this option is chosen, you must set one of "azureStackEdgeDevice", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
3P-AZURE-STACK-HCI: If this option is chosen, you must set one of "azureStackHciCluster", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
}
,
Required: True ,
}
enum ,
azureStackEdgeDevice:
{
Description: The Azure Stack Edge device where the packet core is deployed. If the device is part of a fault tolerant pair, either device in the pair can be specified. ,
Required: False ,
}
{
id:
{
Description: Azure Stack Edge device resource ID. ,
Required: True ,
}
string ,
}
,
azureStackEdgeDevices:
{
Description: The Azure Stack Edge devices where the packet core is deployed. If the packet core is deployed across multiple devices, all devices will appear in this list. ,
Required: False ,
}
[
{
id:
{
Description: Azure Stack Edge device resource ID. ,
Required: True ,
}
string ,
}
,
]
,
azureStackHciCluster:
{
Description: The Azure Stack HCI cluster where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure Stack HCI cluster resource ID. ,
Required: True ,
}
string ,
}
,
connectedCluster:
{
Description: Azure Arc connected cluster where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure Arc connected cluster 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 (5G core or EPC / 4G core). ,
Enum:
{
5GC: 5G core ,
EPC: EPC / 4G core ,
EPC + 5GC: Combined EPC / 4G and 5G core ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The desired version of the packet core software. ,
Required: False ,
}
string ,
installedVersion:
{
Description: The currently installed version of the packet core software. ,
Required: False ,
}
string ,
rollbackVersion:
{
Description: The previous version of the packet core software that was deployed. Used when performing the rollback action. ,
Required: False ,
}
string ,
controlPlaneAccessInterface:
{
Description: The control plane interface on the access network. For 5G networks, this is the N2 interface. For 4G networks, this is the 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 device. ,
Required: False ,
}
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 ,
vlanId:
{
Description: VLAN identifier of the network interface. Example: 501. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4AddressList:
{
Description: The list of IPv4 addresses, for a multi-node system. ,
Required: False ,
}
[
string ,
]
,
bfdIpv4Endpoints:
{
Description: The IPv4 addresses of the endpoints to send BFD probes to. ,
Required: False ,
}
[
string ,
]
,
}
,
controlPlaneAccessVirtualIpv4Addresses:
{
Description: The virtual IP address(es) for the control plane on the access network in a High Availability (HA) system. In an HA deployment the access network router should be configured to anycast traffic for this address to the control plane access interfaces on the active and standby nodes. In non-HA system this list should be omitted or empty. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The SKU defining the throughput and SIM allowances for this packet core control plane deployment. ,
Enum:
{
G0: 100 Mbps, 20 active SIMs plan, 2 RANs ,
G1: 1 Gbps, 100 active SIMs plan, 5 RANs ,
G2: 2 Gbps, 200 active SIMs plan, 10 RANs ,
G5: 5 Gbps, 500 active SIMs plan ,
G10: 10 Gbps, 1000 active SIMs plan ,
}
,
Required: True ,
}
enum ,
ueMtu:
{
Description: The MTU (in bytes) signaled to the UE. The same MTU is set on the user plane data links for all data networks. The MTU set on the user plane access link is calculated to be 60 bytes greater than this value to allow for GTP encapsulation. ,
Format: int32 ,
Required: False ,
}
integer ,
localDiagnosticsAccess:
{
Description: The kubernetes ingress configuration to control access to packet core diagnostics over local APIs. ,
Required: True ,
}
{
authenticationType:
{
Description: How to authenticate users who access local diagnostics APIs. ,
Enum:
{
AAD: Use AAD SSO to authenticate the user (this requires internet access). ,
Password: Use locally stored passwords to authenticate the user. ,
}
,
Required: True ,
}
enum ,
httpsServerCertificate:
{
Description: The HTTPS server TLS certificate used to secure local access to diagnostics. ,
Required: False ,
}
{
certificateUrl:
{
Description: The certificate URL, unversioned. For example: https://contosovault.vault.azure.net/certificates/ingress. ,
Required: True ,
}
string ,
provisioning:
{
Description: The provisioning state of the certificate. ,
Required: False ,
}
{
state:
{
Description: The certificate's provisioning state ,
Enum:
{
NotProvisioned: The certificate has not been provisioned. ,
Provisioned: The certificate has been provisioned. ,
Failed: The certificate failed to be provisioned. The "reason" property explains why. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: Reason for certificate provisioning failure. ,
Required: False ,
}
string ,
}
,
}
,
}
,
diagnosticsUpload:
{
Description: Configuration for uploading packet core diagnostics ,
Required: False ,
}
{
storageAccountContainerUrl:
{
Description: The Storage Account Container URL to upload diagnostics to. ,
Required: True ,
}
string ,
}
,
eventHub:
{
Description: Configuration for sending packet core events to an Azure Event Hub. ,
Required: False ,
}
{
id:
{
Description: Resource ID of Azure Event Hub to send packet core events to. ,
Required: True ,
}
string ,
reportingInterval:
{
Description: The duration (in seconds) between UE usage reports. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
signaling:
{
Description: Signaling configuration for the packet core. ,
Required: False ,
}
{
nasReroute:
{
Description: Configuration enabling 4G NAS reroute. ,
Required: False ,
}
{
macroMmeGroupId:
{
Description: The macro network's MME group ID. This is where unknown UEs are sent to via NAS reroute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
nasEncryption:
{
Description: An ordered list of NAS encryption algorithms, used to encrypt control plane traffic between the UE and packet core, in order from most to least preferred. If not specified, the packet core will use a built-in default ordering. ,
Required: False ,
}
[
string ,
]
,
}
,
interopSettings:
{
Description: Settings to allow interoperability with third party components e.g. RANs and UEs. ,
Required: False ,
}
object ,
homeNetworkPrivateKeysProvisioning:
{
Description: The provisioning state of the secret containing private keys and keyIds for SUPI concealment. ,
Required: False ,
}
{
state:
{
Description: The provisioning state of the private keys for SUPI concealment. ,
Enum:
{
NotProvisioned: Provisioning of the private keys for SUPI concealment has not been attempted. ,
Provisioned: The private keys for SUPI concealment are successfully provisioned. ,
Failed: Provisioning of the private keys for SUPI concealment has failed. ,
}
,
Required: True ,
}
enum ,
}
,
userConsent:
{
Description: The user consent configuration for the packet core. ,
Required: False ,
}
{
allowSupportTelemetryAccess:
{
Description: Allow Microsoft to access non-PII telemetry information from the packet core. ,
Required: False ,
}
boolean ,
}
,
}
,
identity:
{
Description: The identity used to retrieve the ingress certificate from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
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. The value must be an UUID. ,
Format: uuid ,
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 ,
installation:
{
Description: The installation state of the packet core control plane resource. ,
Required: False ,
}
{
desiredState:
{
Description: The desired installation state ,
Enum:
{
Uninstalled: Don't install the packet core. ,
Installed: Install the packet core. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Installation state ,
Enum:
{
Uninstalled: The packet core is uninstalled. ,
Installing: The packet core is installing. ,
Installed: The packet core is installed. ,
Updating: The packet core is updating its configuration. ,
Upgrading: The packet core is upgrading to a different software version. ,
Uninstalling: The packet core is uninstalling. ,
Reinstalling: The packet core is reinstalling. ,
RollingBack: The packet core is rolling back to its previous version. ,
Failed: The packet core is in failed state. ,
}
,
Required: False ,
}
enum ,
reinstallRequired:
{
Description: Whether a reinstall of the packet core is required to pick up the latest configuration changes. ,
Enum:
{
Required: A reinstall of the packet core is required. ,
NotRequired: A reinstall of the packet core is not required. ,
}
,
Required: False ,
}
enum ,
reasons:
{
Description: Reason(s) for the current installation state of the packet core. ,
Required: False ,
}
[
string ,
]
,
operation:
{
Description: A reference to an in-progress installation operation ,
Required: False ,
}
{
id:
{
Description: Azure Async Operation ID. ,
Required: True ,
}
string ,
}
,
}
,
sites:
{
Description: Site(s) under which this packet core control plane should be deployed. The sites must be in the same location as the packet core control plane. ,
Required: True ,
}
[
{
id:
{
Description: Site resource ID. ,
Required: True ,
}
string ,
}
,
]
,
platform:
{
Description: The platform where the packet core is deployed. ,
Required: True ,
}
{
type:
{
Description: The platform type where packet core is deployed. ,
Enum:
{
AKS-HCI: If this option is chosen, you must set one of "azureStackEdgeDevice", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
3P-AZURE-STACK-HCI: If this option is chosen, you must set one of "azureStackHciCluster", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
}
,
Required: True ,
}
enum ,
azureStackEdgeDevice:
{
Description: The Azure Stack Edge device where the packet core is deployed. If the device is part of a fault tolerant pair, either device in the pair can be specified. ,
Required: False ,
}
{
id:
{
Description: Azure Stack Edge device resource ID. ,
Required: True ,
}
string ,
}
,
azureStackEdgeDevices:
{
Description: The Azure Stack Edge devices where the packet core is deployed. If the packet core is deployed across multiple devices, all devices will appear in this list. ,
Required: False ,
}
[
{
id:
{
Description: Azure Stack Edge device resource ID. ,
Required: True ,
}
string ,
}
,
]
,
azureStackHciCluster:
{
Description: The Azure Stack HCI cluster where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure Stack HCI cluster resource ID. ,
Required: True ,
}
string ,
}
,
connectedCluster:
{
Description: Azure Arc connected cluster where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure Arc connected cluster 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 (5G core or EPC / 4G core). ,
Enum:
{
5GC: 5G core ,
EPC: EPC / 4G core ,
EPC + 5GC: Combined EPC / 4G and 5G core ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The desired version of the packet core software. ,
Required: False ,
}
string ,
installedVersion:
{
Description: The currently installed version of the packet core software. ,
Required: False ,
}
string ,
rollbackVersion:
{
Description: The previous version of the packet core software that was deployed. Used when performing the rollback action. ,
Required: False ,
}
string ,
controlPlaneAccessInterface:
{
Description: The control plane interface on the access network. For 5G networks, this is the N2 interface. For 4G networks, this is the 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 device. ,
Required: False ,
}
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 ,
vlanId:
{
Description: VLAN identifier of the network interface. Example: 501. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4AddressList:
{
Description: The list of IPv4 addresses, for a multi-node system. ,
Required: False ,
}
[
string ,
]
,
bfdIpv4Endpoints:
{
Description: The IPv4 addresses of the endpoints to send BFD probes to. ,
Required: False ,
}
[
string ,
]
,
}
,
controlPlaneAccessVirtualIpv4Addresses:
{
Description: The virtual IP address(es) for the control plane on the access network in a High Availability (HA) system. In an HA deployment the access network router should be configured to anycast traffic for this address to the control plane access interfaces on the active and standby nodes. In non-HA system this list should be omitted or empty. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The SKU defining the throughput and SIM allowances for this packet core control plane deployment. ,
Enum:
{
G0: 100 Mbps, 20 active SIMs plan, 2 RANs ,
G1: 1 Gbps, 100 active SIMs plan, 5 RANs ,
G2: 2 Gbps, 200 active SIMs plan, 10 RANs ,
G5: 5 Gbps, 500 active SIMs plan ,
G10: 10 Gbps, 1000 active SIMs plan ,
}
,
Required: True ,
}
enum ,
ueMtu:
{
Description: The MTU (in bytes) signaled to the UE. The same MTU is set on the user plane data links for all data networks. The MTU set on the user plane access link is calculated to be 60 bytes greater than this value to allow for GTP encapsulation. ,
Format: int32 ,
Required: False ,
}
integer ,
localDiagnosticsAccess:
{
Description: The kubernetes ingress configuration to control access to packet core diagnostics over local APIs. ,
Required: True ,
}
{
authenticationType:
{
Description: How to authenticate users who access local diagnostics APIs. ,
Enum:
{
AAD: Use AAD SSO to authenticate the user (this requires internet access). ,
Password: Use locally stored passwords to authenticate the user. ,
}
,
Required: True ,
}
enum ,
httpsServerCertificate:
{
Description: The HTTPS server TLS certificate used to secure local access to diagnostics. ,
Required: False ,
}
{
certificateUrl:
{
Description: The certificate URL, unversioned. For example: https://contosovault.vault.azure.net/certificates/ingress. ,
Required: True ,
}
string ,
provisioning:
{
Description: The provisioning state of the certificate. ,
Required: False ,
}
{
state:
{
Description: The certificate's provisioning state ,
Enum:
{
NotProvisioned: The certificate has not been provisioned. ,
Provisioned: The certificate has been provisioned. ,
Failed: The certificate failed to be provisioned. The "reason" property explains why. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: Reason for certificate provisioning failure. ,
Required: False ,
}
string ,
}
,
}
,
}
,
diagnosticsUpload:
{
Description: Configuration for uploading packet core diagnostics ,
Required: False ,
}
{
storageAccountContainerUrl:
{
Description: The Storage Account Container URL to upload diagnostics to. ,
Required: True ,
}
string ,
}
,
eventHub:
{
Description: Configuration for sending packet core events to an Azure Event Hub. ,
Required: False ,
}
{
id:
{
Description: Resource ID of Azure Event Hub to send packet core events to. ,
Required: True ,
}
string ,
reportingInterval:
{
Description: The duration (in seconds) between UE usage reports. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
signaling:
{
Description: Signaling configuration for the packet core. ,
Required: False ,
}
{
nasReroute:
{
Description: Configuration enabling 4G NAS reroute. ,
Required: False ,
}
{
macroMmeGroupId:
{
Description: The macro network's MME group ID. This is where unknown UEs are sent to via NAS reroute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
nasEncryption:
{
Description: An ordered list of NAS encryption algorithms, used to encrypt control plane traffic between the UE and packet core, in order from most to least preferred. If not specified, the packet core will use a built-in default ordering. ,
Required: False ,
}
[
string ,
]
,
}
,
interopSettings:
{
Description: Settings to allow interoperability with third party components e.g. RANs and UEs. ,
Required: False ,
}
object ,
homeNetworkPrivateKeysProvisioning:
{
Description: The provisioning state of the secret containing private keys and keyIds for SUPI concealment. ,
Required: False ,
}
{
state:
{
Description: The provisioning state of the private keys for SUPI concealment. ,
Enum:
{
NotProvisioned: Provisioning of the private keys for SUPI concealment has not been attempted. ,
Provisioned: The private keys for SUPI concealment are successfully provisioned. ,
Failed: Provisioning of the private keys for SUPI concealment has failed. ,
}
,
Required: True ,
}
enum ,
}
,
userConsent:
{
Description: The user consent configuration for the packet core. ,
Required: False ,
}
{
allowSupportTelemetryAccess:
{
Description: Allow Microsoft to access non-PII telemetry information from the packet core. ,
Required: False ,
}
boolean ,
}
,
}
,
identity:
{
Description: The identity used to retrieve the ingress certificate from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
installation:
{
Description: The installation state of the packet core control plane resource. ,
Required: False ,
}
{
desiredState:
{
Description: The desired installation state ,
Enum:
{
Uninstalled: Don't install the packet core. ,
Installed: Install the packet core. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Installation state ,
Enum:
{
Uninstalled: The packet core is uninstalled. ,
Installing: The packet core is installing. ,
Installed: The packet core is installed. ,
Updating: The packet core is updating its configuration. ,
Upgrading: The packet core is upgrading to a different software version. ,
Uninstalling: The packet core is uninstalling. ,
Reinstalling: The packet core is reinstalling. ,
RollingBack: The packet core is rolling back to its previous version. ,
Failed: The packet core is in failed state. ,
}
,
Required: False ,
}
enum ,
reinstallRequired:
{
Description: Whether a reinstall of the packet core is required to pick up the latest configuration changes. ,
Enum:
{
Required: A reinstall of the packet core is required. ,
NotRequired: A reinstall of the packet core is not required. ,
}
,
Required: False ,
}
enum ,
reasons:
{
Description: Reason(s) for the current installation state of the packet core. ,
Required: False ,
}
[
string ,
]
,
operation:
{
Description: A reference to an in-progress installation operation ,
Required: False ,
}
{
id:
{
Description: Azure Async Operation ID. ,
Required: True ,
}
string ,
}
,
}
,
sites:
{
Description: Site(s) under which this packet core control plane should be deployed. The sites must be in the same location as the packet core control plane. ,
Required: True ,
}
[
{
id:
{
Description: Site resource ID. ,
Required: True ,
}
string ,
}
,
]
,
platform:
{
Description: The platform where the packet core is deployed. ,
Required: True ,
}
{
type:
{
Description: The platform type where packet core is deployed. ,
Enum:
{
AKS-HCI: If this option is chosen, you must set one of "azureStackEdgeDevice", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
3P-AZURE-STACK-HCI: If this option is chosen, you must set one of "azureStackHciCluster", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
}
,
Required: True ,
}
enum ,
azureStackEdgeDevice:
{
Description: The Azure Stack Edge device where the packet core is deployed. If the device is part of a fault tolerant pair, either device in the pair can be specified. ,
Required: False ,
}
{
id:
{
Description: Azure Stack Edge device resource ID. ,
Required: True ,
}
string ,
}
,
azureStackEdgeDevices:
{
Description: The Azure Stack Edge devices where the packet core is deployed. If the packet core is deployed across multiple devices, all devices will appear in this list. ,
Required: False ,
}
[
{
id:
{
Description: Azure Stack Edge device resource ID. ,
Required: True ,
}
string ,
}
,
]
,
azureStackHciCluster:
{
Description: The Azure Stack HCI cluster where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure Stack HCI cluster resource ID. ,
Required: True ,
}
string ,
}
,
connectedCluster:
{
Description: Azure Arc connected cluster where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure Arc connected cluster 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 (5G core or EPC / 4G core). ,
Enum:
{
5GC: 5G core ,
EPC: EPC / 4G core ,
EPC + 5GC: Combined EPC / 4G and 5G core ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The desired version of the packet core software. ,
Required: False ,
}
string ,
installedVersion:
{
Description: The currently installed version of the packet core software. ,
Required: False ,
}
string ,
rollbackVersion:
{
Description: The previous version of the packet core software that was deployed. Used when performing the rollback action. ,
Required: False ,
}
string ,
controlPlaneAccessInterface:
{
Description: The control plane interface on the access network. For 5G networks, this is the N2 interface. For 4G networks, this is the 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 device. ,
Required: False ,
}
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 ,
vlanId:
{
Description: VLAN identifier of the network interface. Example: 501. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4AddressList:
{
Description: The list of IPv4 addresses, for a multi-node system. ,
Required: False ,
}
[
string ,
]
,
bfdIpv4Endpoints:
{
Description: The IPv4 addresses of the endpoints to send BFD probes to. ,
Required: False ,
}
[
string ,
]
,
}
,
controlPlaneAccessVirtualIpv4Addresses:
{
Description: The virtual IP address(es) for the control plane on the access network in a High Availability (HA) system. In an HA deployment the access network router should be configured to anycast traffic for this address to the control plane access interfaces on the active and standby nodes. In non-HA system this list should be omitted or empty. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The SKU defining the throughput and SIM allowances for this packet core control plane deployment. ,
Enum:
{
G0: 100 Mbps, 20 active SIMs plan, 2 RANs ,
G1: 1 Gbps, 100 active SIMs plan, 5 RANs ,
G2: 2 Gbps, 200 active SIMs plan, 10 RANs ,
G5: 5 Gbps, 500 active SIMs plan ,
G10: 10 Gbps, 1000 active SIMs plan ,
}
,
Required: True ,
}
enum ,
ueMtu:
{
Description: The MTU (in bytes) signaled to the UE. The same MTU is set on the user plane data links for all data networks. The MTU set on the user plane access link is calculated to be 60 bytes greater than this value to allow for GTP encapsulation. ,
Format: int32 ,
Required: False ,
}
integer ,
localDiagnosticsAccess:
{
Description: The kubernetes ingress configuration to control access to packet core diagnostics over local APIs. ,
Required: True ,
}
{
authenticationType:
{
Description: How to authenticate users who access local diagnostics APIs. ,
Enum:
{
AAD: Use AAD SSO to authenticate the user (this requires internet access). ,
Password: Use locally stored passwords to authenticate the user. ,
}
,
Required: True ,
}
enum ,
httpsServerCertificate:
{
Description: The HTTPS server TLS certificate used to secure local access to diagnostics. ,
Required: False ,
}
{
certificateUrl:
{
Description: The certificate URL, unversioned. For example: https://contosovault.vault.azure.net/certificates/ingress. ,
Required: True ,
}
string ,
provisioning:
{
Description: The provisioning state of the certificate. ,
Required: False ,
}
{
state:
{
Description: The certificate's provisioning state ,
Enum:
{
NotProvisioned: The certificate has not been provisioned. ,
Provisioned: The certificate has been provisioned. ,
Failed: The certificate failed to be provisioned. The "reason" property explains why. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: Reason for certificate provisioning failure. ,
Required: False ,
}
string ,
}
,
}
,
}
,
diagnosticsUpload:
{
Description: Configuration for uploading packet core diagnostics ,
Required: False ,
}
{
storageAccountContainerUrl:
{
Description: The Storage Account Container URL to upload diagnostics to. ,
Required: True ,
}
string ,
}
,
eventHub:
{
Description: Configuration for sending packet core events to an Azure Event Hub. ,
Required: False ,
}
{
id:
{
Description: Resource ID of Azure Event Hub to send packet core events to. ,
Required: True ,
}
string ,
reportingInterval:
{
Description: The duration (in seconds) between UE usage reports. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
signaling:
{
Description: Signaling configuration for the packet core. ,
Required: False ,
}
{
nasReroute:
{
Description: Configuration enabling 4G NAS reroute. ,
Required: False ,
}
{
macroMmeGroupId:
{
Description: The macro network's MME group ID. This is where unknown UEs are sent to via NAS reroute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
nasEncryption:
{
Description: An ordered list of NAS encryption algorithms, used to encrypt control plane traffic between the UE and packet core, in order from most to least preferred. If not specified, the packet core will use a built-in default ordering. ,
Required: False ,
}
[
string ,
]
,
}
,
interopSettings:
{
Description: Settings to allow interoperability with third party components e.g. RANs and UEs. ,
Required: False ,
}
object ,
homeNetworkPrivateKeysProvisioning:
{
Description: The provisioning state of the secret containing private keys and keyIds for SUPI concealment. ,
Required: False ,
}
{
state:
{
Description: The provisioning state of the private keys for SUPI concealment. ,
Enum:
{
NotProvisioned: Provisioning of the private keys for SUPI concealment has not been attempted. ,
Provisioned: The private keys for SUPI concealment are successfully provisioned. ,
Failed: Provisioning of the private keys for SUPI concealment has failed. ,
}
,
Required: True ,
}
enum ,
}
,
userConsent:
{
Description: The user consent configuration for the packet core. ,
Required: False ,
}
{
allowSupportTelemetryAccess:
{
Description: Allow Microsoft to access non-PII telemetry information from the packet core. ,
Required: False ,
}
boolean ,
}
,
}
,
identity:
{
Description: The identity used to retrieve the ingress certificate from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 :  Patch packet core control plane resource.
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 patch packet core control plane resource. ,
Required: True ,
}
{
identity:
{
Description: The managed service identity associated with this resource. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
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. The value must be an UUID. ,
Format: uuid ,
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 ,
installation:
{
Description: The installation state of the packet core control plane resource. ,
Required: False ,
}
{
desiredState:
{
Description: The desired installation state ,
Enum:
{
Uninstalled: Don't install the packet core. ,
Installed: Install the packet core. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Installation state ,
Enum:
{
Uninstalled: The packet core is uninstalled. ,
Installing: The packet core is installing. ,
Installed: The packet core is installed. ,
Updating: The packet core is updating its configuration. ,
Upgrading: The packet core is upgrading to a different software version. ,
Uninstalling: The packet core is uninstalling. ,
Reinstalling: The packet core is reinstalling. ,
RollingBack: The packet core is rolling back to its previous version. ,
Failed: The packet core is in failed state. ,
}
,
Required: False ,
}
enum ,
reinstallRequired:
{
Description: Whether a reinstall of the packet core is required to pick up the latest configuration changes. ,
Enum:
{
Required: A reinstall of the packet core is required. ,
NotRequired: A reinstall of the packet core is not required. ,
}
,
Required: False ,
}
enum ,
reasons:
{
Description: Reason(s) for the current installation state of the packet core. ,
Required: False ,
}
[
string ,
]
,
operation:
{
Description: A reference to an in-progress installation operation ,
Required: False ,
}
{
id:
{
Description: Azure Async Operation ID. ,
Required: True ,
}
string ,
}
,
}
,
sites:
{
Description: Site(s) under which this packet core control plane should be deployed. The sites must be in the same location as the packet core control plane. ,
Required: True ,
}
[
{
id:
{
Description: Site resource ID. ,
Required: True ,
}
string ,
}
,
]
,
platform:
{
Description: The platform where the packet core is deployed. ,
Required: True ,
}
{
type:
{
Description: The platform type where packet core is deployed. ,
Enum:
{
AKS-HCI: If this option is chosen, you must set one of "azureStackEdgeDevice", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
3P-AZURE-STACK-HCI: If this option is chosen, you must set one of "azureStackHciCluster", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
}
,
Required: True ,
}
enum ,
azureStackEdgeDevice:
{
Description: The Azure Stack Edge device where the packet core is deployed. If the device is part of a fault tolerant pair, either device in the pair can be specified. ,
Required: False ,
}
{
id:
{
Description: Azure Stack Edge device resource ID. ,
Required: True ,
}
string ,
}
,
azureStackEdgeDevices:
{
Description: The Azure Stack Edge devices where the packet core is deployed. If the packet core is deployed across multiple devices, all devices will appear in this list. ,
Required: False ,
}
[
{
id:
{
Description: Azure Stack Edge device resource ID. ,
Required: True ,
}
string ,
}
,
]
,
azureStackHciCluster:
{
Description: The Azure Stack HCI cluster where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure Stack HCI cluster resource ID. ,
Required: True ,
}
string ,
}
,
connectedCluster:
{
Description: Azure Arc connected cluster where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure Arc connected cluster 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 (5G core or EPC / 4G core). ,
Enum:
{
5GC: 5G core ,
EPC: EPC / 4G core ,
EPC + 5GC: Combined EPC / 4G and 5G core ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The desired version of the packet core software. ,
Required: False ,
}
string ,
installedVersion:
{
Description: The currently installed version of the packet core software. ,
Required: False ,
}
string ,
rollbackVersion:
{
Description: The previous version of the packet core software that was deployed. Used when performing the rollback action. ,
Required: False ,
}
string ,
controlPlaneAccessInterface:
{
Description: The control plane interface on the access network. For 5G networks, this is the N2 interface. For 4G networks, this is the 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 device. ,
Required: False ,
}
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 ,
vlanId:
{
Description: VLAN identifier of the network interface. Example: 501. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4AddressList:
{
Description: The list of IPv4 addresses, for a multi-node system. ,
Required: False ,
}
[
string ,
]
,
bfdIpv4Endpoints:
{
Description: The IPv4 addresses of the endpoints to send BFD probes to. ,
Required: False ,
}
[
string ,
]
,
}
,
controlPlaneAccessVirtualIpv4Addresses:
{
Description: The virtual IP address(es) for the control plane on the access network in a High Availability (HA) system. In an HA deployment the access network router should be configured to anycast traffic for this address to the control plane access interfaces on the active and standby nodes. In non-HA system this list should be omitted or empty. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The SKU defining the throughput and SIM allowances for this packet core control plane deployment. ,
Enum:
{
G0: 100 Mbps, 20 active SIMs plan, 2 RANs ,
G1: 1 Gbps, 100 active SIMs plan, 5 RANs ,
G2: 2 Gbps, 200 active SIMs plan, 10 RANs ,
G5: 5 Gbps, 500 active SIMs plan ,
G10: 10 Gbps, 1000 active SIMs plan ,
}
,
Required: True ,
}
enum ,
ueMtu:
{
Description: The MTU (in bytes) signaled to the UE. The same MTU is set on the user plane data links for all data networks. The MTU set on the user plane access link is calculated to be 60 bytes greater than this value to allow for GTP encapsulation. ,
Format: int32 ,
Required: False ,
}
integer ,
localDiagnosticsAccess:
{
Description: The kubernetes ingress configuration to control access to packet core diagnostics over local APIs. ,
Required: True ,
}
{
authenticationType:
{
Description: How to authenticate users who access local diagnostics APIs. ,
Enum:
{
AAD: Use AAD SSO to authenticate the user (this requires internet access). ,
Password: Use locally stored passwords to authenticate the user. ,
}
,
Required: True ,
}
enum ,
httpsServerCertificate:
{
Description: The HTTPS server TLS certificate used to secure local access to diagnostics. ,
Required: False ,
}
{
certificateUrl:
{
Description: The certificate URL, unversioned. For example: https://contosovault.vault.azure.net/certificates/ingress. ,
Required: True ,
}
string ,
provisioning:
{
Description: The provisioning state of the certificate. ,
Required: False ,
}
{
state:
{
Description: The certificate's provisioning state ,
Enum:
{
NotProvisioned: The certificate has not been provisioned. ,
Provisioned: The certificate has been provisioned. ,
Failed: The certificate failed to be provisioned. The "reason" property explains why. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: Reason for certificate provisioning failure. ,
Required: False ,
}
string ,
}
,
}
,
}
,
diagnosticsUpload:
{
Description: Configuration for uploading packet core diagnostics ,
Required: False ,
}
{
storageAccountContainerUrl:
{
Description: The Storage Account Container URL to upload diagnostics to. ,
Required: True ,
}
string ,
}
,
eventHub:
{
Description: Configuration for sending packet core events to an Azure Event Hub. ,
Required: False ,
}
{
id:
{
Description: Resource ID of Azure Event Hub to send packet core events to. ,
Required: True ,
}
string ,
reportingInterval:
{
Description: The duration (in seconds) between UE usage reports. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
signaling:
{
Description: Signaling configuration for the packet core. ,
Required: False ,
}
{
nasReroute:
{
Description: Configuration enabling 4G NAS reroute. ,
Required: False ,
}
{
macroMmeGroupId:
{
Description: The macro network's MME group ID. This is where unknown UEs are sent to via NAS reroute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
nasEncryption:
{
Description: An ordered list of NAS encryption algorithms, used to encrypt control plane traffic between the UE and packet core, in order from most to least preferred. If not specified, the packet core will use a built-in default ordering. ,
Required: False ,
}
[
string ,
]
,
}
,
interopSettings:
{
Description: Settings to allow interoperability with third party components e.g. RANs and UEs. ,
Required: False ,
}
object ,
homeNetworkPrivateKeysProvisioning:
{
Description: The provisioning state of the secret containing private keys and keyIds for SUPI concealment. ,
Required: False ,
}
{
state:
{
Description: The provisioning state of the private keys for SUPI concealment. ,
Enum:
{
NotProvisioned: Provisioning of the private keys for SUPI concealment has not been attempted. ,
Provisioned: The private keys for SUPI concealment are successfully provisioned. ,
Failed: Provisioning of the private keys for SUPI concealment has failed. ,
}
,
Required: True ,
}
enum ,
}
,
userConsent:
{
Description: The user consent configuration for the packet core. ,
Required: False ,
}
{
allowSupportTelemetryAccess:
{
Description: Allow Microsoft to access non-PII telemetry information from the packet core. ,
Required: False ,
}
boolean ,
}
,
}
,
identity:
{
Description: The identity used to retrieve the ingress certificate from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 packet core control planes 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. The value must be an UUID. ,
Format: uuid ,
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 ,
installation:
{
Description: The installation state of the packet core control plane resource. ,
Required: False ,
}
{
desiredState:
{
Description: The desired installation state ,
Enum:
{
Uninstalled: Don't install the packet core. ,
Installed: Install the packet core. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Installation state ,
Enum:
{
Uninstalled: The packet core is uninstalled. ,
Installing: The packet core is installing. ,
Installed: The packet core is installed. ,
Updating: The packet core is updating its configuration. ,
Upgrading: The packet core is upgrading to a different software version. ,
Uninstalling: The packet core is uninstalling. ,
Reinstalling: The packet core is reinstalling. ,
RollingBack: The packet core is rolling back to its previous version. ,
Failed: The packet core is in failed state. ,
}
,
Required: False ,
}
enum ,
reinstallRequired:
{
Description: Whether a reinstall of the packet core is required to pick up the latest configuration changes. ,
Enum:
{
Required: A reinstall of the packet core is required. ,
NotRequired: A reinstall of the packet core is not required. ,
}
,
Required: False ,
}
enum ,
reasons:
{
Description: Reason(s) for the current installation state of the packet core. ,
Required: False ,
}
[
string ,
]
,
operation:
{
Description: A reference to an in-progress installation operation ,
Required: False ,
}
{
id:
{
Description: Azure Async Operation ID. ,
Required: True ,
}
string ,
}
,
}
,
sites:
{
Description: Site(s) under which this packet core control plane should be deployed. The sites must be in the same location as the packet core control plane. ,
Required: True ,
}
[
{
id:
{
Description: Site resource ID. ,
Required: True ,
}
string ,
}
,
]
,
platform:
{
Description: The platform where the packet core is deployed. ,
Required: True ,
}
{
type:
{
Description: The platform type where packet core is deployed. ,
Enum:
{
AKS-HCI: If this option is chosen, you must set one of "azureStackEdgeDevice", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
3P-AZURE-STACK-HCI: If this option is chosen, you must set one of "azureStackHciCluster", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
}
,
Required: True ,
}
enum ,
azureStackEdgeDevice:
{
Description: The Azure Stack Edge device where the packet core is deployed. If the device is part of a fault tolerant pair, either device in the pair can be specified. ,
Required: False ,
}
{
id:
{
Description: Azure Stack Edge device resource ID. ,
Required: True ,
}
string ,
}
,
azureStackEdgeDevices:
{
Description: The Azure Stack Edge devices where the packet core is deployed. If the packet core is deployed across multiple devices, all devices will appear in this list. ,
Required: False ,
}
[
{
id:
{
Description: Azure Stack Edge device resource ID. ,
Required: True ,
}
string ,
}
,
]
,
azureStackHciCluster:
{
Description: The Azure Stack HCI cluster where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure Stack HCI cluster resource ID. ,
Required: True ,
}
string ,
}
,
connectedCluster:
{
Description: Azure Arc connected cluster where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure Arc connected cluster 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 (5G core or EPC / 4G core). ,
Enum:
{
5GC: 5G core ,
EPC: EPC / 4G core ,
EPC + 5GC: Combined EPC / 4G and 5G core ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The desired version of the packet core software. ,
Required: False ,
}
string ,
installedVersion:
{
Description: The currently installed version of the packet core software. ,
Required: False ,
}
string ,
rollbackVersion:
{
Description: The previous version of the packet core software that was deployed. Used when performing the rollback action. ,
Required: False ,
}
string ,
controlPlaneAccessInterface:
{
Description: The control plane interface on the access network. For 5G networks, this is the N2 interface. For 4G networks, this is the 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 device. ,
Required: False ,
}
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 ,
vlanId:
{
Description: VLAN identifier of the network interface. Example: 501. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4AddressList:
{
Description: The list of IPv4 addresses, for a multi-node system. ,
Required: False ,
}
[
string ,
]
,
bfdIpv4Endpoints:
{
Description: The IPv4 addresses of the endpoints to send BFD probes to. ,
Required: False ,
}
[
string ,
]
,
}
,
controlPlaneAccessVirtualIpv4Addresses:
{
Description: The virtual IP address(es) for the control plane on the access network in a High Availability (HA) system. In an HA deployment the access network router should be configured to anycast traffic for this address to the control plane access interfaces on the active and standby nodes. In non-HA system this list should be omitted or empty. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The SKU defining the throughput and SIM allowances for this packet core control plane deployment. ,
Enum:
{
G0: 100 Mbps, 20 active SIMs plan, 2 RANs ,
G1: 1 Gbps, 100 active SIMs plan, 5 RANs ,
G2: 2 Gbps, 200 active SIMs plan, 10 RANs ,
G5: 5 Gbps, 500 active SIMs plan ,
G10: 10 Gbps, 1000 active SIMs plan ,
}
,
Required: True ,
}
enum ,
ueMtu:
{
Description: The MTU (in bytes) signaled to the UE. The same MTU is set on the user plane data links for all data networks. The MTU set on the user plane access link is calculated to be 60 bytes greater than this value to allow for GTP encapsulation. ,
Format: int32 ,
Required: False ,
}
integer ,
localDiagnosticsAccess:
{
Description: The kubernetes ingress configuration to control access to packet core diagnostics over local APIs. ,
Required: True ,
}
{
authenticationType:
{
Description: How to authenticate users who access local diagnostics APIs. ,
Enum:
{
AAD: Use AAD SSO to authenticate the user (this requires internet access). ,
Password: Use locally stored passwords to authenticate the user. ,
}
,
Required: True ,
}
enum ,
httpsServerCertificate:
{
Description: The HTTPS server TLS certificate used to secure local access to diagnostics. ,
Required: False ,
}
{
certificateUrl:
{
Description: The certificate URL, unversioned. For example: https://contosovault.vault.azure.net/certificates/ingress. ,
Required: True ,
}
string ,
provisioning:
{
Description: The provisioning state of the certificate. ,
Required: False ,
}
{
state:
{
Description: The certificate's provisioning state ,
Enum:
{
NotProvisioned: The certificate has not been provisioned. ,
Provisioned: The certificate has been provisioned. ,
Failed: The certificate failed to be provisioned. The "reason" property explains why. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: Reason for certificate provisioning failure. ,
Required: False ,
}
string ,
}
,
}
,
}
,
diagnosticsUpload:
{
Description: Configuration for uploading packet core diagnostics ,
Required: False ,
}
{
storageAccountContainerUrl:
{
Description: The Storage Account Container URL to upload diagnostics to. ,
Required: True ,
}
string ,
}
,
eventHub:
{
Description: Configuration for sending packet core events to an Azure Event Hub. ,
Required: False ,
}
{
id:
{
Description: Resource ID of Azure Event Hub to send packet core events to. ,
Required: True ,
}
string ,
reportingInterval:
{
Description: The duration (in seconds) between UE usage reports. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
signaling:
{
Description: Signaling configuration for the packet core. ,
Required: False ,
}
{
nasReroute:
{
Description: Configuration enabling 4G NAS reroute. ,
Required: False ,
}
{
macroMmeGroupId:
{
Description: The macro network's MME group ID. This is where unknown UEs are sent to via NAS reroute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
nasEncryption:
{
Description: An ordered list of NAS encryption algorithms, used to encrypt control plane traffic between the UE and packet core, in order from most to least preferred. If not specified, the packet core will use a built-in default ordering. ,
Required: False ,
}
[
string ,
]
,
}
,
interopSettings:
{
Description: Settings to allow interoperability with third party components e.g. RANs and UEs. ,
Required: False ,
}
object ,
homeNetworkPrivateKeysProvisioning:
{
Description: The provisioning state of the secret containing private keys and keyIds for SUPI concealment. ,
Required: False ,
}
{
state:
{
Description: The provisioning state of the private keys for SUPI concealment. ,
Enum:
{
NotProvisioned: Provisioning of the private keys for SUPI concealment has not been attempted. ,
Provisioned: The private keys for SUPI concealment are successfully provisioned. ,
Failed: Provisioning of the private keys for SUPI concealment has failed. ,
}
,
Required: True ,
}
enum ,
}
,
userConsent:
{
Description: The user consent configuration for the packet core. ,
Required: False ,
}
{
allowSupportTelemetryAccess:
{
Description: Allow Microsoft to access non-PII telemetry information from the packet core. ,
Required: False ,
}
boolean ,
}
,
}
,
identity:
{
Description: The identity used to retrieve the ingress certificate from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
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 packet core control planes 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. The value must be an UUID. ,
Format: uuid ,
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 ,
installation:
{
Description: The installation state of the packet core control plane resource. ,
Required: False ,
}
{
desiredState:
{
Description: The desired installation state ,
Enum:
{
Uninstalled: Don't install the packet core. ,
Installed: Install the packet core. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Installation state ,
Enum:
{
Uninstalled: The packet core is uninstalled. ,
Installing: The packet core is installing. ,
Installed: The packet core is installed. ,
Updating: The packet core is updating its configuration. ,
Upgrading: The packet core is upgrading to a different software version. ,
Uninstalling: The packet core is uninstalling. ,
Reinstalling: The packet core is reinstalling. ,
RollingBack: The packet core is rolling back to its previous version. ,
Failed: The packet core is in failed state. ,
}
,
Required: False ,
}
enum ,
reinstallRequired:
{
Description: Whether a reinstall of the packet core is required to pick up the latest configuration changes. ,
Enum:
{
Required: A reinstall of the packet core is required. ,
NotRequired: A reinstall of the packet core is not required. ,
}
,
Required: False ,
}
enum ,
reasons:
{
Description: Reason(s) for the current installation state of the packet core. ,
Required: False ,
}
[
string ,
]
,
operation:
{
Description: A reference to an in-progress installation operation ,
Required: False ,
}
{
id:
{
Description: Azure Async Operation ID. ,
Required: True ,
}
string ,
}
,
}
,
sites:
{
Description: Site(s) under which this packet core control plane should be deployed. The sites must be in the same location as the packet core control plane. ,
Required: True ,
}
[
{
id:
{
Description: Site resource ID. ,
Required: True ,
}
string ,
}
,
]
,
platform:
{
Description: The platform where the packet core is deployed. ,
Required: True ,
}
{
type:
{
Description: The platform type where packet core is deployed. ,
Enum:
{
AKS-HCI: If this option is chosen, you must set one of "azureStackEdgeDevice", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
3P-AZURE-STACK-HCI: If this option is chosen, you must set one of "azureStackHciCluster", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
}
,
Required: True ,
}
enum ,
azureStackEdgeDevice:
{
Description: The Azure Stack Edge device where the packet core is deployed. If the device is part of a fault tolerant pair, either device in the pair can be specified. ,
Required: False ,
}
{
id:
{
Description: Azure Stack Edge device resource ID. ,
Required: True ,
}
string ,
}
,
azureStackEdgeDevices:
{
Description: The Azure Stack Edge devices where the packet core is deployed. If the packet core is deployed across multiple devices, all devices will appear in this list. ,
Required: False ,
}
[
{
id:
{
Description: Azure Stack Edge device resource ID. ,
Required: True ,
}
string ,
}
,
]
,
azureStackHciCluster:
{
Description: The Azure Stack HCI cluster where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure Stack HCI cluster resource ID. ,
Required: True ,
}
string ,
}
,
connectedCluster:
{
Description: Azure Arc connected cluster where the packet core is deployed. ,
Required: False ,
}
{
id:
{
Description: Azure Arc connected cluster 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 (5G core or EPC / 4G core). ,
Enum:
{
5GC: 5G core ,
EPC: EPC / 4G core ,
EPC + 5GC: Combined EPC / 4G and 5G core ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The desired version of the packet core software. ,
Required: False ,
}
string ,
installedVersion:
{
Description: The currently installed version of the packet core software. ,
Required: False ,
}
string ,
rollbackVersion:
{
Description: The previous version of the packet core software that was deployed. Used when performing the rollback action. ,
Required: False ,
}
string ,
controlPlaneAccessInterface:
{
Description: The control plane interface on the access network. For 5G networks, this is the N2 interface. For 4G networks, this is the 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 device. ,
Required: False ,
}
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 ,
vlanId:
{
Description: VLAN identifier of the network interface. Example: 501. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4AddressList:
{
Description: The list of IPv4 addresses, for a multi-node system. ,
Required: False ,
}
[
string ,
]
,
bfdIpv4Endpoints:
{
Description: The IPv4 addresses of the endpoints to send BFD probes to. ,
Required: False ,
}
[
string ,
]
,
}
,
controlPlaneAccessVirtualIpv4Addresses:
{
Description: The virtual IP address(es) for the control plane on the access network in a High Availability (HA) system. In an HA deployment the access network router should be configured to anycast traffic for this address to the control plane access interfaces on the active and standby nodes. In non-HA system this list should be omitted or empty. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The SKU defining the throughput and SIM allowances for this packet core control plane deployment. ,
Enum:
{
G0: 100 Mbps, 20 active SIMs plan, 2 RANs ,
G1: 1 Gbps, 100 active SIMs plan, 5 RANs ,
G2: 2 Gbps, 200 active SIMs plan, 10 RANs ,
G5: 5 Gbps, 500 active SIMs plan ,
G10: 10 Gbps, 1000 active SIMs plan ,
}
,
Required: True ,
}
enum ,
ueMtu:
{
Description: The MTU (in bytes) signaled to the UE. The same MTU is set on the user plane data links for all data networks. The MTU set on the user plane access link is calculated to be 60 bytes greater than this value to allow for GTP encapsulation. ,
Format: int32 ,
Required: False ,
}
integer ,
localDiagnosticsAccess:
{
Description: The kubernetes ingress configuration to control access to packet core diagnostics over local APIs. ,
Required: True ,
}
{
authenticationType:
{
Description: How to authenticate users who access local diagnostics APIs. ,
Enum:
{
AAD: Use AAD SSO to authenticate the user (this requires internet access). ,
Password: Use locally stored passwords to authenticate the user. ,
}
,
Required: True ,
}
enum ,
httpsServerCertificate:
{
Description: The HTTPS server TLS certificate used to secure local access to diagnostics. ,
Required: False ,
}
{
certificateUrl:
{
Description: The certificate URL, unversioned. For example: https://contosovault.vault.azure.net/certificates/ingress. ,
Required: True ,
}
string ,
provisioning:
{
Description: The provisioning state of the certificate. ,
Required: False ,
}
{
state:
{
Description: The certificate's provisioning state ,
Enum:
{
NotProvisioned: The certificate has not been provisioned. ,
Provisioned: The certificate has been provisioned. ,
Failed: The certificate failed to be provisioned. The "reason" property explains why. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: Reason for certificate provisioning failure. ,
Required: False ,
}
string ,
}
,
}
,
}
,
diagnosticsUpload:
{
Description: Configuration for uploading packet core diagnostics ,
Required: False ,
}
{
storageAccountContainerUrl:
{
Description: The Storage Account Container URL to upload diagnostics to. ,
Required: True ,
}
string ,
}
,
eventHub:
{
Description: Configuration for sending packet core events to an Azure Event Hub. ,
Required: False ,
}
{
id:
{
Description: Resource ID of Azure Event Hub to send packet core events to. ,
Required: True ,
}
string ,
reportingInterval:
{
Description: The duration (in seconds) between UE usage reports. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
signaling:
{
Description: Signaling configuration for the packet core. ,
Required: False ,
}
{
nasReroute:
{
Description: Configuration enabling 4G NAS reroute. ,
Required: False ,
}
{
macroMmeGroupId:
{
Description: The macro network's MME group ID. This is where unknown UEs are sent to via NAS reroute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
nasEncryption:
{
Description: An ordered list of NAS encryption algorithms, used to encrypt control plane traffic between the UE and packet core, in order from most to least preferred. If not specified, the packet core will use a built-in default ordering. ,
Required: False ,
}
[
string ,
]
,
}
,
interopSettings:
{
Description: Settings to allow interoperability with third party components e.g. RANs and UEs. ,
Required: False ,
}
object ,
homeNetworkPrivateKeysProvisioning:
{
Description: The provisioning state of the secret containing private keys and keyIds for SUPI concealment. ,
Required: False ,
}
{
state:
{
Description: The provisioning state of the private keys for SUPI concealment. ,
Enum:
{
NotProvisioned: Provisioning of the private keys for SUPI concealment has not been attempted. ,
Provisioned: The private keys for SUPI concealment are successfully provisioned. ,
Failed: Provisioning of the private keys for SUPI concealment has failed. ,
}
,
Required: True ,
}
enum ,
}
,
userConsent:
{
Description: The user consent configuration for the packet core. ,
Required: False ,
}
{
allowSupportTelemetryAccess:
{
Description: Allow Microsoft to access non-PII telemetry information from the packet core. ,
Required: False ,
}
boolean ,
}
,
}
,
identity:
{
Description: The identity used to retrieve the ingress certificate from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
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_Rollback (removed)
Description :  Roll back the specified packet core control plane to the previous version, "rollbackVersion". Multiple consecutive rollbacks are not possible. This action may cause a service outage.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/rollback
{
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the async operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: The operation status. ,
Required: True ,
}
string ,
resourceId:
{
Description: Fully qualified ID for the resource that this async operation status relates to. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage of the operation that is complete. ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: Properties returned by the resource provider on a successful operation ,
Required: False ,
}
object ,
error:
{
Description: If present, details of the operation error. ,
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 ,
}
,
]
,
}
,
}

⚐ Response (202)

{}

⚐ 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_Reinstall (removed)
Description :  Reinstall the specified packet core control plane. This action will try to restore the packet core to the installed state that was disrupted by a transient failure. This action will cause a service outage.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/reinstall
{
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the async operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: The operation status. ,
Required: True ,
}
string ,
resourceId:
{
Description: Fully qualified ID for the resource that this async operation status relates to. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage of the operation that is complete. ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: Properties returned by the resource provider on a successful operation ,
Required: False ,
}
object ,
error:
{
Description: If present, details of the operation error. ,
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 ,
}
,
]
,
}
,
}

⚐ Response (202)

{}

⚐ 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_CollectDiagnosticsPackage (removed)
Description :  Collect a diagnostics package for the specified packet core control plane. This action will upload the diagnostics to a storage account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/collectDiagnosticsPackage
{
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 packet core control plane collect diagnostics package operation. ,
Required: True ,
}
{
storageAccountBlobUrl:
{
Description: The Storage Account Blob URL to upload the diagnostics package to. ,
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the async operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: The operation status. ,
Required: True ,
}
string ,
resourceId:
{
Description: Fully qualified ID for the resource that this async operation status relates to. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage of the operation that is complete. ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: Properties returned by the resource provider on a successful operation ,
Required: False ,
}
object ,
error:
{
Description: If present, details of the operation error. ,
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 ,
}
,
]
,
}
,
}

⚐ Response (202)

{}

⚐ 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 ,
}
,
]
,
}
,
}
RoutingInfo_List (removed)
Description :  List all of the routing information for the packet core.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/routingInfo
{
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of the routing information for the packet core control plane ,
Required: False ,
}
[
{
properties:
{
Description: Routing information properties ,
Required: True ,
}
{
controlPlaneAccessRoutes:
{
Description: A list of IPv4 routes. ,
Required: False ,
}
[
{
destination:
{
Description: The destination IPv4 prefix. ,
Required: False ,
}
string ,
nextHops:
{
Description: A list of next hops for the destination. ,
Required: False ,
}
[
{
address:
{
Description: The next hop address. ,
Required: False ,
}
string ,
priority:
{
Description: The priority of this next hop. Next hops with lower preference values are preferred. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
userPlaneAccessRoutes:
{
Description: A list of IPv4 routes. ,
Required: False ,
}
[
{
destination:
{
Description: The destination IPv4 prefix. ,
Required: False ,
}
string ,
nextHops:
{
Description: A list of next hops for the destination. ,
Required: False ,
}
[
{
address:
{
Description: The next hop address. ,
Required: False ,
}
string ,
priority:
{
Description: The priority of this next hop. Next hops with lower preference values are preferred. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
userPlaneDataRoutes:
{
Description: A list of attached data networks and their IPv4 routes. ,
Required: False ,
}
[
{
attachedDataNetwork:
{
Description: Reference to an attached data network resource. ,
Required: False ,
}
{
id:
{
Description: Attached data network resource ID. ,
Required: True ,
}
string ,
}
,
routes:
{
Description: A list of IPv4 routes. ,
Required: False ,
}
[
{
destination:
{
Description: The destination IPv4 prefix. ,
Required: False ,
}
string ,
nextHops:
{
Description: A list of next hops for the destination. ,
Required: False ,
}
[
{
address:
{
Description: The next hop address. ,
Required: False ,
}
string ,
priority:
{
Description: The priority of this next hop. Next hops with lower preference values are preferred. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
RoutingInfo_Get (removed)
Description :  Get the routing information for the packet core.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/routingInfo/default
{
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Routing information properties ,
Required: True ,
}
{
controlPlaneAccessRoutes:
{
Description: A list of IPv4 routes. ,
Required: False ,
}
[
{
destination:
{
Description: The destination IPv4 prefix. ,
Required: False ,
}
string ,
nextHops:
{
Description: A list of next hops for the destination. ,
Required: False ,
}
[
{
address:
{
Description: The next hop address. ,
Required: False ,
}
string ,
priority:
{
Description: The priority of this next hop. Next hops with lower preference values are preferred. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
userPlaneAccessRoutes:
{
Description: A list of IPv4 routes. ,
Required: False ,
}
[
{
destination:
{
Description: The destination IPv4 prefix. ,
Required: False ,
}
string ,
nextHops:
{
Description: A list of next hops for the destination. ,
Required: False ,
}
[
{
address:
{
Description: The next hop address. ,
Required: False ,
}
string ,
priority:
{
Description: The priority of this next hop. Next hops with lower preference values are preferred. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
userPlaneDataRoutes:
{
Description: A list of attached data networks and their IPv4 routes. ,
Required: False ,
}
[
{
attachedDataNetwork:
{
Description: Reference to an attached data network resource. ,
Required: False ,
}
{
id:
{
Description: Attached data network resource ID. ,
Required: True ,
}
string ,
}
,
routes:
{
Description: A list of IPv4 routes. ,
Required: False ,
}
[
{
destination:
{
Description: The destination IPv4 prefix. ,
Required: False ,
}
string ,
nextHops:
{
Description: A list of next hops for the destination. ,
Required: False ,
}
[
{
address:
{
Description: The next hop address. ,
Required: False ,
}
string ,
priority:
{
Description: The priority of this next hop. Next hops with lower preference values are preferred. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
PacketCoreControlPlaneVersions_Get (removed)
Description :  Gets information about the specified packet core control plane version.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.MobileNetwork/packetCoreControlPlaneVersions/{versionName}
{
versionName:
{
Description: The name of the packet core control plane version. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Packet core control plane version properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet core control plane version 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 ,
platforms:
{
Description: Platform specific packet core control plane version properties. ,
Required: False ,
}
[
{
platformType:
{
Description: The platform type where this version can be deployed. ,
Enum:
{
AKS-HCI: If this option is chosen, you must set one of "azureStackEdgeDevice", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
3P-AZURE-STACK-HCI: If this option is chosen, you must set one of "azureStackHciCluster", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
}
,
Required: False ,
}
enum ,
versionState:
{
Description: The state of this packet core control plane version on this platform. ,
Enum:
{
Unknown: The state of this version is unknown. ,
Preview: This version is a preview and is not suitable for production use. ,
Validating: This version is currently being validated. ,
ValidationFailed: This version failed validation. ,
Active: This version is active and suitable for production use. ,
Deprecated: This version is deprecated and is no longer supported. ,
}
,
Required: False ,
}
enum ,
minimumPlatformSoftwareVersion:
{
Description: The minimum software version of the platform where this packet core version can be deployed. ,
Required: False ,
}
string ,
maximumPlatformSoftwareVersion:
{
Description: The maximum software version of the platform where this packet core version can be deployed. ,
Required: False ,
}
string ,
recommendedVersion:
{
Description: Indicates whether this is the recommended version for this platform. ,
Enum:
{
Recommended: This is the recommended version to use for new packet core control plane deployments. ,
NotRecommended: This is not the recommended version to use for new packet core control plane deployments. ,
}
,
Required: False ,
}
enum ,
obsoleteVersion:
{
Description: Indicates whether this version is obsoleted for this platform. ,
Enum:
{
Obsolete: This version is obsolete for use in new packet core control plane deployments. ,
NotObsolete: This version is not obsolete for use in new packet core control plane deployments. ,
}
,
Required: False ,
}
enum ,
haUpgradesAvailable:
{
Description: The list of versions to which a high availability upgrade from this version is supported. ,
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 ,
}
,
]
,
}
,
}
PacketCoreControlPlaneVersions_List (removed)
Description :  Lists all supported packet core control planes versions.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: A list of supported packet core control plane versions. ,
Required: False ,
}
[
{
properties:
{
Description: Packet core control plane version properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet core control plane version 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 ,
platforms:
{
Description: Platform specific packet core control plane version properties. ,
Required: False ,
}
[
{
platformType:
{
Description: The platform type where this version can be deployed. ,
Enum:
{
AKS-HCI: If this option is chosen, you must set one of "azureStackEdgeDevice", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
3P-AZURE-STACK-HCI: If this option is chosen, you must set one of "azureStackHciCluster", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
}
,
Required: False ,
}
enum ,
versionState:
{
Description: The state of this packet core control plane version on this platform. ,
Enum:
{
Unknown: The state of this version is unknown. ,
Preview: This version is a preview and is not suitable for production use. ,
Validating: This version is currently being validated. ,
ValidationFailed: This version failed validation. ,
Active: This version is active and suitable for production use. ,
Deprecated: This version is deprecated and is no longer supported. ,
}
,
Required: False ,
}
enum ,
minimumPlatformSoftwareVersion:
{
Description: The minimum software version of the platform where this packet core version can be deployed. ,
Required: False ,
}
string ,
maximumPlatformSoftwareVersion:
{
Description: The maximum software version of the platform where this packet core version can be deployed. ,
Required: False ,
}
string ,
recommendedVersion:
{
Description: Indicates whether this is the recommended version for this platform. ,
Enum:
{
Recommended: This is the recommended version to use for new packet core control plane deployments. ,
NotRecommended: This is not the recommended version to use for new packet core control plane deployments. ,
}
,
Required: False ,
}
enum ,
obsoleteVersion:
{
Description: Indicates whether this version is obsoleted for this platform. ,
Enum:
{
Obsolete: This version is obsolete for use in new packet core control plane deployments. ,
NotObsolete: This version is not obsolete for use in new packet core control plane deployments. ,
}
,
Required: False ,
}
enum ,
haUpgradesAvailable:
{
Description: The list of versions to which a high availability upgrade from this version is supported. ,
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 ,
}
,
]
,
}
,
}
PacketCoreControlPlaneVersions_GetBySubscription (removed)
Description :  Gets information about the specified packet core control plane version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MobileNetwork/packetCoreControlPlaneVersions/{versionName}
{
versionName:
{
Description: The name of the packet core control plane version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Packet core control plane version properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet core control plane version 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 ,
platforms:
{
Description: Platform specific packet core control plane version properties. ,
Required: False ,
}
[
{
platformType:
{
Description: The platform type where this version can be deployed. ,
Enum:
{
AKS-HCI: If this option is chosen, you must set one of "azureStackEdgeDevice", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
3P-AZURE-STACK-HCI: If this option is chosen, you must set one of "azureStackHciCluster", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
}
,
Required: False ,
}
enum ,
versionState:
{
Description: The state of this packet core control plane version on this platform. ,
Enum:
{
Unknown: The state of this version is unknown. ,
Preview: This version is a preview and is not suitable for production use. ,
Validating: This version is currently being validated. ,
ValidationFailed: This version failed validation. ,
Active: This version is active and suitable for production use. ,
Deprecated: This version is deprecated and is no longer supported. ,
}
,
Required: False ,
}
enum ,
minimumPlatformSoftwareVersion:
{
Description: The minimum software version of the platform where this packet core version can be deployed. ,
Required: False ,
}
string ,
maximumPlatformSoftwareVersion:
{
Description: The maximum software version of the platform where this packet core version can be deployed. ,
Required: False ,
}
string ,
recommendedVersion:
{
Description: Indicates whether this is the recommended version for this platform. ,
Enum:
{
Recommended: This is the recommended version to use for new packet core control plane deployments. ,
NotRecommended: This is not the recommended version to use for new packet core control plane deployments. ,
}
,
Required: False ,
}
enum ,
obsoleteVersion:
{
Description: Indicates whether this version is obsoleted for this platform. ,
Enum:
{
Obsolete: This version is obsolete for use in new packet core control plane deployments. ,
NotObsolete: This version is not obsolete for use in new packet core control plane deployments. ,
}
,
Required: False ,
}
enum ,
haUpgradesAvailable:
{
Description: The list of versions to which a high availability upgrade from this version is supported. ,
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 ,
}
,
]
,
}
,
}
PacketCoreControlPlaneVersions_ListBySubscription (removed)
Description :  Lists all supported packet core control planes versions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MobileNetwork/packetCoreControlPlaneVersions
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of supported packet core control plane versions. ,
Required: False ,
}
[
{
properties:
{
Description: Packet core control plane version properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the packet core control plane version 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 ,
platforms:
{
Description: Platform specific packet core control plane version properties. ,
Required: False ,
}
[
{
platformType:
{
Description: The platform type where this version can be deployed. ,
Enum:
{
AKS-HCI: If this option is chosen, you must set one of "azureStackEdgeDevice", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
3P-AZURE-STACK-HCI: If this option is chosen, you must set one of "azureStackHciCluster", "connectedCluster" or "customLocation". If multiple are set, they must be consistent with each other. ,
}
,
Required: False ,
}
enum ,
versionState:
{
Description: The state of this packet core control plane version on this platform. ,
Enum:
{
Unknown: The state of this version is unknown. ,
Preview: This version is a preview and is not suitable for production use. ,
Validating: This version is currently being validated. ,
ValidationFailed: This version failed validation. ,
Active: This version is active and suitable for production use. ,
Deprecated: This version is deprecated and is no longer supported. ,
}
,
Required: False ,
}
enum ,
minimumPlatformSoftwareVersion:
{
Description: The minimum software version of the platform where this packet core version can be deployed. ,
Required: False ,
}
string ,
maximumPlatformSoftwareVersion:
{
Description: The maximum software version of the platform where this packet core version can be deployed. ,
Required: False ,
}
string ,
recommendedVersion:
{
Description: Indicates whether this is the recommended version for this platform. ,
Enum:
{
Recommended: This is the recommended version to use for new packet core control plane deployments. ,
NotRecommended: This is not the recommended version to use for new packet core control plane deployments. ,
}
,
Required: False ,
}
enum ,
obsoleteVersion:
{
Description: Indicates whether this version is obsoleted for this platform. ,
Enum:
{
Obsolete: This version is obsolete for use in new packet core control plane deployments. ,
NotObsolete: This version is not obsolete for use in new packet core control plane deployments. ,
}
,
Required: False ,
}
enum ,
haUpgradesAvailable:
{
Description: The list of versions to which a high availability upgrade from this version is supported. ,
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. The value must be an UUID. ,
Format: uuid ,
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. The value must be an UUID. ,
Format: uuid ,
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. For 5G networks, this is the N3 interface. For 4G networks, this is 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 device. ,
Required: False ,
}
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 ,
vlanId:
{
Description: VLAN identifier of the network interface. Example: 501. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4AddressList:
{
Description: The list of IPv4 addresses, for a multi-node system. ,
Required: False ,
}
[
string ,
]
,
bfdIpv4Endpoints:
{
Description: The IPv4 addresses of the endpoints to send BFD probes to. ,
Required: False ,
}
[
string ,
]
,
}
,
userPlaneAccessVirtualIpv4Addresses:
{
Description: The virtual IP address(es) for the user plane on the access network in a High Availability (HA) system. In an HA deployment the access network router should be configured to forward traffic for this address to the control plane access interface on the active or standby node. In non-HA system this list should be omitted or empty. ,
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 packet core data plane. Must be created in the same location as its parent packet core control plane.
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. For 5G networks, this is the N3 interface. For 4G networks, this is 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 device. ,
Required: False ,
}
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 ,
vlanId:
{
Description: VLAN identifier of the network interface. Example: 501. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4AddressList:
{
Description: The list of IPv4 addresses, for a multi-node system. ,
Required: False ,
}
[
string ,
]
,
bfdIpv4Endpoints:
{
Description: The IPv4 addresses of the endpoints to send BFD probes to. ,
Required: False ,
}
[
string ,
]
,
}
,
userPlaneAccessVirtualIpv4Addresses:
{
Description: The virtual IP address(es) for the user plane on the access network in a High Availability (HA) system. In an HA deployment the access network router should be configured to forward traffic for this address to the control plane access interface on the active or standby node. In non-HA system this list should be omitted or empty. ,
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. The value must be an UUID. ,
Format: uuid ,
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. For 5G networks, this is the N3 interface. For 4G networks, this is 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 device. ,
Required: False ,
}
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 ,
vlanId:
{
Description: VLAN identifier of the network interface. Example: 501. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4AddressList:
{
Description: The list of IPv4 addresses, for a multi-node system. ,
Required: False ,
}
[
string ,
]
,
bfdIpv4Endpoints:
{
Description: The IPv4 addresses of the endpoints to send BFD probes to. ,
Required: False ,
}
[
string ,
]
,
}
,
userPlaneAccessVirtualIpv4Addresses:
{
Description: The virtual IP address(es) for the user plane on the access network in a High Availability (HA) system. In an HA deployment the access network router should be configured to forward traffic for this address to the control plane access interface on the active or standby node. In non-HA system this list should be omitted or empty. ,
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. For 5G networks, this is the N3 interface. For 4G networks, this is 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 device. ,
Required: False ,
}
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 ,
vlanId:
{
Description: VLAN identifier of the network interface. Example: 501. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4AddressList:
{
Description: The list of IPv4 addresses, for a multi-node system. ,
Required: False ,
}
[
string ,
]
,
bfdIpv4Endpoints:
{
Description: The IPv4 addresses of the endpoints to send BFD probes to. ,
Required: False ,
}
[
string ,
]
,
}
,
userPlaneAccessVirtualIpv4Addresses:
{
Description: The virtual IP address(es) for the user plane on the access network in a High Availability (HA) system. In an HA deployment the access network router should be configured to forward traffic for this address to the control plane access interface on the active or standby node. In non-HA system this list should be omitted or empty. ,
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 packet core data planes 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 packet core data plane 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. The value must be an UUID. ,
Format: uuid ,
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. For 5G networks, this is the N3 interface. For 4G networks, this is 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 device. ,
Required: False ,
}
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 ,
vlanId:
{
Description: VLAN identifier of the network interface. Example: 501. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4AddressList:
{
Description: The list of IPv4 addresses, for a multi-node system. ,
Required: False ,
}
[
string ,
]
,
bfdIpv4Endpoints:
{
Description: The IPv4 addresses of the endpoints to send BFD probes to. ,
Required: False ,
}
[
string ,
]
,
}
,
userPlaneAccessVirtualIpv4Addresses:
{
Description: The virtual IP address(es) for the user plane on the access network in a High Availability (HA) system. In an HA deployment the access network router should be configured to forward traffic for this address to the control plane access interface on the active or standby node. In non-HA system this list should be omitted or empty. ,
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 packet core data planes associated with a packet core control plane.
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. The value must be an UUID. ,
Format: uuid ,
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. For 5G networks, this is the N3 interface. For 4G networks, this is 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 device. ,
Required: False ,
}
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 ,
vlanId:
{
Description: VLAN identifier of the network interface. Example: 501. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4AddressList:
{
Description: The list of IPv4 addresses, for a multi-node system. ,
Required: False ,
}
[
string ,
]
,
bfdIpv4Endpoints:
{
Description: The IPv4 addresses of the endpoints to send BFD probes to. ,
Required: False ,
}
[
string ,
]
,
}
,
userPlaneAccessVirtualIpv4Addresses:
{
Description: The virtual IP address(es) for the user plane on the access network in a High Availability (HA) system. In an HA deployment the access network router should be configured to forward traffic for this address to the control plane access interface on the active or standby node. In non-HA system this list should be omitted or empty. ,
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. The value must be an UUID. ,
Format: uuid ,
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. The value must be an UUID. ,
Format: uuid ,
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 SIM policy will define the QoS settings. ,
Required: False ,
}
{
5qi:
{
Description: 5G QoS Flow Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. 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 the 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 a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
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 data flow policy 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 data flow policy 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 data flow policy rules when identifying the QoS values to use for a particular SIM. A lower value means a higher priority. This value should be unique among all data flow policy rules configured in the mobile network. ,
Format: int32 ,
Required: True ,
}
integer ,
ruleQosPolicy:
{
Description: The QoS policy to use for packets matching this rule. If this field is null then the parent service will define the QoS settings. ,
Required: False ,
}
{
guaranteedBitRate:
{
Description: The guaranteed bit rate (GBR) for all service data flows that use this data flow policy rule. This is an optional setting. If you do not provide a value, there will be no GBR set for the data flow policy rule that uses this QoS definition. ,
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 data flow policy 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 data flow templates to use for this data flow policy rule. ,
Required: True ,
}
[
{
templateName:
{
Description: The name of the data flow template. This must be unique within the parent data flow policy rule. You must not use any of the following reserved strings - `default`, `requested` or `service`. ,
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 the packet core instance will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). ,
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 ,
]
,
}
,
]
,
}
,
]
,
}
,
}

⚐ 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. Must be created in the same location as its parent mobile network.
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 SIM policy will define the QoS settings. ,
Required: False ,
}
{
5qi:
{
Description: 5G QoS Flow Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. 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 the 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 a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
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 data flow policy 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 data flow policy 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 data flow policy rules when identifying the QoS values to use for a particular SIM. A lower value means a higher priority. This value should be unique among all data flow policy rules configured in the mobile network. ,
Format: int32 ,
Required: True ,
}
integer ,
ruleQosPolicy:
{
Description: The QoS policy to use for packets matching this rule. If this field is null then the parent service will define the QoS settings. ,
Required: False ,
}
{
guaranteedBitRate:
{
Description: The guaranteed bit rate (GBR) for all service data flows that use this data flow policy rule. This is an optional setting. If you do not provide a value, there will be no GBR set for the data flow policy rule that uses this QoS definition. ,
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 data flow policy 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 data flow templates to use for this data flow policy rule. ,
Required: True ,
}
[
{
templateName:
{
Description: The name of the data flow template. This must be unique within the parent data flow policy rule. You must not use any of the following reserved strings - `default`, `requested` or `service`. ,
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 the packet core instance will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). ,
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 ,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 SIM policy will define the QoS settings. ,
Required: False ,
}
{
5qi:
{
Description: 5G QoS Flow Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. 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 the 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 a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
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 data flow policy 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 data flow policy 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 data flow policy rules when identifying the QoS values to use for a particular SIM. A lower value means a higher priority. This value should be unique among all data flow policy rules configured in the mobile network. ,
Format: int32 ,
Required: True ,
}
integer ,
ruleQosPolicy:
{
Description: The QoS policy to use for packets matching this rule. If this field is null then the parent service will define the QoS settings. ,
Required: False ,
}
{
guaranteedBitRate:
{
Description: The guaranteed bit rate (GBR) for all service data flows that use this data flow policy rule. This is an optional setting. If you do not provide a value, there will be no GBR set for the data flow policy rule that uses this QoS definition. ,
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 data flow policy 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 data flow templates to use for this data flow policy rule. ,
Required: True ,
}
[
{
templateName:
{
Description: The name of the data flow template. This must be unique within the parent data flow policy rule. You must not use any of the following reserved strings - `default`, `requested` or `service`. ,
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 the packet core instance will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). ,
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 ,
]
,
}
,
]
,
}
,
]
,
}
,
}

⚐ 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 SIM policy will define the QoS settings. ,
Required: False ,
}
{
5qi:
{
Description: 5G QoS Flow Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. 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 the 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 a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
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 data flow policy 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 data flow policy 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 data flow policy rules when identifying the QoS values to use for a particular SIM. A lower value means a higher priority. This value should be unique among all data flow policy rules configured in the mobile network. ,
Format: int32 ,
Required: True ,
}
integer ,
ruleQosPolicy:
{
Description: The QoS policy to use for packets matching this rule. If this field is null then the parent service will define the QoS settings. ,
Required: False ,
}
{
guaranteedBitRate:
{
Description: The guaranteed bit rate (GBR) for all service data flows that use this data flow policy rule. This is an optional setting. If you do not provide a value, there will be no GBR set for the data flow policy rule that uses this QoS definition. ,
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 data flow policy 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 data flow templates to use for this data flow policy rule. ,
Required: True ,
}
[
{
templateName:
{
Description: The name of the data flow template. This must be unique within the parent data flow policy rule. You must not use any of the following reserved strings - `default`, `requested` or `service`. ,
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 the packet core instance will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). ,
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 ,
]
,
}
,
]
,
}
,
]
,
}
,
}

⚐ 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 :  Updates 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. The value must be an UUID. ,
Format: uuid ,
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 SIM policy will define the QoS settings. ,
Required: False ,
}
{
5qi:
{
Description: 5G QoS Flow Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. 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 the 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 a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
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 data flow policy 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 data flow policy 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 data flow policy rules when identifying the QoS values to use for a particular SIM. A lower value means a higher priority. This value should be unique among all data flow policy rules configured in the mobile network. ,
Format: int32 ,
Required: True ,
}
integer ,
ruleQosPolicy:
{
Description: The QoS policy to use for packets matching this rule. If this field is null then the parent service will define the QoS settings. ,
Required: False ,
}
{
guaranteedBitRate:
{
Description: The guaranteed bit rate (GBR) for all service data flows that use this data flow policy rule. This is an optional setting. If you do not provide a value, there will be no GBR set for the data flow policy rule that uses this QoS definition. ,
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 data flow policy 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 data flow templates to use for this data flow policy rule. ,
Required: True ,
}
[
{
templateName:
{
Description: The name of the data flow template. This must be unique within the parent data flow policy rule. You must not use any of the following reserved strings - `default`, `requested` or `service`. ,
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 the packet core instance will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). ,
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 ,
]
,
}
,
]
,
}
,
]
,
}
,
}

⚐ 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. The value must be an UUID. ,
Format: uuid ,
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 SIM policy will define the QoS settings. ,
Required: False ,
}
{
5qi:
{
Description: 5G QoS Flow Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. 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 the 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 a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
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 data flow policy 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 data flow policy 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 data flow policy rules when identifying the QoS values to use for a particular SIM. A lower value means a higher priority. This value should be unique among all data flow policy rules configured in the mobile network. ,
Format: int32 ,
Required: True ,
}
integer ,
ruleQosPolicy:
{
Description: The QoS policy to use for packets matching this rule. If this field is null then the parent service will define the QoS settings. ,
Required: False ,
}
{
guaranteedBitRate:
{
Description: The guaranteed bit rate (GBR) for all service data flows that use this data flow policy rule. This is an optional setting. If you do not provide a value, there will be no GBR set for the data flow policy rule that uses this QoS definition. ,
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 data flow policy 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 data flow templates to use for this data flow policy rule. ,
Required: True ,
}
[
{
templateName:
{
Description: The name of the data flow template. This must be unique within the parent data flow policy rule. You must not use any of the following reserved strings - `default`, `requested` or `service`. ,
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 the packet core instance will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). ,
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 ,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
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/simGroups/{simGroupName}/sims/{simName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
simGroupName:
{
Description: The name of the SIM Group. ,
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/simGroups/{simGroupName}/sims/{simName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
simGroupName:
{
Description: The name of the SIM Group. ,
Required: True ,
}
string ,
simName:
{
Description: The name of the SIM. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SIM Properties. ,
Required: True ,
}
{
authenticationKey:
{
Description: The Ki value for the SIM. ,
Required: False ,
}
string ,
operatorKeyCode:
{
Description: The Opc value for the SIM. ,
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/simGroups/{simGroupName}/sims/{simName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
simGroupName:
{
Description: The name of the SIM Group. ,
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 ,
}
{
authenticationKey:
{
Description: The Ki value for the SIM. ,
Required: False ,
}
string ,
operatorKeyCode:
{
Description: The Opc value for the SIM. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: SIM Properties. ,
Required: True ,
}
{
authenticationKey:
{
Description: The Ki value for the SIM. ,
Required: False ,
}
string ,
operatorKeyCode:
{
Description: The Opc value for the SIM. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: SIM Properties. ,
Required: True ,
}
{
authenticationKey:
{
Description: The Ki value for the SIM. ,
Required: False ,
}
string ,
operatorKeyCode:
{
Description: The Opc value for the SIM. ,
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_ListByGroup (removed)
Description :  Gets all the SIMs in a SIM group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/simGroups/{simGroupName}/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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
simGroupName:
{
Description: The name of the SIM Group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of SIMs in a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: SIM Properties. ,
Required: True ,
}
{
authenticationKey:
{
Description: The Ki value for the SIM. ,
Required: False ,
}
string ,
operatorKeyCode:
{
Description: The Opc value for the SIM. ,
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_BulkUpload (removed)
Description :  Bulk upload SIMs to a SIM group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/simGroups/{simGroupName}/uploadSims
{
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
simGroupName:
{
Description: The name of the SIM Group. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the bulk SIM upload operation. ,
Required: True ,
}
{
sims:
{
Description: A list of SIMs to upload. ,
Required: True ,
}
[
{
name:
{
Description: The name of the SIM. ,
Required: True ,
}
string ,
properties:
{
Description: SIM Properties. ,
Required: True ,
}
{
authenticationKey:
{
Description: The Ki value for the SIM. ,
Required: False ,
}
string ,
operatorKeyCode:
{
Description: The Opc value for the SIM. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the async operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: The operation status. ,
Required: True ,
}
string ,
resourceId:
{
Description: Fully qualified ID for the resource that this async operation status relates to. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage of the operation that is complete. ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: Properties returned by the resource provider on a successful operation ,
Required: False ,
}
object ,
error:
{
Description: If present, details of the operation error. ,
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 ,
}
,
]
,
}
,
}

⚐ Response (202)

{}

⚐ 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_BulkDelete (removed)
Description :  Bulk delete SIMs from a SIM group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/simGroups/{simGroupName}/deleteSims
{
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
simGroupName:
{
Description: The name of the SIM Group. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the bulk SIM delete operation. ,
Required: True ,
}
{
sims:
{
Description: A list of SIM resource names to delete. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the async operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: The operation status. ,
Required: True ,
}
string ,
resourceId:
{
Description: Fully qualified ID for the resource that this async operation status relates to. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage of the operation that is complete. ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: Properties returned by the resource provider on a successful operation ,
Required: False ,
}
object ,
error:
{
Description: If present, details of the operation error. ,
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 ,
}
,
]
,
}
,
}

⚐ 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_BulkUploadEncrypted (removed)
Description :  Bulk upload SIMs in encrypted form to a SIM group. The SIM credentials must be encrypted.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/simGroups/{simGroupName}/uploadEncryptedSims
{
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
simGroupName:
{
Description: The name of the SIM Group. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the encrypted SIMs upload operation. ,
Required: True ,
}
{
version:
{
Description: The upload file format version. ,
Format: int32 ,
Required: True ,
}
integer ,
azureKeyIdentifier:
{
Description: An identifier for the Azure SIM onboarding public key used for encrypted upload. ,
Format: int32 ,
Required: True ,
}
integer ,
vendorKeyFingerprint:
{
Description: The fingerprint of the SIM vendor public key. The private counterpart is used for signing the encrypted transport key. ,
Required: True ,
}
string ,
encryptedTransportKey:
{
Description: The transport key used for encrypting SIM credentials, encrypted using the SIM onboarding public key. ,
Required: True ,
}
string ,
signedTransportKey:
{
Description: The encrypted transport key, signed using the SIM vendor private key. ,
Required: True ,
}
string ,
sims:
{
Description: A list of SIMs to upload, with encrypted properties. ,
Required: True ,
}
[
{
name:
{
Description: The name of the SIM. ,
Required: True ,
}
string ,
properties:
{
Description: Encrypted SIM Properties. ,
Required: True ,
}
{
encryptedCredentials:
{
Description: The encrypted SIM credentials. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the async operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: The operation status. ,
Required: True ,
}
string ,
resourceId:
{
Description: Fully qualified ID for the resource that this async operation status relates to. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage of the operation that is complete. ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: Properties returned by the resource provider on a successful operation ,
Required: False ,
}
object ,
error:
{
Description: If present, details of the operation error. ,
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 ,
}
,
]
,
}
,
}

⚐ Response (202)

{}

⚐ 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_Move (removed)
Description :  Move SIMs to another SIM Group
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/simGroups/{simGroupName}/moveSims
{
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
simGroupName:
{
Description: The name of the SIM Group. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to move the SIMs. ,
Required: True ,
}
{
targetSimGroupId:
{
Description: The SIM Group where the SIMs should be moved. ,
Required: False ,
}
{
id:
{
Description: SIM group resource ID. ,
Required: True ,
}
string ,
}
,
sims:
{
Description: A list of SIM resource names to be moved. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the async operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: The operation status. ,
Required: True ,
}
string ,
resourceId:
{
Description: Fully qualified ID for the resource that this async operation status relates to. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage of the operation that is complete. ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: Properties returned by the resource provider on a successful operation ,
Required: False ,
}
object ,
error:
{
Description: If present, details of the operation error. ,
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 ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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_Clone (removed)
Description :  Clone SIMs to another SIM Group
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/simGroups/{simGroupName}/cloneSims
{
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
simGroupName:
{
Description: The name of the SIM Group. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to clone the SIMs. ,
Required: True ,
}
{
targetSimGroupId:
{
Description: The SIM Group where the SIMs should be cloned. ,
Required: False ,
}
{
id:
{
Description: SIM group resource ID. ,
Required: True ,
}
string ,
}
,
sims:
{
Description: A list of SIM resource names to be cloned. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the async operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: The operation status. ,
Required: True ,
}
string ,
resourceId:
{
Description: Fully qualified ID for the resource that this async operation status relates to. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Percentage of the operation that is complete. ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: Properties returned by the resource provider on a successful operation ,
Required: False ,
}
object ,
error:
{
Description: If present, details of the operation error. ,
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 ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
,
]
,
}
,
}
SimGroups_Delete (removed)
Description :  Deletes the specified SIM group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/simGroups/{simGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
simGroupName:
{
Description: The name of the SIM Group. ,
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 ,
}
,
]
,
}
,
}
SimGroups_Get (removed)
Description :  Gets information about the specified SIM group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/simGroups/{simGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
simGroupName:
{
Description: The name of the SIM Group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SIM group Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the SIM group 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 ,
encryptionKey:
{
Description: A key to encrypt the SIM data that belongs to this SIM group. ,
Required: False ,
}
{
keyUrl:
{
Description: The key URL, unversioned. For example: https://contosovault.vault.azure.net/keys/azureKey. ,
Required: False ,
}
string ,
}
,
mobileNetwork:
{
Description: Mobile network that this SIM group belongs to. The mobile network must be in the same location as the SIM group. ,
Required: False ,
}
{
id:
{
Description: Mobile network resource ID. ,
Required: True ,
}
string ,
}
,
}
,
identity:
{
Description: The identity used to retrieve the encryption key from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
SimGroups_CreateOrUpdate (removed)
Description :  Creates or updates a SIM group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/simGroups/{simGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
simGroupName:
{
Description: The name of the SIM Group. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update SIM group operation. ,
Required: True ,
}
{
properties:
{
Description: SIM group Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the SIM group 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 ,
encryptionKey:
{
Description: A key to encrypt the SIM data that belongs to this SIM group. ,
Required: False ,
}
{
keyUrl:
{
Description: The key URL, unversioned. For example: https://contosovault.vault.azure.net/keys/azureKey. ,
Required: False ,
}
string ,
}
,
mobileNetwork:
{
Description: Mobile network that this SIM group belongs to. The mobile network must be in the same location as the SIM group. ,
Required: False ,
}
{
id:
{
Description: Mobile network resource ID. ,
Required: True ,
}
string ,
}
,
}
,
identity:
{
Description: The identity used to retrieve the encryption key from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: SIM group Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the SIM group 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 ,
encryptionKey:
{
Description: A key to encrypt the SIM data that belongs to this SIM group. ,
Required: False ,
}
{
keyUrl:
{
Description: The key URL, unversioned. For example: https://contosovault.vault.azure.net/keys/azureKey. ,
Required: False ,
}
string ,
}
,
mobileNetwork:
{
Description: Mobile network that this SIM group belongs to. The mobile network must be in the same location as the SIM group. ,
Required: False ,
}
{
id:
{
Description: Mobile network resource ID. ,
Required: True ,
}
string ,
}
,
}
,
identity:
{
Description: The identity used to retrieve the encryption key from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: SIM group Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the SIM group 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 ,
encryptionKey:
{
Description: A key to encrypt the SIM data that belongs to this SIM group. ,
Required: False ,
}
{
keyUrl:
{
Description: The key URL, unversioned. For example: https://contosovault.vault.azure.net/keys/azureKey. ,
Required: False ,
}
string ,
}
,
mobileNetwork:
{
Description: Mobile network that this SIM group belongs to. The mobile network must be in the same location as the SIM group. ,
Required: False ,
}
{
id:
{
Description: Mobile network resource ID. ,
Required: True ,
}
string ,
}
,
}
,
identity:
{
Description: The identity used to retrieve the encryption key from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
SimGroups_UpdateTags (removed)
Description :  Patch SIM group resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/simGroups/{simGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
simGroupName:
{
Description: The name of the SIM Group. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to patch SIM group resource. ,
Required: True ,
}
{
identity:
{
Description: The managed service identity associated with this resource. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: SIM group Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the SIM group 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 ,
encryptionKey:
{
Description: A key to encrypt the SIM data that belongs to this SIM group. ,
Required: False ,
}
{
keyUrl:
{
Description: The key URL, unversioned. For example: https://contosovault.vault.azure.net/keys/azureKey. ,
Required: False ,
}
string ,
}
,
mobileNetwork:
{
Description: Mobile network that this SIM group belongs to. The mobile network must be in the same location as the SIM group. ,
Required: False ,
}
{
id:
{
Description: Mobile network resource ID. ,
Required: True ,
}
string ,
}
,
}
,
identity:
{
Description: The identity used to retrieve the encryption key from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
SimGroups_ListBySubscription (removed)
Description :  Gets all the SIM groups in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MobileNetwork/simGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of SIM groups in a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: SIM group Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the SIM group 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 ,
encryptionKey:
{
Description: A key to encrypt the SIM data that belongs to this SIM group. ,
Required: False ,
}
{
keyUrl:
{
Description: The key URL, unversioned. For example: https://contosovault.vault.azure.net/keys/azureKey. ,
Required: False ,
}
string ,
}
,
mobileNetwork:
{
Description: Mobile network that this SIM group belongs to. The mobile network must be in the same location as the SIM group. ,
Required: False ,
}
{
id:
{
Description: Mobile network resource ID. ,
Required: True ,
}
string ,
}
,
}
,
identity:
{
Description: The identity used to retrieve the encryption key from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
SimGroups_ListByResourceGroup (removed)
Description :  Gets all the SIM groups in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/simGroups
{
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of SIM groups in a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: SIM group Properties. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the SIM group 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 ,
encryptionKey:
{
Description: A key to encrypt the SIM data that belongs to this SIM group. ,
Required: False ,
}
{
keyUrl:
{
Description: The key URL, unversioned. For example: https://contosovault.vault.azure.net/keys/azureKey. ,
Required: False ,
}
string ,
}
,
mobileNetwork:
{
Description: Mobile network that this SIM group belongs to. The mobile network must be in the same location as the SIM group. ,
Required: False ,
}
{
id:
{
Description: Mobile network resource ID. ,
Required: True ,
}
string ,
}
,
}
,
identity:
{
Description: The identity used to retrieve the encryption key from Azure key vault. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity (currently only UserAssigned allowed). ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
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. The value must be an UUID. ,
Format: uuid ,
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. The value must be an UUID. ,
Format: uuid ,
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 ,
siteProvisioningState:
{
Description: A dictionary of sites to the provisioning state of this SIM policy on that site. ,
Required: False ,
}
object ,
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. The slice must be in the same location as the SIM policy. ,
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: UE periodic registration update timer (5G) or UE periodic tracking area update timer (4G), 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. The slice must be in the same location as the SIM policy. ,
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. The data network must be in the same location as the SIM policy. ,
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. The data network must be in the same location as the SIM policy. ,
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 5G QoS Flow Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. 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 the 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 a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
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. The services must be in the same location as the SIM policy. ,
Required: True ,
}
[
{
id:
{
Description: Service resource ID. ,
Required: True ,
}
string ,
}
,
]
,
maximumNumberOfBufferedPackets:
{
Description: The maximum number of downlink packets to buffer at the user plane for High Latency Communication - Extended Buffering. See 3GPP TS29.272 v15.10.0 section 7.3.188 for a full description. This maximum is not guaranteed because there is a internal limit on buffered packets across all PDU sessions. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
}

⚐ 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 SIM policy. Must be created in the same location as its parent mobile network.
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 ,
siteProvisioningState:
{
Description: A dictionary of sites to the provisioning state of this SIM policy on that site. ,
Required: False ,
}
object ,
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. The slice must be in the same location as the SIM policy. ,
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: UE periodic registration update timer (5G) or UE periodic tracking area update timer (4G), 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. The slice must be in the same location as the SIM policy. ,
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. The data network must be in the same location as the SIM policy. ,
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. The data network must be in the same location as the SIM policy. ,
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 5G QoS Flow Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. 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 the 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 a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
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. The services must be in the same location as the SIM policy. ,
Required: True ,
}
[
{
id:
{
Description: Service resource ID. ,
Required: True ,
}
string ,
}
,
]
,
maximumNumberOfBufferedPackets:
{
Description: The maximum number of downlink packets to buffer at the user plane for High Latency Communication - Extended Buffering. See 3GPP TS29.272 v15.10.0 section 7.3.188 for a full description. This maximum is not guaranteed because there is a internal limit on buffered packets across all PDU sessions. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
siteProvisioningState:
{
Description: A dictionary of sites to the provisioning state of this SIM policy on that site. ,
Required: False ,
}
object ,
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. The slice must be in the same location as the SIM policy. ,
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: UE periodic registration update timer (5G) or UE periodic tracking area update timer (4G), 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. The slice must be in the same location as the SIM policy. ,
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. The data network must be in the same location as the SIM policy. ,
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. The data network must be in the same location as the SIM policy. ,
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 5G QoS Flow Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. 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 the 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 a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
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. The services must be in the same location as the SIM policy. ,
Required: True ,
}
[
{
id:
{
Description: Service resource ID. ,
Required: True ,
}
string ,
}
,
]
,
maximumNumberOfBufferedPackets:
{
Description: The maximum number of downlink packets to buffer at the user plane for High Latency Communication - Extended Buffering. See 3GPP TS29.272 v15.10.0 section 7.3.188 for a full description. This maximum is not guaranteed because there is a internal limit on buffered packets across all PDU sessions. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
}

⚐ 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 ,
siteProvisioningState:
{
Description: A dictionary of sites to the provisioning state of this SIM policy on that site. ,
Required: False ,
}
object ,
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. The slice must be in the same location as the SIM policy. ,
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: UE periodic registration update timer (5G) or UE periodic tracking area update timer (4G), 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. The slice must be in the same location as the SIM policy. ,
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. The data network must be in the same location as the SIM policy. ,
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. The data network must be in the same location as the SIM policy. ,
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 5G QoS Flow Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. 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 the 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 a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
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. The services must be in the same location as the SIM policy. ,
Required: True ,
}
[
{
id:
{
Description: Service resource ID. ,
Required: True ,
}
string ,
}
,
]
,
maximumNumberOfBufferedPackets:
{
Description: The maximum number of downlink packets to buffer at the user plane for High Latency Communication - Extended Buffering. See 3GPP TS29.272 v15.10.0 section 7.3.188 for a full description. This maximum is not guaranteed because there is a internal limit on buffered packets across all PDU sessions. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
}

⚐ 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 :  Updates 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. The value must be an UUID. ,
Format: uuid ,
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 ,
siteProvisioningState:
{
Description: A dictionary of sites to the provisioning state of this SIM policy on that site. ,
Required: False ,
}
object ,
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. The slice must be in the same location as the SIM policy. ,
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: UE periodic registration update timer (5G) or UE periodic tracking area update timer (4G), 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. The slice must be in the same location as the SIM policy. ,
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. The data network must be in the same location as the SIM policy. ,
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. The data network must be in the same location as the SIM policy. ,
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 5G QoS Flow Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. 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 the 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 a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
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. The services must be in the same location as the SIM policy. ,
Required: True ,
}
[
{
id:
{
Description: Service resource ID. ,
Required: True ,
}
string ,
}
,
]
,
maximumNumberOfBufferedPackets:
{
Description: The maximum number of downlink packets to buffer at the user plane for High Latency Communication - Extended Buffering. See 3GPP TS29.272 v15.10.0 section 7.3.188 for a full description. This maximum is not guaranteed because there is a internal limit on buffered packets across all PDU sessions. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
}

⚐ 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 SIM policies 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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of SIM policies. ,
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 ,
siteProvisioningState:
{
Description: A dictionary of sites to the provisioning state of this SIM policy on that site. ,
Required: False ,
}
object ,
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. The slice must be in the same location as the SIM policy. ,
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: UE periodic registration update timer (5G) or UE periodic tracking area update timer (4G), 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. The slice must be in the same location as the SIM policy. ,
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. The data network must be in the same location as the SIM policy. ,
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. The data network must be in the same location as the SIM policy. ,
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 5G QoS Flow Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. 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 the 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 a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. ,
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. The services must be in the same location as the SIM policy. ,
Required: True ,
}
[
{
id:
{
Description: Service resource ID. ,
Required: True ,
}
string ,
}
,
]
,
maximumNumberOfBufferedPackets:
{
Description: The maximum number of downlink packets to buffer at the user plane for High Latency Communication - Extended Buffering. See 3GPP TS29.272 v15.10.0 section 7.3.188 for a full description. This maximum is not guaranteed because there is a internal limit on buffered packets across all PDU sessions. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
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. This will also delete any network functions that are a part of this site.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/sites/{siteName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. The value must be an UUID. ,
Format: uuid ,
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. ,
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 in the site. Deleting the site will delete any network functions that are deployed in the site. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
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. Must be created in the same location as its parent mobile network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/sites/{siteName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. ,
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 in the site. Deleting the site will delete any network functions that are deployed in the site. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Site properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the site 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 ,
networkFunctions:
{
Description: An array of IDs of the network functions deployed in the site. Deleting the site will delete any network functions that are deployed in the site. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Site properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the site 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 ,
networkFunctions:
{
Description: An array of IDs of the network functions deployed in the site. Deleting the site will delete any network functions that are deployed in the site. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
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 site tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/sites/{siteName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. ,
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 in the site. Deleting the site will delete any network functions that are deployed in the site. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
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. The value must be an UUID. ,
Format: uuid ,
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 mobile network. ,
Required: False ,
}
[
{
properties:
{
Description: Site properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the site 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 ,
networkFunctions:
{
Description: An array of IDs of the network functions deployed in the site. Deleting the site will delete any network functions that are deployed in the site. ,
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_DeletePacketCore (removed)
Description :  Deletes a packet core under the specified mobile network site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/sites/{siteName}/deletePacketCore
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 delete a packet core under a site. ,
Required: True ,
}
{
packetCore:
{
Description: Reference to an packet core control plane resource. ,
Required: False ,
}
{
id:
{
Description: Packet core control plane resource ID. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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 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. The value must be an UUID. ,
Format: uuid ,
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 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 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. The value must be an UUID. ,
Format: uuid ,
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 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: Single-network slice selection assistance information (S-NSSAI). Unique at the scope of a mobile network. ,
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 ,
}
,
}

⚐ 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 network slice. Must be created in the same location as its parent mobile network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/slices/{sliceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 network slice. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update 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: Single-network slice selection assistance information (S-NSSAI). Unique at the scope of a mobile network. ,
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 ,
}
,
}
,
}

⚐ 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: Single-network slice selection assistance information (S-NSSAI). Unique at the scope of a mobile network. ,
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 ,
}
,
}

⚐ 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: Single-network slice selection assistance information (S-NSSAI). Unique at the scope of a mobile network. ,
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 ,
}
,
}

⚐ 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 :  Updates 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. The value must be an UUID. ,
Format: uuid ,
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 network slice. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update 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: Single-network slice selection assistance information (S-NSSAI). Unique at the scope of a mobile network. ,
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 ,
}
,
}

⚐ 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. The value must be an UUID. ,
Format: uuid ,
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 network slices in a mobile network. ,
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: Single-network slice selection assistance information (S-NSSAI). Unique at the scope of a mobile network. ,
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 ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
ExtendedUeInformation_Get (removed)
Description :  Gets extended information about the specified UE from the packet core.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/ues/{ueId}/extendedInformation/default
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
packetCoreControlPlaneName:
{
Description: The name of the packet core control plane. ,
Required: True ,
}
string ,
ueId:
{
Description: IMSI of a UE. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Extended UE Information Properties. ,
Required: True ,
}
{
ratType:
{
Description: RAT Type ,
Enum:
{
4G: No description available. ,
5G: No description available. ,
}
,
Required: True ,
}
enum ,
lastReadAt:
{
Description: The timestamp of last UE info read from the packet core (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 ,
}
,
]
,
}
,
}
UeInformation_List (removed)
Description :  List all UEs and their state in a packet core.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/ues
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of UEs in a packet core and their basic information. ,
Required: False ,
}
[
{
properties:
{
Description: Basic UE Information Properties. ,
Required: True ,
}
{
ratType:
{
Description: RAT Type ,
Enum:
{
4G: No description available. ,
5G: No description available. ,
}
,
Required: True ,
}
enum ,
ueState:
{
Description: State of the UE. ,
Enum:
{
Connected: No description available. ,
Idle: No description available. ,
Detached: No description available. ,
Deregistered: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
ueIpAddresses:
{
Required: False ,
}
[
{
dnn:
{
Description: Data network name ,
Required: False ,
}
string ,
ueIpAddress:
{
Description: UE IP address ,
Required: False ,
}
{
ipV4Addr:
{
Description: IPv4 address. ,
Required: False ,
}
string ,
}
,
}
,
]
,
lastReadAt:
{
Description: The timestamp of last list UEs call to the packet core (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 ,
}
,
]
,
}
,
}