PacketCoreControlPlanes interface

Package:

@azure/arm-mobilenetwork

Interface representing a PacketCoreControlPlanes.

Methods

beginCollectDiagnosticsPackage(string, string, PacketCoreControlPlaneCollectDiagnosticsPackage, PacketCoreControlPlanesCollectDiagnosticsPackageOptionalParams)	Collect a diagnostics package for the specified packet core control plane. This action will upload the diagnostics to a storage account.
beginCollectDiagnosticsPackageAndWait(string, string, PacketCoreControlPlaneCollectDiagnosticsPackage, PacketCoreControlPlanesCollectDiagnosticsPackageOptionalParams)	Collect a diagnostics package for the specified packet core control plane. This action will upload the diagnostics to a storage account.
beginCreateOrUpdate(string, string, PacketCoreControlPlane, PacketCoreControlPlanesCreateOrUpdateOptionalParams)	Creates or updates a packet core control plane.
beginCreateOrUpdateAndWait(string, string, PacketCoreControlPlane, PacketCoreControlPlanesCreateOrUpdateOptionalParams)	Creates or updates a packet core control plane.
beginDelete(string, string, PacketCoreControlPlanesDeleteOptionalParams)	Deletes the specified packet core control plane.
beginDeleteAndWait(string, string, PacketCoreControlPlanesDeleteOptionalParams)	Deletes the specified packet core control plane.
beginReinstall(string, string, PacketCoreControlPlanesReinstallOptionalParams)	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.
beginReinstallAndWait(string, string, PacketCoreControlPlanesReinstallOptionalParams)	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.
beginRollback(string, string, PacketCoreControlPlanesRollbackOptionalParams)	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.
beginRollbackAndWait(string, string, PacketCoreControlPlanesRollbackOptionalParams)	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.
get(string, string, PacketCoreControlPlanesGetOptionalParams)	Gets information about the specified packet core control plane.
listByResourceGroup(string, PacketCoreControlPlanesListByResourceGroupOptionalParams)	Lists all the packet core control planes in a resource group.
listBySubscription(PacketCoreControlPlanesListBySubscriptionOptionalParams)	Lists all the packet core control planes in a subscription.
updateTags(string, string, IdentityAndTagsObject, PacketCoreControlPlanesUpdateTagsOptionalParams)	Patch packet core control plane resource.

Method Details

beginCollectDiagnosticsPackage(string, string, PacketCoreControlPlaneCollectDiagnosticsPackage, PacketCoreControlPlanesCollectDiagnosticsPackageOptionalParams)

Collect a diagnostics package for the specified packet core control plane. This action will upload the diagnostics to a storage account.

function beginCollectDiagnosticsPackage(resourceGroupName: string, packetCoreControlPlaneName: string, parameters: PacketCoreControlPlaneCollectDiagnosticsPackage, options?: PacketCoreControlPlanesCollectDiagnosticsPackageOptionalParams): Promise<SimplePollerLike<OperationState<AsyncOperationStatus>, AsyncOperationStatus>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

packetCoreControlPlaneName

string

The name of the packet core control plane.

parameters

PacketCoreControlPlaneCollectDiagnosticsPackage

Parameters supplied to the packet core control plane collect diagnostics package operation.

options

PacketCoreControlPlanesCollectDiagnosticsPackageOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<AsyncOperationStatus>, AsyncOperationStatus>>

beginCollectDiagnosticsPackageAndWait(string, string, PacketCoreControlPlaneCollectDiagnosticsPackage, PacketCoreControlPlanesCollectDiagnosticsPackageOptionalParams)

Collect a diagnostics package for the specified packet core control plane. This action will upload the diagnostics to a storage account.

function beginCollectDiagnosticsPackageAndWait(resourceGroupName: string, packetCoreControlPlaneName: string, parameters: PacketCoreControlPlaneCollectDiagnosticsPackage, options?: PacketCoreControlPlanesCollectDiagnosticsPackageOptionalParams): Promise<AsyncOperationStatus>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

packetCoreControlPlaneName

string

The name of the packet core control plane.

parameters

PacketCoreControlPlaneCollectDiagnosticsPackage

Parameters supplied to the packet core control plane collect diagnostics package operation.

options

PacketCoreControlPlanesCollectDiagnosticsPackageOptionalParams

The options parameters.

Returns

Promise<AsyncOperationStatus>

beginCreateOrUpdate(string, string, PacketCoreControlPlane, PacketCoreControlPlanesCreateOrUpdateOptionalParams)

Creates or updates a packet core control plane.

