Package-level declarations

Types

Link copied to clipboard
data class AmbrResponse(val downlink: String, val uplink: String)

Aggregate maximum bit rate.

Link copied to clipboard
data class AsyncOperationIdResponse(val id: String)

Reference to an Azure Async Operation ID.

Link copied to clipboard

Reference to an attached data network resource.

Link copied to clipboard

Reference to an Azure Stack Edge device resource.

Link copied to clipboard

Reference to an Azure Stack HCI cluster resource.

Link copied to clipboard
data class CertificateProvisioningResponse(val reason: String, val state: String)

Certificate provisioning state

Link copied to clipboard

Reference to an Azure Arc custom location resource.

Link copied to clipboard

Reference to an Azure Arc custom location resource.

Link copied to clipboard
data class DataNetworkConfigurationResponse(val additionalAllowedSessionTypes: List<String>? = null, val allocationAndRetentionPriorityLevel: Int? = null, val allowedServices: List<ServiceResourceIdResponse>, val dataNetwork: DataNetworkResourceIdResponse, val defaultSessionType: String? = null, val fiveQi: Int? = null, val maximumNumberOfBufferedPackets: Int? = null, val preemptionCapability: String? = null, val preemptionVulnerability: String? = null, val sessionAmbr: AmbrResponse)

Settings controlling data network use

Link copied to clipboard

Reference to a data network resource.

Link copied to clipboard
data class DiagnosticsUploadConfigurationResponse(val storageAccountContainerUrl: String)

Configuration for uploading packet core diagnostics.

Link copied to clipboard
data class GetAttachedDataNetworkResult(val dnsAddresses: List<String>, val id: String, val location: String, val name: String, val naptConfiguration: NaptConfigurationResponse? = null, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val userEquipmentAddressPoolPrefix: List<String>? = null, val userEquipmentStaticAddressPoolPrefix: List<String>? = null, val userPlaneDataInterface: InterfacePropertiesResponse)

Attached data network resource. Must be created in the same location as its parent packet core data plane.

