Share via

@azure/arm-networkanalytics package

  • Reference

Classes

MicrosoftNetworkAnalytics

Interfaces

AccountSas

The details for storage account sas creation.
AccountSasToken

Details of storage account sas token .
ConsumptionEndpointsProperties

Details of Consumption Properties
ContainerSaS

The details for container sas creation.
ContainerSasToken

Details of storage container account sas token .
DataProduct

The data product resource.
DataProductInformation

Data Product Information
DataProductListResult

The response of a DataProduct list operation.
DataProductNetworkAcls

Data Product Network rule set
DataProductProperties

The data product properties.
DataProductUpdate

The type used for update operations of the DataProduct.
DataProductUpdateProperties

The updatable properties of the DataProduct.
DataProductVersion

Data Product Version.
DataProducts

Interface representing a DataProducts.
DataProductsAddUserRoleOptionalParams

Optional parameters.
DataProductsCatalog

The data catalog resource.
DataProductsCatalogListResult

The response of a DataProductsCatalog list operation.
DataProductsCatalogProperties

Details for data catalog properties.
DataProductsCatalogs

Interface representing a DataProductsCatalogs.
DataProductsCatalogsGetOptionalParams

Optional parameters.
DataProductsCatalogsListByResourceGroupNextOptionalParams

Optional parameters.
DataProductsCatalogsListByResourceGroupOptionalParams

Optional parameters.
DataProductsCatalogsListBySubscriptionNextOptionalParams

Optional parameters.
DataProductsCatalogsListBySubscriptionOptionalParams

Optional parameters.
DataProductsCreateHeaders

Defines headers for DataProducts_create operation.
DataProductsCreateOptionalParams

Optional parameters.
DataProductsDeleteHeaders

Defines headers for DataProducts_delete operation.
DataProductsDeleteOptionalParams

Optional parameters.
DataProductsGenerateStorageAccountSasTokenOptionalParams

Optional parameters.
DataProductsGetOptionalParams

Optional parameters.
DataProductsListByResourceGroupNextOptionalParams

Optional parameters.
DataProductsListByResourceGroupOptionalParams

Optional parameters.
DataProductsListBySubscriptionNextOptionalParams

Optional parameters.
DataProductsListBySubscriptionOptionalParams

Optional parameters.
DataProductsListRolesAssignmentsOptionalParams

Optional parameters.
DataProductsRemoveUserRoleOptionalParams

Optional parameters.
DataProductsRotateKeyOptionalParams

Optional parameters.
DataProductsUpdateHeaders

Defines headers for DataProducts_update operation.
DataProductsUpdateOptionalParams

Optional parameters.
DataType

The data type resource.
DataTypeListResult

The response of a DataType list operation.
DataTypeProperties

The data type properties
DataTypeUpdate

The type used for update operations of the DataType.
DataTypeUpdateProperties

The updatable properties of the DataType.
DataTypes

Interface representing a DataTypes.
DataTypesCreateHeaders

Defines headers for DataTypes_create operation.
DataTypesCreateOptionalParams

Optional parameters.
DataTypesDeleteDataHeaders

Defines headers for DataTypes_deleteData operation.
DataTypesDeleteDataOptionalParams

Optional parameters.
DataTypesDeleteHeaders

Defines headers for DataTypes_delete operation.
DataTypesDeleteOptionalParams

Optional parameters.
DataTypesGenerateStorageContainerSasTokenOptionalParams

Optional parameters.
DataTypesGetOptionalParams

Optional parameters.
DataTypesListByDataProductNextOptionalParams

Optional parameters.
DataTypesListByDataProductOptionalParams

Optional parameters.
DataTypesUpdateHeaders

Defines headers for DataTypes_update operation.
DataTypesUpdateOptionalParams

Optional parameters.
EncryptionKeyDetails

Encryption key details.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
IPRules

IP rule with specific IP or IP range in CIDR format.
KeyVaultInfo

Details for KeyVault.
ListRoleAssignments

list role assignments.
ManagedResourceGroupConfiguration

ManagedResourceGroup related properties
ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)
MicrosoftNetworkAnalyticsOptionalParams

Optional parameters.
Operation

Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay

Localized display information for this particular operation.
OperationListResult

A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
Operations

Interface representing a Operations.
OperationsListNextOptionalParams

Optional parameters.
OperationsListOptionalParams

Optional parameters.
ProxyResource

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

Details for Publisher Information.
Resource

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

Resource Access Rules.
RoleAssignmentCommonProperties

The details for role assignment common properties.
RoleAssignmentDetail

The details for role assignment response.
SystemData

