@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 10.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Packet core control plane resource.
*
* Uses Azure REST API version 2024-04-01. In version 2.x of the Azure Native provider, it used API version 2023-06-01.
*
* Other available API versions: 2022-04-01-preview, 2022-11-01, 2023-06-01, 2023-09-01, 2024-02-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native mobilenetwork [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class PacketCoreControlPlane extends pulumi.CustomResource {
/**
* Get an existing PacketCoreControlPlane resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): PacketCoreControlPlane;
/**
* Returns true if the given object is an instance of PacketCoreControlPlane. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is PacketCoreControlPlane;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* 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.
*/
readonly controlPlaneAccessInterface: pulumi.Output<outputs.mobilenetwork.InterfacePropertiesResponse>;
/**
* 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.
*/
readonly controlPlaneAccessVirtualIpv4Addresses: pulumi.Output<string[] | undefined>;
/**
* The core network technology generation (5G core or EPC / 4G core).
*/
readonly coreNetworkTechnology: pulumi.Output<string | undefined>;
/**
* Configuration for uploading packet core diagnostics
*/
readonly diagnosticsUpload: pulumi.Output<outputs.mobilenetwork.DiagnosticsUploadConfigurationResponse | undefined>;
/**
* Configuration for sending packet core events to an Azure Event Hub.
*/
readonly eventHub: pulumi.Output<outputs.mobilenetwork.EventHubConfigurationResponse | undefined>;
/**
* The provisioning state of the secret containing private keys and keyIds for SUPI concealment.
*/
readonly homeNetworkPrivateKeysProvisioning: pulumi.Output<outputs.mobilenetwork.HomeNetworkPrivateKeysProvisioningResponse>;
/**
* The identity used to retrieve the ingress certificate from Azure key vault.
*/
readonly identity: pulumi.Output<outputs.mobilenetwork.ManagedServiceIdentityResponse | undefined>;
/**
* The installation state of the packet core control plane resource.
*/
readonly installation: pulumi.Output<outputs.mobilenetwork.InstallationResponse | undefined>;
/**
* The currently installed version of the packet core software.
*/
readonly installedVersion: pulumi.Output<string>;
/**
* Settings to allow interoperability with third party components e.g. RANs and UEs.
*/
readonly interopSettings: pulumi.Output<any | undefined>;
/**
* The kubernetes ingress configuration to control access to packet core diagnostics over local APIs.
*/
readonly localDiagnosticsAccess: pulumi.Output<outputs.mobilenetwork.LocalDiagnosticsAccessConfigurationResponse>;
/**
* The geo-location where the resource lives
*/
readonly location: pulumi.Output<string>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* The platform where the packet core is deployed.
*/
readonly platform: pulumi.Output<outputs.mobilenetwork.PlatformConfigurationResponse>;
/**
* The provisioning state of the packet core control plane resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The previous version of the packet core software that was deployed. Used when performing the rollback action.
*/
readonly rollbackVersion: pulumi.Output<string>;
/**
* Signaling configuration for the packet core.
*/
readonly signaling: pulumi.Output<outputs.mobilenetwork.SignalingConfigurationResponse | undefined>;
/**
* 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.
*/
readonly sites: pulumi.Output<outputs.mobilenetwork.SiteResourceIdResponse[]>;
/**
* The SKU defining the throughput and SIM allowances for this packet core control plane deployment.
*/
readonly sku: pulumi.Output<string>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.mobilenetwork.SystemDataResponse>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* 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.
*/
readonly ueMtu: pulumi.Output<number | undefined>;
/**
* The user consent configuration for the packet core.
*/
readonly userConsent: pulumi.Output<outputs.mobilenetwork.UserConsentConfigurationResponse | undefined>;
/**
* The desired version of the packet core software.
*/
readonly version: pulumi.Output<string | undefined>;
/**
* Create a PacketCoreControlPlane resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: PacketCoreControlPlaneArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a PacketCoreControlPlane resource.
*/
export interface PacketCoreControlPlaneArgs {
/**
* 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: pulumi.Input<inputs.mobilenetwork.InterfacePropertiesArgs>;
/**
* 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?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The core network technology generation (5G core or EPC / 4G core).
*/
coreNetworkTechnology?: pulumi.Input<string | enums.mobilenetwork.CoreNetworkType>;
/**
* Configuration for uploading packet core diagnostics
*/
diagnosticsUpload?: pulumi.Input<inputs.mobilenetwork.DiagnosticsUploadConfigurationArgs>;
/**
* Configuration for sending packet core events to an Azure Event Hub.
*/
eventHub?: pulumi.Input<inputs.mobilenetwork.EventHubConfigurationArgs>;
/**
* The identity used to retrieve the ingress certificate from Azure key vault.
*/
identity?: pulumi.Input<inputs.mobilenetwork.ManagedServiceIdentityArgs>;
/**
* The installation state of the packet core control plane resource.
*/
installation?: pulumi.Input<inputs.mobilenetwork.InstallationArgs>;
/**
* Settings to allow interoperability with third party components e.g. RANs and UEs.
*/
interopSettings?: any;
/**
* The kubernetes ingress configuration to control access to packet core diagnostics over local APIs.
*/
localDiagnosticsAccess: pulumi.Input<inputs.mobilenetwork.LocalDiagnosticsAccessConfigurationArgs>;
/**
* The geo-location where the resource lives
*/
location?: pulumi.Input<string>;
/**
* The name of the packet core control plane.
*/
packetCoreControlPlaneName?: pulumi.Input<string>;
/**
* The platform where the packet core is deployed.
*/
platform: pulumi.Input<inputs.mobilenetwork.PlatformConfigurationArgs>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Signaling configuration for the packet core.
*/
signaling?: pulumi.Input<inputs.mobilenetwork.SignalingConfigurationArgs>;
/**
* 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: pulumi.Input<pulumi.Input<inputs.mobilenetwork.SiteResourceIdArgs>[]>;
/**
* The SKU defining the throughput and SIM allowances for this packet core control plane deployment.
*/
sku: pulumi.Input<string | enums.mobilenetwork.BillingSku>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* 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?: pulumi.Input<number>;
/**
* The user consent configuration for the packet core.
*/
userConsent?: pulumi.Input<inputs.mobilenetwork.UserConsentConfigurationArgs>;
/**
* The desired version of the packet core software.
*/
version?: pulumi.Input<string>;
}