function beginCreateOrUpdate(resourceGroupName: string, packetCoreControlPlaneName: string, parameters: PacketCoreControlPlane, options?: PacketCoreControlPlanesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PacketCoreControlPlane>, PacketCoreControlPlane>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

packetCoreControlPlaneName

string

The name of the packet core control plane.

parameters

PacketCoreControlPlane

Parameters supplied to the create or update packet core control plane operation.

options

PacketCoreControlPlanesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<PacketCoreControlPlane>, PacketCoreControlPlane>>

beginCreateOrUpdateAndWait(string, string, PacketCoreControlPlane, PacketCoreControlPlanesCreateOrUpdateOptionalParams)

Creates or updates a packet core control plane.

function beginCreateOrUpdateAndWait(resourceGroupName: string, packetCoreControlPlaneName: string, parameters: PacketCoreControlPlane, options?: PacketCoreControlPlanesCreateOrUpdateOptionalParams): Promise<PacketCoreControlPlane>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

packetCoreControlPlaneName

string

The name of the packet core control plane.

parameters

PacketCoreControlPlane

Parameters supplied to the create or update packet core control plane operation.

options

PacketCoreControlPlanesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PacketCoreControlPlane>

beginDelete(string, string, PacketCoreControlPlanesDeleteOptionalParams)

Deletes the specified packet core control plane.

function beginDelete(resourceGroupName: string, packetCoreControlPlaneName: string, options?: PacketCoreControlPlanesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

packetCoreControlPlaneName

string

The name of the packet core control plane.

options

PacketCoreControlPlanesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, PacketCoreControlPlanesDeleteOptionalParams)

Deletes the specified packet core control plane.

function beginDeleteAndWait(resourceGroupName: string, packetCoreControlPlaneName: string, options?: PacketCoreControlPlanesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

packetCoreControlPlaneName

string

The name of the packet core control plane.

options

PacketCoreControlPlanesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginReinstall(string, string, PacketCoreControlPlanesReinstallOptionalParams)

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.

function beginReinstall(resourceGroupName: string, packetCoreControlPlaneName: string, options?: PacketCoreControlPlanesReinstallOptionalParams): Promise<SimplePollerLike<OperationState<AsyncOperationStatus>, AsyncOperationStatus>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

packetCoreControlPlaneName

string

The name of the packet core control plane.

options

PacketCoreControlPlanesReinstallOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<AsyncOperationStatus>, AsyncOperationStatus>>

beginReinstallAndWait(string, string, PacketCoreControlPlanesReinstallOptionalParams)

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.

function beginReinstallAndWait(resourceGroupName: string, packetCoreControlPlaneName: string, options?: PacketCoreControlPlanesReinstallOptionalParams): Promise<AsyncOperationStatus>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

packetCoreControlPlaneName

string

The name of the packet core control plane.

options

PacketCoreControlPlanesReinstallOptionalParams

The options parameters.

Returns

Promise<AsyncOperationStatus>

beginRollback(string, string, PacketCoreControlPlanesRollbackOptionalParams)

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.

function beginRollback(resourceGroupName: string, packetCoreControlPlaneName: string, options?: PacketCoreControlPlanesRollbackOptionalParams): Promise<SimplePollerLike<OperationState<AsyncOperationStatus>, AsyncOperationStatus>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

packetCoreControlPlaneName

string

The name of the packet core control plane.

options

PacketCoreControlPlanesRollbackOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<AsyncOperationStatus>, AsyncOperationStatus>>

beginRollbackAndWait(string, string, PacketCoreControlPlanesRollbackOptionalParams)

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.

function beginRollbackAndWait(resourceGroupName: string, packetCoreControlPlaneName: string, options?: PacketCoreControlPlanesRollbackOptionalParams): Promise<AsyncOperationStatus>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

packetCoreControlPlaneName

string

The name of the packet core control plane.

options

PacketCoreControlPlanesRollbackOptionalParams

The options parameters.

Returns

Promise<AsyncOperationStatus>

get(string, string, PacketCoreControlPlanesGetOptionalParams)

Gets information about the specified packet core control plane.

function get(resourceGroupName: string, packetCoreControlPlaneName: string, options?: PacketCoreControlPlanesGetOptionalParams): Promise<PacketCoreControlPlane>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

packetCoreControlPlaneName

string

The name of the packet core control plane.

options

PacketCoreControlPlanesGetOptionalParams

The options parameters.

Returns

Promise<PacketCoreControlPlane>

listByResourceGroup(string, PacketCoreControlPlanesListByResourceGroupOptionalParams)

Lists all the packet core control planes in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: PacketCoreControlPlanesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<PacketCoreControlPlane, PacketCoreControlPlane[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options

PacketCoreControlPlanesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PacketCoreControlPlane, PacketCoreControlPlane[], PageSettings>

listBySubscription(PacketCoreControlPlanesListBySubscriptionOptionalParams)

Lists all the packet core control planes in a subscription.

function listBySubscription(options?: PacketCoreControlPlanesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<PacketCoreControlPlane, PacketCoreControlPlane[], PageSettings>

Parameters

options

PacketCoreControlPlanesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PacketCoreControlPlane, PacketCoreControlPlane[], PageSettings>

updateTags(string, string, IdentityAndTagsObject, PacketCoreControlPlanesUpdateTagsOptionalParams)

Patch packet core control plane resource.

function updateTags(resourceGroupName: string, packetCoreControlPlaneName: string, parameters: IdentityAndTagsObject, options?: PacketCoreControlPlanesUpdateTagsOptionalParams): Promise<PacketCoreControlPlane>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

packetCoreControlPlaneName

string

The name of the packet core control plane.

parameters

IdentityAndTagsObject

Parameters supplied to patch packet core control plane resource.

options

PacketCoreControlPlanesUpdateTagsOptionalParams

The options parameters.

Returns

Promise<PacketCoreControlPlane>