Metadata pertaining to creation and last modification of the resource.
TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UserAssignedIdentity

User assigned identity properties
VirtualNetworkRule

Virtual Network Rule

Type Aliases

ActionType

Defines values for ActionType.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal
Bypass

Defines values for Bypass.
KnownBypass can be used interchangeably with Bypass, this enum contains the known values that the service supports.

Known values supported by the service

None: Represents no bypassing of traffic.
Logging: Represents bypassing logging traffic.
Metrics: Represents bypassing metrics traffic.
AzureServices: Represents bypassing azure services traffic.
ControlState

Defines values for ControlState.
KnownControlState can be used interchangeably with ControlState, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Field to enable a setting.
Disabled: Field to disable a setting.
CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key
DataProductUserRole

Defines values for DataProductUserRole.
KnownDataProductUserRole can be used interchangeably with DataProductUserRole, this enum contains the known values that the service supports.

Known values supported by the service

Reader: Field to specify user of type Reader.
SensitiveReader: Field to specify user of type SensitiveReader. This user has privileged access to read sensitive data of a data product.
DataProductsAddUserRoleResponse

Contains response data for the addUserRole operation.
DataProductsCatalogsGetResponse

Contains response data for the get operation.
DataProductsCatalogsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.
DataProductsCatalogsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.
DataProductsCatalogsListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.
DataProductsCatalogsListBySubscriptionResponse

Contains response data for the listBySubscription operation.
DataProductsCreateResponse

Contains response data for the create operation.
DataProductsDeleteResponse

Contains response data for the delete operation.
DataProductsGenerateStorageAccountSasTokenResponse

Contains response data for the generateStorageAccountSasToken operation.
DataProductsGetResponse

Contains response data for the get operation.
DataProductsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.
DataProductsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.
DataProductsListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.
DataProductsListBySubscriptionResponse

Contains response data for the listBySubscription operation.
DataProductsListRolesAssignmentsResponse

Contains response data for the listRolesAssignments operation.
DataProductsUpdateResponse

Contains response data for the update operation.
DataTypeState

Defines values for DataTypeState.
KnownDataTypeState can be used interchangeably with DataTypeState, this enum contains the known values that the service supports.

Known values supported by the service

Stopped: Field to specify stopped state.
Running: Field to specify running state.
DataTypesCreateResponse

Contains response data for the create operation.
DataTypesDeleteDataResponse

Contains response data for the deleteData operation.
DataTypesDeleteResponse

Contains response data for the delete operation.
DataTypesGenerateStorageContainerSasTokenResponse

Contains response data for the generateStorageContainerSasToken operation.
DataTypesGetResponse

Contains response data for the get operation.
DataTypesListByDataProductNextResponse

Contains response data for the listByDataProductNext operation.
DataTypesListByDataProductResponse

Contains response data for the listByDataProduct operation.
DataTypesUpdateResponse

Contains response data for the update operation.
DefaultAction

Defines values for DefaultAction.
KnownDefaultAction can be used interchangeably with DefaultAction, this enum contains the known values that the service supports.

Known values supported by the service

Allow: Represents allow action.
Deny: Represents deny action.
ManagedServiceIdentityType

Defines values for ManagedServiceIdentityType.
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
OperationsListNextResponse

Contains response data for the listNext operation.
OperationsListResponse

Contains response data for the list operation.
Origin

Defines values for Origin.
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user
system
user,system
ProvisioningState

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Represents a succeeded operation.
Failed: Represents a failed operation.
Canceled: Represents a canceled operation.
Provisioning: Represents a pending operation.
Updating: Represents a pending operation.
Deleting: Represents an operation under deletion.
Accepted: Represents an accepted operation.
Versions

Defines values for Versions.
KnownVersions can be used interchangeably with Versions, this enum contains the known values that the service supports.

Known values supported by the service

2023-11-15: The 2023-11-15 stable version.

Enums

KnownActionType

Known values of ActionType that the service accepts.
KnownBypass

Known values of Bypass that the service accepts.
KnownControlState

Known values of ControlState that the service accepts.
KnownCreatedByType

Known values of CreatedByType that the service accepts.
KnownDataProductUserRole

Known values of DataProductUserRole that the service accepts.
KnownDataTypeState

Known values of DataTypeState that the service accepts.
KnownDefaultAction

Known values of DefaultAction that the service accepts.
KnownManagedServiceIdentityType

Known values of ManagedServiceIdentityType that the service accepts.
KnownOrigin

Known values of Origin that the service accepts.
KnownProvisioningState

Known values of ProvisioningState that the service accepts.
KnownVersions

Known values of Versions that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.