Share via


@azure/arm-iotfirmwaredefense package

Classes

IoTFirmwareDefenseClient

Interfaces

BinaryHardeningFeatures

Binary hardening features.

BinaryHardeningListByFirmwareOptionalParams

Optional parameters.

BinaryHardeningOperations

Interface representing a BinaryHardening operations.

BinaryHardeningResource

The object representing a firmware analysis binary hardening 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.

CryptoCertificateResource

The object representing a firmware analysis crypto certificate resource

CryptoCertificateSummaryResource

Properties for cryptographic certificate summary.

CryptoCertificatesListByFirmwareOptionalParams

Optional parameters.

CryptoCertificatesOperations

Interface representing a CryptoCertificates operations.

CryptoKey

Crypto key properties

CryptoKeyResource

The object representing a firmware analysis crypto key resource

CryptoKeySummaryResource

Properties for cryptographic key summary.

CryptoKeysListByFirmwareOptionalParams

Optional parameters.

CryptoKeysOperations

Interface representing a CryptoKeys operations.

CveComponent

Legacy component of a CVE result.

CveLink

Properties of a reference link for a CVE.

CveResource

The object representing a firmware analysis CVE result resource

CveResult

Details of a CVE detected in firmware.

CveSummary

Properties for a CVE analysis summary.

CvesListByFirmwareOptionalParams

Optional parameters.

CvesOperations

Interface representing a Cves operations.

CvssScore

Common Vulnerability Scoring System 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.

Firmware

Firmware definition

FirmwareProperties

Firmware properties.

FirmwareSummary

Properties for high level summary of firmware analysis results.

FirmwareUpdateDefinition

Firmware definition

FirmwaresCreateOptionalParams

Optional parameters.

FirmwaresDeleteOptionalParams

Optional parameters.

FirmwaresGetOptionalParams

Optional parameters.

FirmwaresListByWorkspaceOptionalParams

Optional parameters.

FirmwaresOperations

Interface representing a Firmwares operations.

FirmwaresUpdateOptionalParams

Optional parameters.

GenerateUploadUrlRequest

Properties for generating an upload URL

IoTFirmwareDefenseClientOptionalParams

Optional parameters for the client.

Operation

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

OperationDisplay

Localized display information for and operation.

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

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

PairedKey

Details of a matching paired key or certificate.

PasswordHash

Password hash properties

PasswordHashResource

The object representing a firmware analysis password hash result resource

PasswordHashesListByFirmwareOptionalParams

Optional parameters.

PasswordHashesOperations

Interface representing a PasswordHashes operations.

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

RestorePollerOptions
SbomComponent

SBOM component of a firmware.

SbomComponentResource

The object representing a firmware analysis SBOM component result resource

SbomComponentsListByFirmwareOptionalParams

Optional parameters.

SbomComponentsOperations

Interface representing a SbomComponents operations.

Sku

The resource model definition representing SKU

StatusMessage

Error and status message

SummariesGetOptionalParams

Optional parameters.

SummariesListByFirmwareOptionalParams

Optional parameters.

SummariesOperations

Interface representing a Summaries operations.

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.

UsageMetric

The object representing how many firmwares the user has uploaded to the workspace.

UsageMetricProperties

Properties of a workspaces usage metrics.

UsageMetricsGetOptionalParams

Optional parameters.

UsageMetricsListByWorkspaceOptionalParams

Optional parameters.

UsageMetricsOperations

Interface representing a UsageMetrics operations.

Workspace

Firmware analysis workspace.

WorkspaceProperties

Workspace properties.

WorkspaceUpdate

The type used for update operations of the Workspace.

WorkspacesCreateOptionalParams

Optional parameters.

WorkspacesDeleteOptionalParams

Optional parameters.

WorkspacesGenerateUploadUrlOptionalParams

Optional parameters.

WorkspacesGetOptionalParams

Optional parameters.

WorkspacesListByResourceGroupOptionalParams

Optional parameters.

WorkspacesListBySubscriptionOptionalParams

Optional parameters.

WorkspacesOperations

