@azure/arm-iotfirmwaredefense package

Classes

IoTFirmwareDefenseClient

Interfaces

BinaryHardening

Interface representing a BinaryHardening.

BinaryHardeningFeatures

Binary hardening features.

BinaryHardeningListByFirmwareNextOptionalParams

Optional parameters.

BinaryHardeningListByFirmwareOptionalParams

Optional parameters.

BinaryHardeningListResult

List of binary hardening results.

BinaryHardeningResource

binary hardening analysis result resource

BinaryHardeningResult

Binary hardening of a firmware.

BinaryHardeningSummaryResource

Properties for a binary hardening analysis summary.

CryptoCertificate

Crypto certificate properties

CryptoCertificateEntity

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

CryptoCertificateListResult

List of crypto certificates.

CryptoCertificateResource

Crypto certificate resource

CryptoCertificateSummaryResource

Properties for cryptographic certificate summary.

CryptoCertificates

Interface representing a CryptoCertificates.

CryptoCertificatesListByFirmwareNextOptionalParams

Optional parameters.

CryptoCertificatesListByFirmwareOptionalParams

Optional parameters.

CryptoKey

Crypto key properties

CryptoKeyListResult

List of crypto keys.

CryptoKeyResource

Crypto key resource

CryptoKeySummaryResource

Properties for cryptographic key summary.

CryptoKeys

Interface representing a CryptoKeys.

CryptoKeysListByFirmwareNextOptionalParams

Optional parameters.

CryptoKeysListByFirmwareOptionalParams

Optional parameters.

CveComponent

Properties of the SBOM component for a CVE.

CveLink

Properties of a reference link for a CVE.

CveListResult

List of CVE results.

CveResource

CVE analysis result resource

CveResult

Details of a CVE detected in firmware.

CveSummary

Properties for a CVE analysis summary.

Cves

Interface representing a Cves.

CvesListByFirmwareNextOptionalParams

Optional parameters.

CvesListByFirmwareOptionalParams

Optional parameters.

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

FirmwareList

List of firmwares

FirmwareProperties

Firmware properties.

FirmwareSummary

Properties for high level summary of firmware analysis results.

FirmwareUpdateDefinition

Firmware definition

Firmwares

Interface representing a Firmwares.

FirmwaresCreateOptionalParams

Optional parameters.

FirmwaresDeleteOptionalParams

Optional parameters.

FirmwaresGenerateDownloadUrlOptionalParams

Optional parameters.

FirmwaresGenerateFilesystemDownloadUrlOptionalParams

Optional parameters.

FirmwaresGetOptionalParams

Optional parameters.

FirmwaresListByWorkspaceNextOptionalParams

Optional parameters.

FirmwaresListByWorkspaceOptionalParams

Optional parameters.

FirmwaresUpdateOptionalParams

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

PasswordHashListResult

List of password hash results

PasswordHashResource

Password hash resource

PasswordHashes

Interface representing a PasswordHashes.

PasswordHashesListByFirmwareNextOptionalParams

Optional parameters.

PasswordHashesListByFirmwareOptionalParams

Optional parameters.

Resource

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

SbomComponent

SBOM component of a firmware.

SbomComponentListResult

List of SBOM results.

SbomComponentResource

SBOM analysis result resource

SbomComponents

Interface representing a SbomComponents.

SbomComponentsListByFirmwareNextOptionalParams

Optional parameters.

SbomComponentsListByFirmwareOptionalParams

Optional parameters.

StatusMessage

Error and status message

Summaries

Interface representing a Summaries.

SummariesGetOptionalParams

Optional parameters.

SummariesListByFirmwareNextOptionalParams

Optional parameters.

SummariesListByFirmwareOptionalParams

Optional parameters.

SummaryListResult

List of analysis summaries.

SummaryResource

The object representing a firmware analysis summary resource.

SummaryResourceProperties

Properties of an analysis summary.

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.

WorkspaceProperties

Workspace properties.

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

BinaryHardeningListByFirmwareNextResponse

Contains response data for the listByFirmwareNext operation.

BinaryHardeningListByFirmwareResponse

Contains response data for the listByFirmware operation.

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

CryptoCertificatesListByFirmwareNextResponse

Contains response data for the listByFirmwareNext operation.

CryptoCertificatesListByFirmwareResponse

Contains response data for the listByFirmware operation.

CryptoKeysListByFirmwareNextResponse

Contains response data for the listByFirmwareNext operation.

CryptoKeysListByFirmwareResponse

Contains response data for the listByFirmware operation.

CvesListByFirmwareNextResponse

Contains response data for the listByFirmwareNext operation.

CvesListByFirmwareResponse

Contains response data for the listByFirmware operation.

FirmwaresCreateResponse

Contains response data for the create operation.

FirmwaresGenerateDownloadUrlResponse

Contains response data for the generateDownloadUrl operation.

FirmwaresGenerateFilesystemDownloadUrlResponse

Contains response data for the generateFilesystemDownloadUrl operation.

FirmwaresGetResponse

Contains response data for the get operation.

FirmwaresListByWorkspaceNextResponse

Contains response data for the listByWorkspaceNext operation.

FirmwaresListByWorkspaceResponse

Contains response data for the listByWorkspace operation.

FirmwaresUpdateResponse

Contains response data for the update operation.

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

PasswordHashesListByFirmwareNextResponse

Contains response data for the listByFirmwareNext operation.

PasswordHashesListByFirmwareResponse

Contains response data for the listByFirmware operation.

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

SbomComponentsListByFirmwareNextResponse

Contains response data for the listByFirmwareNext operation.

SbomComponentsListByFirmwareResponse

Contains response data for the listByFirmware operation.

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

SummariesGetResponse

Contains response data for the get operation.

SummariesListByFirmwareNextResponse

Contains response data for the listByFirmwareNext operation.

SummariesListByFirmwareResponse

Contains response data for the listByFirmware operation.

SummaryName

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

Known values supported by the service

Firmware
CVE
BinaryHardening
CryptoCertificate
CryptoKey

SummaryResourcePropertiesUnion
SummaryType

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

Known values supported by the service

Firmware
CVE
BinaryHardening
CryptoCertificate
CryptoKey

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.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownOrigin

Known values of Origin that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownStatus

Known values of Status that the service accepts.

KnownSummaryName

Known values of SummaryName that the service accepts.

KnownSummaryType

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