@azure/arm-networkfunction package

Interfaces

AzureTrafficCollector

Azure Traffic Collector resource.

AzureTrafficCollectorClientOptionalParams

Optional parameters for the client.

AzureTrafficCollectorPropertiesFormat

Azure Traffic Collector resource properties.

AzureTrafficCollectorsByResourceGroupListOptionalParams

Optional parameters.

AzureTrafficCollectorsByResourceGroupOperations

Interface representing a AzureTrafficCollectorsByResourceGroup operations.

AzureTrafficCollectorsBySubscriptionListOptionalParams

Optional parameters.

AzureTrafficCollectorsBySubscriptionOperations

Interface representing a AzureTrafficCollectorsBySubscription operations.

AzureTrafficCollectorsCreateOrUpdateOptionalParams

Optional parameters.

AzureTrafficCollectorsDeleteOptionalParams

Optional parameters.

AzureTrafficCollectorsGetOptionalParams

Optional parameters.

AzureTrafficCollectorsOperations

Interface representing a AzureTrafficCollectors operations.

AzureTrafficCollectorsUpdateTagsOptionalParams

Optional parameters.

CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

CollectorPoliciesCreateOrUpdateOptionalParams

Optional parameters.

CollectorPoliciesDeleteOptionalParams

Optional parameters.

CollectorPoliciesGetOptionalParams

Optional parameters.

CollectorPoliciesListOptionalParams

Optional parameters.

CollectorPoliciesOperations

Interface representing a CollectorPolicies operations.

CollectorPoliciesUpdateTagsOptionalParams

Optional parameters.

CollectorPolicy

Collector policy resource.

CollectorPolicyPropertiesFormat

Collection policy properties.

EmissionPoliciesPropertiesFormat

Emission policy properties.

EmissionPolicyDestination

Emission policy destination properties.

IngestionPolicyPropertiesFormat

Ingestion Policy properties.

IngestionSourcesPropertiesFormat

Ingestion policy properties.

NetworkFunctionListOperationsOptionalParams

Optional parameters.

NetworkFunctionOperations

Interface representing a NetworkFunction operations.

Operation

Azure Traffic Collector REST API operation definition.

OperationDisplay

Display metadata associated with the operation.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

ResourceReference

Resource reference properties.

RestorePollerOptions
SimplePollerLike

A simple poller that can be used to poll a long running operation.

SystemData

Metadata pertaining to creation and last modification of the resource.

TagsObject

Tags object for patch operations.

Type Aliases

AzureSupportedClouds

The supported values for cloud setting as a string literal type

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

DestinationType

Emission destination type.
KnownDestinationType can be used interchangeably with DestinationType, this enum contains the known values that the service supports.

Known values supported by the service

AzureMonitor: AzureMonitor

EmissionType

Emission format type.
KnownEmissionType can be used interchangeably with EmissionType, this enum contains the known values that the service supports.

Known values supported by the service

IPFIX: IPFIX

IngestionType

The ingestion type.
KnownIngestionType can be used interchangeably with IngestionType, this enum contains the known values that the service supports.

Known values supported by the service

IPFIX: IPFIX

ProvisioningState

The current provisioning state.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Succeeded
Updating: Updating
Deleting: Deleting
Failed: Failed

SourceType

Ingestion source type.
KnownSourceType can be used interchangeably with SourceType, this enum contains the known values that the service supports.

Known values supported by the service

Resource: Resource

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownCreatedByType

The kind of entity that created the resource.

KnownDestinationType

Emission destination type.

KnownEmissionType

Emission format type.

KnownIngestionType

The ingestion type.

KnownProvisioningState

The current provisioning state.

KnownSourceType

Ingestion source type.

KnownVersions

The available API versions.

Functions

isRestError(unknown)

Typeguard for RestError

restorePoller<TResponse, TResult>(AzureTrafficCollectorClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(AzureTrafficCollectorClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: AzureTrafficCollectorClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type