FirmwareOperations interface
Interface representing a FirmwareOperations.
Methods
Method Details
create(string, string, string, Firmware, FirmwareCreateOptionalParams)
The operation to create a firmware.
function create(resourceGroupName: string, workspaceName: string, firmwareId: string, firmware: Firmware, options?: FirmwareCreateOptionalParams): Promise<Firmware>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
- firmwareId
-
string
The id of the firmware.
- firmware
- Firmware
Details of the firmware being created or updated.
- options
- FirmwareCreateOptionalParams
The options parameters.
Returns
Promise<Firmware>
delete(string, string, string, FirmwareDeleteOptionalParams)
The operation to delete a firmware.
function delete(resourceGroupName: string, workspaceName: string, firmwareId: string, options?: FirmwareDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
- firmwareId
-
string
The id of the firmware.
- options
- FirmwareDeleteOptionalParams
The options parameters.
Returns
Promise<void>
generateBinaryHardeningDetails(string, string, string, FirmwareGenerateBinaryHardeningDetailsOptionalParams)
The operation to get binary hardening details for a firmware.
function generateBinaryHardeningDetails(resourceGroupName: string, workspaceName: string, firmwareId: string, options?: FirmwareGenerateBinaryHardeningDetailsOptionalParams): Promise<BinaryHardening>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
- firmwareId
-
string
The id of the firmware.
The options parameters.
Returns
Promise<BinaryHardening>
generateBinaryHardeningSummary(string, string, string, FirmwareGenerateBinaryHardeningSummaryOptionalParams)
The operation to list the binary hardening summary percentages for a firmware.
function generateBinaryHardeningSummary(resourceGroupName: string, workspaceName: string, firmwareId: string, options?: FirmwareGenerateBinaryHardeningSummaryOptionalParams): Promise<BinaryHardeningSummary>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
- firmwareId
-
string
The id of the firmware.
The options parameters.
Returns
Promise<BinaryHardeningSummary>
generateComponentDetails(string, string, string, FirmwareGenerateComponentDetailsOptionalParams)
The operation to get component details for a firmware.
function generateComponentDetails(resourceGroupName: string, workspaceName: string, firmwareId: string, options?: FirmwareGenerateComponentDetailsOptionalParams): Promise<Component>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
- firmwareId
-
string
The id of the firmware.
The options parameters.
Returns
Promise<Component>
generateCryptoCertificateSummary(string, string, string, FirmwareGenerateCryptoCertificateSummaryOptionalParams)
The operation to provide a high level summary of the discovered cryptographic certificates reported for the firmware image.
function generateCryptoCertificateSummary(resourceGroupName: string, workspaceName: string, firmwareId: string, options?: FirmwareGenerateCryptoCertificateSummaryOptionalParams): Promise<CryptoCertificateSummary>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
- firmwareId
-
string
The id of the firmware.
The options parameters.
Returns
Promise<CryptoCertificateSummary>
generateCryptoKeySummary(string, string, string, FirmwareGenerateCryptoKeySummaryOptionalParams)
The operation to provide a high level summary of the discovered cryptographic keys reported for the firmware image.
function generateCryptoKeySummary(resourceGroupName: string, workspaceName: string, firmwareId: string, options?: FirmwareGenerateCryptoKeySummaryOptionalParams): Promise<CryptoKeySummary>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
- firmwareId
-
string
The id of the firmware.
The options parameters.
Returns
Promise<CryptoKeySummary>
generateCveSummary(string, string, string, FirmwareGenerateCveSummaryOptionalParams)
The operation to provide a high level summary of the CVEs reported for the firmware image.
function generateCveSummary(resourceGroupName: string, workspaceName: string, firmwareId: string, options?: FirmwareGenerateCveSummaryOptionalParams): Promise<CveSummary>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
- firmwareId
-
string
The id of the firmware.
The options parameters.
Returns
Promise<CveSummary>
generateDownloadUrl(string, string, string, FirmwareGenerateDownloadUrlOptionalParams)
The operation to a url for file download.
function generateDownloadUrl(resourceGroupName: string, workspaceName: string, firmwareId: string, options?: FirmwareGenerateDownloadUrlOptionalParams): Promise<UrlToken>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
- firmwareId
-
string
The id of the firmware.
The options parameters.
Returns
Promise<UrlToken>
generateFilesystemDownloadUrl(string, string, string, FirmwareGenerateFilesystemDownloadUrlOptionalParams)
The operation to a url for tar file download.
function generateFilesystemDownloadUrl(resourceGroupName: string, workspaceName: string, firmwareId: string, options?: FirmwareGenerateFilesystemDownloadUrlOptionalParams): Promise<UrlToken>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
- firmwareId
-
string
The id of the firmware.
The options parameters.
Returns
Promise<UrlToken>
generateSummary(string, string, string, FirmwareGenerateSummaryOptionalParams)
The operation to get a scan summary.
function generateSummary(resourceGroupName: string, workspaceName: string, firmwareId: string, options?: FirmwareGenerateSummaryOptionalParams): Promise<FirmwareSummary>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
- firmwareId
-
string
The id of the firmware.
The options parameters.
Returns
Promise<FirmwareSummary>
get(string, string, string, FirmwareGetOptionalParams)
Get firmware.
function get(resourceGroupName: string, workspaceName: string, firmwareId: string, options?: FirmwareGetOptionalParams): Promise<Firmware>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
- firmwareId
-
string
The id of the firmware.
- options
- FirmwareGetOptionalParams
The options parameters.
Returns
Promise<Firmware>
listByWorkspace(string, string, FirmwareListByWorkspaceOptionalParams)
Lists all of firmwares inside a workspace.
function listByWorkspace(resourceGroupName: string, workspaceName: string, options?: FirmwareListByWorkspaceOptionalParams): PagedAsyncIterableIterator<Firmware, Firmware[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
The options parameters.
Returns
listGenerateBinaryHardeningList(string, string, string, FirmwareListGenerateBinaryHardeningListOptionalParams)
The operation to list all binary hardening result for a firmware.
function listGenerateBinaryHardeningList(resourceGroupName: string, workspaceName: string, firmwareId: string, options?: FirmwareListGenerateBinaryHardeningListOptionalParams): PagedAsyncIterableIterator<BinaryHardening, BinaryHardening[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
- firmwareId
-
string
The id of the firmware.
The options parameters.
Returns
listGenerateComponentList(string, string, string, FirmwareListGenerateComponentListOptionalParams)
The operation to list all components result for a firmware.
function listGenerateComponentList(resourceGroupName: string, workspaceName: string, firmwareId: string, options?: FirmwareListGenerateComponentListOptionalParams): PagedAsyncIterableIterator<Component, Component[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
- firmwareId
-
string
The id of the firmware.
The options parameters.
Returns
listGenerateCryptoCertificateList(string, string, string, FirmwareListGenerateCryptoCertificateListOptionalParams)
The operation to list all crypto certificates for a firmware.
function listGenerateCryptoCertificateList(resourceGroupName: string, workspaceName: string, firmwareId: string, options?: FirmwareListGenerateCryptoCertificateListOptionalParams): PagedAsyncIterableIterator<CryptoCertificate, CryptoCertificate[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
- firmwareId
-
string
The id of the firmware.
The options parameters.
Returns
listGenerateCryptoKeyList(string, string, string, FirmwareListGenerateCryptoKeyListOptionalParams)
The operation to list all crypto keys for a firmware.
function listGenerateCryptoKeyList(resourceGroupName: string, workspaceName: string, firmwareId: string, options?: FirmwareListGenerateCryptoKeyListOptionalParams): PagedAsyncIterableIterator<CryptoKey_2, CryptoKey_2[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
- firmwareId
-
string
The id of the firmware.
The options parameters.
Returns
listGenerateCveList(string, string, string, FirmwareListGenerateCveListOptionalParams)
The operation to list all cve results for a firmware.
function listGenerateCveList(resourceGroupName: string, workspaceName: string, firmwareId: string, options?: FirmwareListGenerateCveListOptionalParams): PagedAsyncIterableIterator<Cve, Cve[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
- firmwareId
-
string
The id of the firmware.
The options parameters.
Returns
listGeneratePasswordHashList(string, string, string, FirmwareListGeneratePasswordHashListOptionalParams)
The operation to list all password hashes for a firmware.
function listGeneratePasswordHashList(resourceGroupName: string, workspaceName: string, firmwareId: string, options?: FirmwareListGeneratePasswordHashListOptionalParams): PagedAsyncIterableIterator<PasswordHash, PasswordHash[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
- firmwareId
-
string
The id of the firmware.
The options parameters.
Returns
update(string, string, string, FirmwareUpdateDefinition, FirmwareUpdateOptionalParams)
The operation to update firmware.
function update(resourceGroupName: string, workspaceName: string, firmwareId: string, firmware: FirmwareUpdateDefinition, options?: FirmwareUpdateOptionalParams): Promise<Firmware>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the firmware analysis workspace.
- firmwareId
-
string
The id of the firmware.
- firmware
- FirmwareUpdateDefinition
Details of the firmware being created or updated.
- options
- FirmwareUpdateOptionalParams
The options parameters.
Returns
Promise<Firmware>
