Share via

@azure/arm-iotfirmwaredefense package

Classes

IoTFirmwareDefenseClient

Interfaces

BinaryHardening

Binary hardening of a firmware.
BinaryHardeningList

List result for binary hardening
BinaryHardeningSummary

Binary hardening summary percentages.
Component

Component of a firmware.
ComponentList

List result for components
CryptoCertificate

Crypto certificate properties
CryptoCertificateEntity

Information on an entity (distinguished name) in a cryptographic certificate.
CryptoCertificateList

Crypto certificates list
CryptoCertificateSummary

Cryptographic certificate summary values.
CryptoKey

Crypto key properties
CryptoKeyList

Crypto keys list
CryptoKeySummary

Cryptographic key summary values.
Cve

Known CVEs of a firmware.
CveComponent

Component for CVE
CveLink

Link for CVE
CveList

List result for CVE
CveSummary

CVE summary values.
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.).
Firmware

Firmware definition
FirmwareCreateOptionalParams

Optional parameters.
FirmwareDeleteOptionalParams

Optional parameters.
FirmwareGenerateBinaryHardeningDetailsOptionalParams

Optional parameters.
FirmwareGenerateBinaryHardeningSummaryOptionalParams

Optional parameters.
FirmwareGenerateComponentDetailsOptionalParams

Optional parameters.
FirmwareGenerateCryptoCertificateSummaryOptionalParams

Optional parameters.
FirmwareGenerateCryptoKeySummaryOptionalParams

Optional parameters.
FirmwareGenerateCveSummaryOptionalParams

Optional parameters.
FirmwareGenerateDownloadUrlOptionalParams

Optional parameters.
FirmwareGenerateFilesystemDownloadUrlOptionalParams

Optional parameters.
FirmwareGenerateSummaryOptionalParams

Optional parameters.
FirmwareGetOptionalParams

Optional parameters.
FirmwareList

List of firmwares
FirmwareListByWorkspaceNextOptionalParams

Optional parameters.
FirmwareListByWorkspaceOptionalParams

Optional parameters.
FirmwareListGenerateBinaryHardeningListNextOptionalParams

Optional parameters.
FirmwareListGenerateBinaryHardeningListOptionalParams

Optional parameters.
FirmwareListGenerateComponentListNextOptionalParams

Optional parameters.
FirmwareListGenerateComponentListOptionalParams

Optional parameters.
FirmwareListGenerateCryptoCertificateListNextOptionalParams

Optional parameters.
FirmwareListGenerateCryptoCertificateListOptionalParams

Optional parameters.
FirmwareListGenerateCryptoKeyListNextOptionalParams

Optional parameters.
FirmwareListGenerateCryptoKeyListOptionalParams

Optional parameters.
FirmwareListGenerateCveListNextOptionalParams

Optional parameters.
FirmwareListGenerateCveListOptionalParams

Optional parameters.
FirmwareListGeneratePasswordHashListNextOptionalParams

Optional parameters.
FirmwareListGeneratePasswordHashListOptionalParams

Optional parameters.
FirmwareOperations

Interface representing a FirmwareOperations.
FirmwareSummary

Summary result after scanning the firmware.
FirmwareUpdateDefinition

Firmware definition
FirmwareUpdateOptionalParams

Optional parameters.
GenerateUploadUrlRequest

Properties for generating an upload URL
IoTFirmwareDefenseClientOptionalParams

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

Details of a matching paired key or certificate.
PasswordHash

Password hash properties
PasswordHashList

Password hashes list
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
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'
UrlToken

Url data for creating or accessing a blob file.
Workspace

Firmware analysis workspace.
WorkspaceList

Return a list of firmware analysis workspaces.
WorkspaceUpdateDefinition

Firmware analysis workspace.
Workspaces

Interface representing a Workspaces.
WorkspacesCreateOptionalParams

Optional parameters.
WorkspacesDeleteOptionalParams

Optional parameters.
WorkspacesGenerateUploadUrlOptionalParams

Optional parameters.
WorkspacesGetOptionalParams

Optional parameters.
WorkspacesListByResourceGroupNextOptionalParams

Optional parameters.
WorkspacesListByResourceGroupOptionalParams

Optional parameters.
WorkspacesListBySubscriptionNextOptionalParams

Optional parameters.
WorkspacesListBySubscriptionOptionalParams

Optional parameters.
WorkspacesUpdateOptionalParams

Optional parameters.

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
CanaryFlag

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

Known values supported by the service

True
False
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
FirmwareCreateResponse

Contains response data for the create operation.
FirmwareGenerateBinaryHardeningDetailsResponse

Contains response data for the generateBinaryHardeningDetails operation.
FirmwareGenerateBinaryHardeningSummaryResponse

