PacketCoreControlPlane interface

Package:

@azure/arm-mobilenetwork

Packet core control plane resource.

Extends

TrackedResource

Properties

controlPlaneAccessInterface	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.
controlPlaneAccessVirtualIpv4Addresses	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.
coreNetworkTechnology	The core network technology generation (5G core or EPC / 4G core).
diagnosticsUpload	Configuration for uploading packet core diagnostics
eventHub	Configuration for sending packet core events to an Azure Event Hub.
homeNetworkPrivateKeysProvisioning	The provisioning state of the secret containing private keys and keyIds for SUPI concealment. NOTE: This property will not be serialized. It can only be populated by the server.
identity	The identity used to retrieve the ingress certificate from Azure key vault.
installation	The installation state of the packet core control plane resource.
installedVersion	The currently installed version of the packet core software. NOTE: This property will not be serialized. It can only be populated by the server.
interopSettings	Settings to allow interoperability with third party components e.g. RANs and UEs.
localDiagnosticsAccess	The kubernetes ingress configuration to control access to packet core diagnostics over local APIs.
platform	The platform where the packet core is deployed.
provisioningState	The provisioning state of the packet core control plane resource. NOTE: This property will not be serialized. It can only be populated by the server.
rollbackVersion	The previous version of the packet core software that was deployed. Used when performing the rollback action. NOTE: This property will not be serialized. It can only be populated by the server.
signaling	Signaling configuration for the packet core.
sites	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.
sku	The SKU defining the throughput and SIM allowances for this packet core control plane deployment.
ueMtu	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.
userConsent	The user consent configuration for the packet core.
version	The desired version of the packet core software.

Inherited Properties

id	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
location	The geo-location where the resource lives
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

controlPlaneAccessInterface

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.

controlPlaneAccessInterface: InterfaceProperties

Property Value

InterfaceProperties

controlPlaneAccessVirtualIpv4Addresses

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.

controlPlaneAccessVirtualIpv4Addresses?: string[]

Property Value

string[]

coreNetworkTechnology

The core network technology generation (5G core or EPC / 4G core).

coreNetworkTechnology?: CoreNetworkType

Property Value

CoreNetworkType

diagnosticsUpload

Configuration for uploading packet core diagnostics

diagnosticsUpload?: DiagnosticsUploadConfiguration

Property Value

DiagnosticsUploadConfiguration

eventHub

Configuration for sending packet core events to an Azure Event Hub.

eventHub?: EventHubConfiguration

Property Value

EventHubConfiguration

homeNetworkPrivateKeysProvisioning

The provisioning state of the secret containing private keys and keyIds for SUPI concealment. NOTE: This property will not be serialized. It can only be populated by the server.

homeNetworkPrivateKeysProvisioning?: HomeNetworkPrivateKeysProvisioning

Property Value

HomeNetworkPrivateKeysProvisioning

identity

The identity used to retrieve the ingress certificate from Azure key vault.

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

installation

The installation state of the packet core control plane resource.

installation?: Installation

Property Value

Installation

installedVersion

The currently installed version of the packet core software. NOTE: This property will not be serialized. It can only be populated by the server.

installedVersion?: string

Property Value

string

interopSettings

Settings to allow interoperability with third party components e.g. RANs and UEs.

interopSettings?: Record<string, unknown>

Property Value

Record<string, unknown>

localDiagnosticsAccess

The kubernetes ingress configuration to control access to packet core diagnostics over local APIs.

localDiagnosticsAccess: LocalDiagnosticsAccessConfiguration

Property Value

LocalDiagnosticsAccessConfiguration

platform

The platform where the packet core is deployed.

platform: PlatformConfiguration

Property Value

PlatformConfiguration

provisioningState

The provisioning state of the packet core control plane resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

rollbackVersion

The previous version of the packet core software that was deployed. Used when performing the rollback action. NOTE: This property will not be serialized. It can only be populated by the server.

rollbackVersion?: string

Property Value

string

signaling

Signaling configuration for the packet core.

signaling?: SignalingConfiguration

Property Value

SignalingConfiguration

sites

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.

sites: SiteResourceId[]

Property Value

SiteResourceId[]

sku

The SKU defining the throughput and SIM allowances for this packet core control plane deployment.

sku: string

Property Value

string

ueMtu

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.

ueMtu?: number

Property Value

number

userConsent

The user consent configuration for the packet core.

userConsent?: UserConsentConfiguration

Property Value

UserConsentConfiguration

version

The desired version of the packet core software.

version?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type