Link copied to clipboard
data class GetDataNetworkResult(val description: String? = null, val id: String, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Data network resource. Must be created in the same location as its parent mobile network.

Link copied to clipboard
data class GetDiagnosticsPackageResult(val id: String, val name: String, val provisioningState: String, val reason: String, val status: String, val systemData: SystemDataResponse, val type: String)

Diagnostics package resource.

Link copied to clipboard
data class GetMobileNetworkResult(val id: String, val location: String, val name: String, val provisioningState: String, val publicLandMobileNetworkIdentifier: PlmnIdResponse, val serviceKey: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Mobile network resource.

Link copied to clipboard
data class GetPacketCaptureResult(val bytesToCapturePerPacket: Double? = null, val captureStartTime: String, val id: String, val name: String, val networkInterfaces: List<String>? = null, val provisioningState: String, val reason: String, val status: String, val systemData: SystemDataResponse, val timeLimitInSeconds: Int? = null, val totalBytesPerSession: Double? = null, val type: String)

Packet capture session resource.

Link copied to clipboard
data class GetPacketCoreControlPlaneResult(val controlPlaneAccessInterface: InterfacePropertiesResponse, val coreNetworkTechnology: String? = null, val diagnosticsUpload: DiagnosticsUploadConfigurationResponse? = null, val id: String, val identity: ManagedServiceIdentityResponse? = null, val installation: InstallationResponse? = null, val installedVersion: String, val interopSettings: Any? = null, val localDiagnosticsAccess: LocalDiagnosticsAccessConfigurationResponse, val location: String, val name: String, val platform: PlatformConfigurationResponse, val provisioningState: String, val rollbackVersion: String, val sites: List<SiteResourceIdResponse>, val sku: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val ueMtu: Int? = null, val version: String? = null)

Packet core control plane resource.

Link copied to clipboard
data class GetPacketCoreDataPlaneResult(val id: String, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val userPlaneAccessInterface: InterfacePropertiesResponse)

Packet core data plane resource. Must be created in the same location as its parent packet core control plane.

Link copied to clipboard
data class GetServiceResult(val id: String, val location: String, val name: String, val pccRules: List<PccRuleConfigurationResponse>, val provisioningState: String, val servicePrecedence: Int, val serviceQosPolicy: QosPolicyResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Service resource. Must be created in the same location as its parent mobile network.

Link copied to clipboard
data class GetSimGroupResult(val encryptionKey: KeyVaultKeyResponse? = null, val id: String, val identity: ManagedServiceIdentityResponse? = null, val location: String, val mobileNetwork: MobileNetworkResourceIdResponse? = null, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

SIM group resource.

Link copied to clipboard
data class GetSimPolicyResult(val defaultSlice: SliceResourceIdResponse, val id: String, val location: String, val name: String, val provisioningState: String, val registrationTimer: Int? = null, val rfspIndex: Int? = null, val siteProvisioningState: Map<String, String>, val sliceConfigurations: List<SliceConfigurationResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val ueAmbr: AmbrResponse)

SIM policy resource.

Link copied to clipboard
data class GetSimResult(val deviceType: String? = null, val id: String, val integratedCircuitCardIdentifier: String? = null, val internationalMobileSubscriberIdentity: String, val name: String, val provisioningState: String, val simPolicy: SimPolicyResourceIdResponse? = null, val simState: String, val siteProvisioningState: Map<String, String>, val staticIpConfiguration: List<SimStaticIpPropertiesResponse>? = null, val systemData: SystemDataResponse, val type: String, val vendorKeyFingerprint: String, val vendorName: String)

SIM resource.

Link copied to clipboard
data class GetSiteResult(val id: String, val location: String, val name: String, val networkFunctions: List<SubResourceResponse>, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Site resource. Must be created in the same location as its parent mobile network.

Link copied to clipboard
data class GetSliceResult(val description: String? = null, val id: String, val location: String, val name: String, val provisioningState: String, val snssai: SnssaiResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Network slice resource. Must be created in the same location as its parent mobile network.

Link copied to clipboard
data class HttpsServerCertificateResponse(val certificateUrl: String, val provisioning: CertificateProvisioningResponse)

HTTPS server certificate configuration.

Link copied to clipboard
data class InstallationResponse(val desiredState: String? = null, val operation: AsyncOperationIdResponse, val reasons: List<String>, val reinstallRequired: String, val state: String)

The installation state of the packet core.

Link copied to clipboard
data class InterfacePropertiesResponse(val ipv4Address: String? = null, val ipv4Gateway: String? = null, val ipv4Subnet: String? = null, val name: String? = null)

Interface properties

Link copied to clipboard
data class KeyVaultKeyResponse(val keyUrl: String? = null)

An Azure key vault key.

Link copied to clipboard
data class ListMobileNetworkSimGroupsResult(val nextLink: String, val value: List<SimGroupResponse>? = null)

Response for list SIM groups API service call.

Link copied to clipboard
data class ListMobileNetworkSimIdsResult(val nextLink: String, val value: List<SubResourceResponse>? = null)

Response for list SIM IDs API service call.

data class LocalDiagnosticsAccessConfigurationResponse(val authenticationType: String, val httpsServerCertificate: HttpsServerCertificateResponse? = null)

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

Link copied to clipboard
data class ManagedServiceIdentityResponse(val type: String, val userAssignedIdentities: Map<String, UserAssignedIdentityResponse>? = null)

Managed service identity (User assigned identity)

Link copied to clipboard

Reference to a mobile network resource.

Link copied to clipboard
data class NaptConfigurationResponse(val enabled: String? = null, val pinholeLimits: Int? = null, val pinholeTimeouts: PinholeTimeoutsResponse? = null, val portRange: PortRangeResponse? = null, val portReuseHoldTime: PortReuseHoldTimesResponse? = null)

The network address and port translation settings to use for the attached data network.

Link copied to clipboard
data class PccRuleConfigurationResponse(val ruleName: String, val rulePrecedence: Int, val ruleQosPolicy: PccRuleQosPolicyResponse? = null, val serviceDataFlowTemplates: List<ServiceDataFlowTemplateResponse>, val trafficControl: String? = null)

Data flow policy rule configuration

Link copied to clipboard
data class PccRuleQosPolicyResponse(val allocationAndRetentionPriorityLevel: Int? = null, val fiveQi: Int? = null, val guaranteedBitRate: AmbrResponse? = null, val maximumBitRate: AmbrResponse, val preemptionCapability: String? = null, val preemptionVulnerability: String? = null)

Data flow policy rule QoS policy

Link copied to clipboard
data class PinholeTimeoutsResponse(val icmp: Int? = null, val tcp: Int? = null, val udp: Int? = null)

Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second.

Link copied to clipboard
data class PlatformConfigurationResponse(val azureStackEdgeDevice: AzureStackEdgeDeviceResourceIdResponse? = null, val azureStackEdgeDevices: List<AzureStackEdgeDeviceResourceIdResponse>, val azureStackHciCluster: AzureStackHCIClusterResourceIdResponse? = null, val connectedCluster: ConnectedClusterResourceIdResponse? = null, val customLocation: CustomLocationResourceIdResponse? = null, val type: String)

The platform where the packet core is deployed.

Link copied to clipboard
data class PlmnIdResponse(val mcc: String, val mnc: String)

Public land mobile network (PLMN) ID.

Link copied to clipboard
data class PortRangeResponse(val maxPort: Int? = null, val minPort: Int? = null)

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.)

Link copied to clipboard
data class PortReuseHoldTimesResponse(val tcp: Int? = null, val udp: Int? = null)

The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by another pinhole. All hold times must be minimum 1 second.

Link copied to clipboard
data class QosPolicyResponse(val allocationAndRetentionPriorityLevel: Int? = null, val fiveQi: Int? = null, val maximumBitRate: AmbrResponse, val preemptionCapability: String? = null, val preemptionVulnerability: String? = null)

QoS policy

Link copied to clipboard
data class ServiceDataFlowTemplateResponse(val direction: String, val ports: List<String>? = null, val protocol: List<String>, val remoteIpList: List<String>, val templateName: String)

Data flow template

Link copied to clipboard
data class ServiceResourceIdResponse(val id: String)

Reference to a service resource.

Link copied to clipboard
data class SimGroupResponse(val encryptionKey: KeyVaultKeyResponse? = null, val id: String, val identity: ManagedServiceIdentityResponse? = null, val location: String, val mobileNetwork: MobileNetworkResourceIdResponse? = null, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

SIM group resource.

Link copied to clipboard

Reference to a SIM policy resource.

Link copied to clipboard
data class SimStaticIpPropertiesResponse(val attachedDataNetwork: AttachedDataNetworkResourceIdResponse? = null, val slice: SliceResourceIdResponse? = null, val staticIp: SimStaticIpPropertiesResponseStaticIp? = null)

Static IP configuration for a SIM, scoped to a particular attached data network and slice.

Link copied to clipboard
data class SimStaticIpPropertiesResponseStaticIp(val ipv4Address: String? = null)

The static IP configuration for the SIM to use at the defined network scope.

Link copied to clipboard
data class SiteResourceIdResponse(val id: String)

Reference to a site resource.

Link copied to clipboard
data class SliceConfigurationResponse(val dataNetworkConfigurations: List<DataNetworkConfigurationResponse>, val defaultDataNetwork: DataNetworkResourceIdResponse, val slice: SliceResourceIdResponse)

Per-slice settings

Link copied to clipboard
data class SliceResourceIdResponse(val id: String)

Reference to a slice resource.

Link copied to clipboard
data class SnssaiResponse(val sd: String? = null, val sst: Int)

Single-network slice selection assistance information (S-NSSAI).

Link copied to clipboard
data class SubResourceResponse(val id: String)

Reference to another sub resource.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class UserAssignedIdentityResponse(val clientId: String, val principalId: String)

User assigned identity properties