Contains response data for the generateBinaryHardeningSummary operation.
FirmwareGenerateComponentDetailsResponse

Contains response data for the generateComponentDetails operation.
FirmwareGenerateCryptoCertificateSummaryResponse

Contains response data for the generateCryptoCertificateSummary operation.
FirmwareGenerateCryptoKeySummaryResponse

Contains response data for the generateCryptoKeySummary operation.
FirmwareGenerateCveSummaryResponse

Contains response data for the generateCveSummary operation.
FirmwareGenerateDownloadUrlResponse

Contains response data for the generateDownloadUrl operation.
FirmwareGenerateFilesystemDownloadUrlResponse

Contains response data for the generateFilesystemDownloadUrl operation.
FirmwareGenerateSummaryResponse

Contains response data for the generateSummary operation.
FirmwareGetResponse

Contains response data for the get operation.
FirmwareListByWorkspaceNextResponse

Contains response data for the listByWorkspaceNext operation.
FirmwareListByWorkspaceResponse

Contains response data for the listByWorkspace operation.
FirmwareListGenerateBinaryHardeningListNextResponse

Contains response data for the listGenerateBinaryHardeningListNext operation.
FirmwareListGenerateBinaryHardeningListResponse

Contains response data for the listGenerateBinaryHardeningList operation.
FirmwareListGenerateComponentListNextResponse

Contains response data for the listGenerateComponentListNext operation.
FirmwareListGenerateComponentListResponse

Contains response data for the listGenerateComponentList operation.
FirmwareListGenerateCryptoCertificateListNextResponse

Contains response data for the listGenerateCryptoCertificateListNext operation.
FirmwareListGenerateCryptoCertificateListResponse

Contains response data for the listGenerateCryptoCertificateList operation.
FirmwareListGenerateCryptoKeyListNextResponse

Contains response data for the listGenerateCryptoKeyListNext operation.
FirmwareListGenerateCryptoKeyListResponse

Contains response data for the listGenerateCryptoKeyList operation.
FirmwareListGenerateCveListNextResponse

Contains response data for the listGenerateCveListNext operation.
FirmwareListGenerateCveListResponse

Contains response data for the listGenerateCveList operation.
FirmwareListGeneratePasswordHashListNextResponse

Contains response data for the listGeneratePasswordHashListNext operation.
FirmwareListGeneratePasswordHashListResponse

Contains response data for the listGeneratePasswordHashList operation.
FirmwareUpdateResponse

Contains response data for the update operation.
IsExpired

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

Known values supported by the service

True
False
IsSelfSigned

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

Known values supported by the service

True
False
IsShortKeySize

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

Known values supported by the service

True
False
IsUpdateAvailable

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

Known values supported by the service

True
False
IsWeakSignature

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

Known values supported by the service

True
False
NxFlag

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

Known values supported by the service

True
False
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
PieFlag

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

Known values supported by the service

True
False
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

Accepted
Succeeded
Canceled
Failed
RelroFlag

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

Known values supported by the service

True
False
Status

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

Known values supported by the service

Pending
Extracting
Analyzing
Ready
Error
StrippedFlag

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

Known values supported by the service

True
False
WorkspacesCreateResponse

Contains response data for the create operation.
WorkspacesGenerateUploadUrlResponse

Contains response data for the generateUploadUrl operation.
WorkspacesGetResponse

Contains response data for the get operation.
WorkspacesListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.
WorkspacesListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.
WorkspacesListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.
WorkspacesListBySubscriptionResponse

Contains response data for the listBySubscription operation.
WorkspacesUpdateResponse

Contains response data for the update operation.

Enums

KnownActionType

Known values of ActionType that the service accepts.
KnownCanaryFlag

Known values of CanaryFlag that the service accepts.
KnownCreatedByType

Known values of CreatedByType that the service accepts.
KnownIsExpired

Known values of IsExpired that the service accepts.
KnownIsSelfSigned

Known values of IsSelfSigned that the service accepts.
KnownIsShortKeySize

Known values of IsShortKeySize that the service accepts.
KnownIsUpdateAvailable

Known values of IsUpdateAvailable that the service accepts.
KnownIsWeakSignature

Known values of IsWeakSignature that the service accepts.
KnownNxFlag

Known values of NxFlag that the service accepts.
KnownOrigin

Known values of Origin that the service accepts.
KnownPieFlag

Known values of PieFlag that the service accepts.
KnownProvisioningState

Known values of ProvisioningState that the service accepts.
KnownRelroFlag

Known values of RelroFlag that the service accepts.
KnownStatus

Known values of Status that the service accepts.
KnownStrippedFlag

Known values of StrippedFlag 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.