Interface PacketCoreControlPlane
public interface PacketCoreControlPlane
An immutable client-side representation of PacketCoreControlPlane.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
The entirety of the PacketCoreControlPlane definition.static interface
The PacketCoreControlPlane definition stages.static interface
The template for PacketCoreControlPlane update.static interface
The PacketCoreControlPlane update stages. -
Method Summary
Modifier and TypeMethodDescriptionCollect a diagnostics package for the specified packet core control plane.collectDiagnosticsPackage
(PacketCoreControlPlaneCollectDiagnosticsPackage parameters, com.azure.core.util.Context context) Collect a diagnostics package for the specified packet core control plane.Gets the controlPlaneAccessInterface property: The control plane interface on the access network.Gets the coreNetworkTechnology property: The core network technology generation (5G core or EPC / 4G core).id()
Gets the id property: Fully qualified resource Id for the resource.identity()
Gets the identity property: The identity used to retrieve the ingress certificate from Azure key vault.Gets the inner com.azure.resourcemanager.mobilenetwork.fluent.models.PacketCoreControlPlaneInner object.Gets the installation property: The installation state of the packet core control plane resource.Gets the interopSettings property: Settings to allow interoperability with third party components e.g.Gets the localDiagnosticsAccess property: The kubernetes ingress configuration to control access to packet core diagnostics over local APIs.location()
Gets the location property: The geo-location where the resource lives.name()
Gets the name property: The name of the resource.platform()
Gets the platform property: The platform where the packet core is deployed.Gets the provisioningState property: The provisioning state of the packet core control plane resource.refresh()
Refreshes the resource to sync with Azure.refresh
(com.azure.core.util.Context context) Refreshes the resource to sync with Azure.com.azure.core.management.Region
region()
Gets the region of the resource.Gets the name of the resource region.Reinstall the specified packet core control plane.reinstall
(com.azure.core.util.Context context) Reinstall the specified packet core control plane.Gets the name of the resource group.rollback()
Roll back the specified packet core control plane to the previous version, "rollbackVersion".rollback
(com.azure.core.util.Context context) Roll back the specified packet core control plane to the previous version, "rollbackVersion".Gets the rollbackVersion property: The previous version of the packet core software that was deployed.sites()
Gets the sites property: Site(s) under which this packet core control plane should be deployed.sku()
Gets the sku property: The SKU defining the throughput and SIM allowances for this packet core control plane deployment.com.azure.core.management.SystemData
Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.tags()
Gets the tags property: Resource tags.type()
Gets the type property: The type of the resource.ueMtu()
Gets the ueMtu property: The MTU (in bytes) signaled to the UE.update()
Begins update for the PacketCoreControlPlane resource.version()
Gets the version property: The version of the packet core software that is deployed.
-
Method Details
-
id
String id()Gets the id property: Fully qualified resource Id for the resource.- Returns:
- the id value.
-
name
String name()Gets the name property: The name of the resource.- Returns:
- the name value.
-
type
String type()Gets the type property: The type of the resource.- Returns:
- the type value.
-
location
String location()Gets the location property: The geo-location where the resource lives.- Returns:
- the location value.
-
tags
Gets the tags property: Resource tags.- Returns:
- the tags value.
-
identity
ManagedServiceIdentity identity()Gets the identity property: The identity used to retrieve the ingress certificate from Azure key vault.- Returns:
- the identity value.
-
systemData
com.azure.core.management.SystemData systemData()Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.- Returns:
- the systemData value.
-
provisioningState
ProvisioningState provisioningState()Gets the provisioningState property: The provisioning state of the packet core control plane resource.- Returns:
- the provisioningState value.
-
installation
Installation installation()Gets the installation property: The installation state of the packet core control plane resource.- Returns:
- the installation value.
-
sites
List<SiteResourceId> sites()Gets the sites property: 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.- Returns:
- the sites value.
-
platform
PlatformConfiguration platform()Gets the platform property: The platform where the packet core is deployed.- Returns:
- the platform value.
-
coreNetworkTechnology
CoreNetworkType coreNetworkTechnology()Gets the coreNetworkTechnology property: The core network technology generation (5G core or EPC / 4G core).- Returns:
- the coreNetworkTechnology value.
-
version
String version()Gets the version property: The version of the packet core software that is deployed.- Returns:
- the version value.
-
rollbackVersion
String rollbackVersion()Gets the rollbackVersion property: The previous version of the packet core software that was deployed. Used when performing the rollback action.- Returns:
- the rollbackVersion value.
-
controlPlaneAccessInterface
InterfaceProperties controlPlaneAccessInterface()Gets the controlPlaneAccessInterface property: 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.- Returns:
- the controlPlaneAccessInterface value.
-
sku
BillingSku sku()Gets the sku property: The SKU defining the throughput and SIM allowances for this packet core control plane deployment.- Returns:
- the sku value.
-
ueMtu
Integer ueMtu()Gets the ueMtu property: 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.- Returns:
- the ueMtu value.
-
localDiagnosticsAccess
LocalDiagnosticsAccessConfiguration localDiagnosticsAccess()Gets the localDiagnosticsAccess property: The kubernetes ingress configuration to control access to packet core diagnostics over local APIs.- Returns:
- the localDiagnosticsAccess value.
-
interopSettings
Object interopSettings()Gets the interopSettings property: Settings to allow interoperability with third party components e.g. RANs and UEs.- Returns:
- the interopSettings value.
-
region
com.azure.core.management.Region region()Gets the region of the resource.- Returns:
- the region of the resource.
-
regionName
String regionName()Gets the name of the resource region.- Returns:
- the name of the resource region.
-
resourceGroupName
String resourceGroupName()Gets the name of the resource group.- Returns:
- the name of the resource group.
-
innerModel
PacketCoreControlPlaneInner innerModel()Gets the inner com.azure.resourcemanager.mobilenetwork.fluent.models.PacketCoreControlPlaneInner object.- Returns:
- the inner object.
-
update
PacketCoreControlPlane.Update update()Begins update for the PacketCoreControlPlane resource.- Returns:
- the stage of resource update.
-
refresh
PacketCoreControlPlane refresh()Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
Refreshes the resource to sync with Azure.- Parameters:
context
- The context to associate with this operation.- Returns:
- the refreshed resource.
-
rollback
AsyncOperationStatus rollback()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.- Returns:
- the current status of an async operation.
- Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
rollback
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.- Parameters:
context
- The context to associate with this operation.- Returns:
- the current status of an async operation.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
reinstall
AsyncOperationStatus reinstall()Reinstall the specified packet core control plane. This action will remove any transaction state from the packet core to return it to a known state. This action will cause a service outage.- Returns:
- the current status of an async operation.
- Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
reinstall
Reinstall the specified packet core control plane. This action will remove any transaction state from the packet core to return it to a known state. This action will cause a service outage.- Parameters:
context
- The context to associate with this operation.- Returns:
- the current status of an async operation.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
collectDiagnosticsPackage
AsyncOperationStatus collectDiagnosticsPackage(PacketCoreControlPlaneCollectDiagnosticsPackage parameters) Collect a diagnostics package for the specified packet core control plane. This action will upload the diagnostics to a storage account.- Parameters:
parameters
- Parameters supplied to the packet core control plane collect diagnostics package operation.- Returns:
- the current status of an async operation.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
collectDiagnosticsPackage
AsyncOperationStatus collectDiagnosticsPackage(PacketCoreControlPlaneCollectDiagnosticsPackage parameters, com.azure.core.util.Context context) Collect a diagnostics package for the specified packet core control plane. This action will upload the diagnostics to a storage account.- Parameters:
parameters
- Parameters supplied to the packet core control plane collect diagnostics package operation.context
- The context to associate with this operation.- Returns:
- the current status of an async operation.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-