Interface representing a Workspaces operations.

WorkspacesUpdateOptionalParams

Optional parameters.

Type Aliases

ActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

AzureSupportedClouds

The supported values for cloud setting as a string literal type

CertificateUsage

Activities for which the cryptographic certificate can be used.
KnownCertificateUsage can be used interchangeably with CertificateUsage, this enum contains the known values that the service supports.

Known values supported by the service

digitalSignature: This certificate can be used to add a signature to a message
nonRepudiation: This certificates provides a non-repudiation service that protects against false denial of a message
contentCommitment: A synonym for NonRepudiation used in newer x509 certificates
keyEncipherment: This certificate can be used to encrypt a private or secret key
dataEncipherment: This certificate can be used to decrypt a private or secret key
keyAgreement: This certificate can be used to perform a key agreement, such as with a Diffie-Hellman key exchange
keyCertSign: This certificate can be used to verify a other public keys
crlSign: This certificate can be used to verify a certificate revocation list
encipherOnly: This certificate can be only be used to encrypt data
decipherOnly: This certificate can only be used to decrypt data
serverAuth: This certificate can be used to authenticate a server in a TLS/SSL connection
clientAuth: This certificate can be used to authenticate a client in a TLS/SSL connection
codeSigning: This certificate can be used to authenticate a code object
emailProtection: This certificate can be used to authenticate an email address
timeStamping: This certificate binds the hash of an object to a time
ocspSigning: This certificate can be used to sign OCSP responses

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
<xref: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.

CryptoKeyType

Different types of cryptographic keys.
KnownCryptoKeyType can be used interchangeably with CryptoKeyType, this enum contains the known values that the service supports.

Known values supported by the service

Public: The key is an asymmetric public key.
Private: The key is an asymmetric private key.

ExecutableClass

String to indicate if the executable is 32 or 64 bit.
KnownExecutableClass can be used interchangeably with ExecutableClass, this enum contains the known values that the service supports.

Known values supported by the service

x86: The binary is 32-bit.
x64: The binary is 64-bit.

Origin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

ProvisioningState

The status of a firmware analysis job.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The request has successfully completed.
Failed: There was an error during the request.
Canceled: The request was canceled.
Pending: The request is queued and awaiting execution
Extracting: The Firmware is currently being extracted.
Analyzing: Analysis is being run on the firmware

SkuTier

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

Status

The status of a firmware analysis job.
KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports.

Known values supported by the service

Pending: The analysis job is queued
Extracting: The firmware is currently being extracted
Analyzing: Analysis is being run on the firmware
Ready: Analysis job results are ready
Error: An error occurred while running firmware analysis

SummaryResourcePropertiesUnion

Alias for SummaryResourcePropertiesUnion

SummaryType

Describes the type of summary.
KnownSummaryType can be used interchangeably with SummaryType, this enum contains the known values that the service supports.

Known values supported by the service

Firmware: The summary contains information about the submitted firmware
CommonVulnerabilitiesAndExposures: The summary contains information about the Common Vulnerabilities and Exposures analysis results
BinaryHardening: The summary contains information about the binary hardening analysis results
CryptoCertificate: The summary contains information about the cryptographic certificate analysis results
CryptoKey: The summary contains information about the cryptographic key analysis results

Enums

AzureClouds

An enum to describe Azure Cloud.

KnownActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

KnownCertificateUsage

Activities for which the cryptographic certificate can be used.

KnownCreatedByType

The kind of entity that created the resource.

KnownCryptoKeyType

Different types of cryptographic keys.

KnownExecutableClass

String to indicate if the executable is 32 or 64 bit.

KnownOrigin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

KnownProvisioningState

The status of a firmware analysis job.

KnownStatus

The status of a firmware analysis job.

KnownSummaryType

Describes the type of summary.

KnownVersions

The available API versions.

Functions

restorePoller<TResponse, TResult>(IoTFirmwareDefenseClient, 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 Details

restorePoller<TResponse, TResult>(IoTFirmwareDefenseClient, 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: IoTFirmwareDefenseClient, 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>