Microsoft.IoTFirmwareDefense (preview:2025-04-01)

2025/03/24 • 23 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.IoTFirmwareDefense/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_ListBySubscription (new)
Description :  Lists all of the firmware analysis workspaces in the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.IoTFirmwareDefense/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Workspace items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_ListByResourceGroup (new)
Description :  Lists all of the firmware analysis workspaces in the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Workspace items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_Get (new)
Description :  Get firmware analysis workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_Create (new)
Description :  The operation to create or update a firmware analysis workspace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
resource:
{
Description: Parameters when creating a firmware analysis workspace. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_Update (new)
Description :  The operation to update a firmware analysis workspaces.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
properties:
{
Description: Parameters when updating a firmware analysis workspace. ,
Required: True ,
}
{
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: False ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_Delete (new)
Description :  The operation to delete a firmware analysis workspace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Firmwares_ListByWorkspace (new)
Description :  Lists all of firmwares inside a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Firmware items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
fileName:
{
Description: File name for a firmware that user uploaded. ,
Required: False ,
}
string ,
vendor:
{
Description: Firmware vendor. ,
Required: False ,
}
string ,
model:
{
Description: Firmware model. ,
Required: False ,
}
string ,
version:
{
Description: Firmware version. ,
Required: False ,
}
string ,
description:
{
Description: User-specified description of the firmware. ,
Required: False ,
}
string ,
fileSize:
{
Description: File size of the uploaded firmware image. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of firmware scan. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
statusMessages:
{
Description: A list of errors or other messages generated during firmware analysis ,
Required: False ,
}
[
{
errorCode:
{
Description: The error code ,
Format: int64 ,
Required: False ,
}
integer ,
message:
{
Description: The error or status message ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Firmwares_Get (new)
Description :  Get firmware.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
firmwareId:
{
Description: The id of the firmware. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
fileName:
{
Description: File name for a firmware that user uploaded. ,
Required: False ,
}
string ,
vendor:
{
Description: Firmware vendor. ,
Required: False ,
}
string ,
model:
{
Description: Firmware model. ,
Required: False ,
}
string ,
version:
{
Description: Firmware version. ,
Required: False ,
}
string ,
description:
{
Description: User-specified description of the firmware. ,
Required: False ,
}
string ,
fileSize:
{
Description: File size of the uploaded firmware image. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of firmware scan. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
statusMessages:
{
Description: A list of errors or other messages generated during firmware analysis ,
Required: False ,
}
[
{
errorCode:
{
Description: The error code ,
Format: int64 ,
Required: False ,
}
integer ,
message:
{
Description: The error or status message ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Firmwares_Create (new)
Description :  The operation to create a firmware.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
firmwareId:
{
Description: The id of the firmware. ,
Required: True ,
}
string ,
resource:
{
Description: Details of the firmware being created or updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
fileName:
{
Description: File name for a firmware that user uploaded. ,
Required: False ,
}
string ,
vendor:
{
Description: Firmware vendor. ,
Required: False ,
}
string ,
model:
{
Description: Firmware model. ,
Required: False ,
}
string ,
version:
{
Description: Firmware version. ,
Required: False ,
}
string ,
description:
{
Description: User-specified description of the firmware. ,
Required: False ,
}
string ,
fileSize:
{
Description: File size of the uploaded firmware image. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of firmware scan. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
statusMessages:
{
Description: A list of errors or other messages generated during firmware analysis ,
Required: False ,
}
[
{
errorCode:
{
Description: The error code ,
Format: int64 ,
Required: False ,
}
integer ,
message:
{
Description: The error or status message ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
fileName:
{
Description: File name for a firmware that user uploaded. ,
Required: False ,
}
string ,
vendor:
{
Description: Firmware vendor. ,
Required: False ,
}
string ,
model:
{
Description: Firmware model. ,
Required: False ,
}
string ,
version:
{
Description: Firmware version. ,
Required: False ,
}
string ,
description:
{
Description: User-specified description of the firmware. ,
Required: False ,
}
string ,
fileSize:
{
Description: File size of the uploaded firmware image. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of firmware scan. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
statusMessages:
{
Description: A list of errors or other messages generated during firmware analysis ,
Required: False ,
}
[
{
errorCode:
{
Description: The error code ,
Format: int64 ,
Required: False ,
}
integer ,
message:
{
Description: The error or status message ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
fileName:
{
Description: File name for a firmware that user uploaded. ,
Required: False ,
}
string ,
vendor:
{
Description: Firmware vendor. ,
Required: False ,
}
string ,
model:
{
Description: Firmware model. ,
Required: False ,
}
string ,
version:
{
Description: Firmware version. ,
Required: False ,
}
string ,
description:
{
Description: User-specified description of the firmware. ,
Required: False ,
}
string ,
fileSize:
{
Description: File size of the uploaded firmware image. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of firmware scan. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
statusMessages:
{
Description: A list of errors or other messages generated during firmware analysis ,
Required: False ,
}
[
{
errorCode:
{
Description: The error code ,
Format: int64 ,
Required: False ,
}
integer ,
message:
{
Description: The error or status message ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Firmwares_Update (new)
Description :  The operation to update firmware.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
firmwareId:
{
Description: The id of the firmware. ,
Required: True ,
}
string ,
properties:
{
Description: Details of the firmware being created or updated. ,
Required: True ,
}
{
properties:
{
Description: The editable properties of a firmware ,
Required: False ,
}
{
fileName:
{
Description: File name for a firmware that user uploaded. ,
Required: False ,
}
string ,
vendor:
{
Description: Firmware vendor. ,
Required: False ,
}
string ,
model:
{
Description: Firmware model. ,
Required: False ,
}
string ,
version:
{
Description: Firmware version. ,
Required: False ,
}
string ,
description:
{
Description: User-specified description of the firmware. ,
Required: False ,
}
string ,
fileSize:
{
Description: File size of the uploaded firmware image. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of firmware scan. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
statusMessages:
{
Description: A list of errors or other messages generated during firmware analysis ,
Required: False ,
}
[
{
errorCode:
{
Description: The error code ,
Format: int64 ,
Required: False ,
}
integer ,
message:
{
Description: The error or status message ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
fileName:
{
Description: File name for a firmware that user uploaded. ,
Required: False ,
}
string ,
vendor:
{
Description: Firmware vendor. ,
Required: False ,
}
string ,
model:
{
Description: Firmware model. ,
Required: False ,
}
string ,
version:
{
Description: Firmware version. ,
Required: False ,
}
string ,
description:
{
Description: User-specified description of the firmware. ,
Required: False ,
}
string ,
fileSize:
{
Description: File size of the uploaded firmware image. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of firmware scan. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
statusMessages:
{
Description: A list of errors or other messages generated during firmware analysis ,
Required: False ,
}
[
{
errorCode:
{
Description: The error code ,
Format: int64 ,
Required: False ,
}
integer ,
message:
{
Description: The error or status message ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Firmwares_Delete (new)
Description :  The operation to delete a firmware.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
firmwareId:
{
Description: The id of the firmware. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BinaryHardening_ListByFirmware (new)
Description :  Lists binary hardening analysis results of a firmware.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/binaryHardeningResults
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
firmwareId:
{
Description: The id of the firmware. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The BinaryHardeningResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
binaryHardeningId:
{
Description: ID for the binary hardening result. ,
Required: False ,
}
string ,
securityHardeningFeatures:
{
Description: The security hardening features of the binary. ,
Required: False ,
}
{
noExecute:
{
Description: Flag indicating the binary's stack is set to NX (no-execute). ,
Required: False ,
}
boolean ,
positionIndependentExecutable:
{
Description: Flag indicating the binary was compiled to be a position independent executable. ,
Required: False ,
}
boolean ,
relocationReadOnly:
{
Description: Flag indicating the binary has enabled relocation read-only protections. ,
Required: False ,
}
boolean ,
canary:
{
Description: Flag indicating if the binary was compiled with stack canaries enabled. ,
Required: False ,
}
boolean ,
stripped:
{
Description: Flag indicating if debug symbols have been stripped from the binary. ,
Required: False ,
}
boolean ,
}
,
executableArchitecture:
{
Description: The architecture of the binary being reported on. ,
Required: False ,
}
string ,
filePath:
{
Description: The path to the binary in the firmware. ,
Required: False ,
}
string ,
executableClass:
{
Description: The executable class to indicate 32 or 64 bit. ,
Enum:
{
x86: The binary is 32-bit. ,
x64: The binary is 64-bit. ,
}
,
Required: False ,
}
enum ,
runpath:
{
Description: The runpath property of the uploaded binary, which is a method of specifying additional paths to load objects at runtime. ,
Required: False ,
}
string ,
rpath:
{
Description: The rpath property of the uploaded binary, which is a deprecated method of specifying additional paths to load objects at runtime. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Cves_ListByFirmware (new)
Description :  Lists CVE analysis results of a firmware.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/commonVulnerabilitiesAndExposures
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
firmwareId:
{
Description: The id of the firmware. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The CveResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
cveId:
{
Description: ID of the CVE result. ,
Required: False ,
}
string ,
componentId:
{
Description: ID of the affected SBOM component. ,
Required: False ,
}
string ,
componentName:
{
Description: Name of the affected SBOM component. ,
Required: False ,
}
string ,
componentVersion:
{
Description: Version of the affected SBOM component. ,
Required: False ,
}
string ,
severity:
{
Description: Severity of the CVE. ,
Required: False ,
}
string ,
cveName:
{
Description: Name of the CVE. ,
Required: False ,
}
string ,
effectiveCvssScore:
{
Description: The most recent CVSS score of the CVE. ,
Format: float ,
Required: False ,
}
number ,
effectiveCvssVersion:
{
Description: The version of the effectiveCvssScore property. ,
Format: int32 ,
Required: False ,
}
integer ,
cvssScores:
{
Description: All known CVSS scores for the CVE. ,
Required: False ,
}
[
{
version:
{
Description: The version of the Common Vulnerability Scoring System (CVSS). ,
Format: int32 ,
Required: True ,
}
integer ,
score:
{
Description: The score of the CVE according to the CVSS specified. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
links:
{
Description: The list of reference links for the CVE. ,
Required: False ,
}
[
{
href:
{
Description: The destination of the reference link. ,
Format: uri ,
Required: False ,
}
string ,
label:
{
Description: The label of the reference link. ,
Required: False ,
}
string ,
}
,
]
,
description:
{
Description: The CVE description. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CryptoCertificates_ListByFirmware (new)
Description :  Lists crypto certificate analysis results of a firmware.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/cryptoCertificates
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
firmwareId:
{
Description: The id of the firmware. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The CryptoCertificateResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
cryptoCertId:
{
Description: ID for the certificate result. ,
Required: False ,
}
string ,
certificateName:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
subject:
{
Description: Subject information of the certificate. ,
Required: False ,
}
{
commonName:
{
Description: Common name of the certificate entity. ,
Required: False ,
}
string ,
organization:
{
Description: Organization of the certificate entity. ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The organizational unit of the certificate entity. ,
Required: False ,
}
string ,
state:
{
Description: Geographical state or province of the certificate entity. ,
Required: False ,
}
string ,
country:
{
Description: Country code of the certificate entity. ,
Required: False ,
}
string ,
}
,
issuer:
{
Description: Issuer information of the certificate. ,
Required: False ,
}
{
commonName:
{
Description: Common name of the certificate entity. ,
Required: False ,
}
string ,
organization:
{
Description: Organization of the certificate entity. ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The organizational unit of the certificate entity. ,
Required: False ,
}
string ,
state:
{
Description: Geographical state or province of the certificate entity. ,
Required: False ,
}
string ,
country:
{
Description: Country code of the certificate entity. ,
Required: False ,
}
string ,
}
,
issuedDate:
{
Description: Issue date for the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date for the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
certificateRole:
{
Description: Role of the certificate (Root CA, etc) ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: The signature algorithm used in the certificate. ,
Required: False ,
}
string ,
certificateKeySize:
{
Description: Size of the certificate's key in bits ,
Format: int64 ,
Required: False ,
}
integer ,
certificateKeyAlgorithm:
{
Description: Key algorithm used in the certificate. ,
Required: False ,
}
string ,
encoding:
{
Description: Encoding used for the certificate. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial number of the certificate. ,
Required: False ,
}
string ,
fingerprint:
{
Description: Fingerprint of the certificate. ,
Required: False ,
}
string ,
certificateUsage:
{
Description: List of functions the certificate can fulfill. ,
Required: False ,
}
[
string ,
]
,
filePaths:
{
Description: List of files where this certificate was found. ,
Required: False ,
}
[
string ,
]
,
pairedKey:
{
Description: A matching paired private key. ,
Required: False ,
}
{
pairedKeyId:
{
Description: ID of the paired key or certificate. ,
Required: False ,
}
string ,
type:
{
Description: The type indicating whether the paired object is a key or certificate. ,
Required: False ,
}
string ,
}
,
isExpired:
{
Description: Indicates if the certificate is expired. ,
Required: False ,
}
boolean ,
isSelfSigned:
{
Description: Indicates if the certificate is self-signed. ,
Required: False ,
}
boolean ,
isWeakSignature:
{
Description: Indicates the signature algorithm used is insecure according to NIST guidance. ,
Required: False ,
}
boolean ,
isShortKeySize:
{
Description: Indicates the certificate's key size is considered too small to be secure for the key algorithm according to NIST guidance. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CryptoKeys_ListByFirmware (new)
Description :  Lists crypto key analysis results of a firmware.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/cryptoKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
firmwareId:
{
Description: The id of the firmware. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The CryptoKeyResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
cryptoKeyId:
{
Description: ID for the key result. ,
Required: False ,
}
string ,
keyType:
{
Description: Type of the key (public or private). ,
Enum:
{
Public: The key is an asymmetric public key. ,
Private: The key is an asymmetric private key. ,
}
,
Required: False ,
}
enum ,
cryptoKeySize:
{
Description: Size of the key in bits. ,
Format: int64 ,
Required: False ,
}
integer ,
keyAlgorithm:
{
Description: Key algorithm name. ,
Required: False ,
}
string ,
usage:
{
Description: Functions the key can fulfill. ,
Required: False ,
}
[
string ,
]
,
filePaths:
{
Description: List of files where this key was found. ,
Required: False ,
}
[
string ,
]
,
pairedKey:
{
Description: A matching paired key or certificate. ,
Required: False ,
}
{
pairedKeyId:
{
Description: ID of the paired key or certificate. ,
Required: False ,
}
string ,
type:
{
Description: The type indicating whether the paired object is a key or certificate. ,
Required: False ,
}
string ,
}
,
isShortKeySize:
{
Description: Indicates the key size is considered too small to be secure for the algorithm according to NIST guidance. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PasswordHashes_ListByFirmware (new)
Description :  Lists password hash analysis results of a firmware.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/passwordHashes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
firmwareId:
{
Description: The id of the firmware. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PasswordHashResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
passwordHashId:
{
Description: ID for password hash ,
Required: False ,
}
string ,
filePath:
{
Description: File path of the password hash ,
Required: False ,
}
string ,
salt:
{
Description: Salt of the password hash ,
Required: False ,
}
string ,
hash:
{
Description: Hash of the password ,
Required: False ,
}
string ,
context:
{
Description: Context of password hash ,
Required: False ,
}
string ,
username:
{
Description: User name of password hash ,
Required: False ,
}
string ,
algorithm:
{
Description: Algorithm of the password hash ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SbomComponents_ListByFirmware (new)
Description :  Lists sbom analysis results of a firmware.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/sbomComponents
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
firmwareId:
{
Description: The id of the firmware. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SbomComponentResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
componentId:
{
Description: ID for the component. ,
Required: False ,
}
string ,
componentName:
{
Description: Name for the component. ,
Required: False ,
}
string ,
version:
{
Description: Version for the component. ,
Required: False ,
}
string ,
license:
{
Description: License for the component. ,
Required: False ,
}
string ,
filePaths:
{
Description: File paths related to the component. Note, relatedFiles should be used instead of this property. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Summaries_ListByFirmware (new)
Description :  Lists analysis result summary names of a firmware. To fetch the full summary data, get that summary by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/summaries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
firmwareId:
{
Description: The id of the firmware. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SummaryResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
summaryType:
{
Description: The type of summary. ,
Enum:
{
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 ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Summaries_Get (new)
Description :  Get an analysis result summary of a firmware by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/summaries/{summaryType}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
firmwareId:
{
Description: The id of the firmware. ,
Required: True ,
}
string ,
summaryType:
{
Description: The Firmware analysis summary name describing the type of summary. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
summaryType:
{
Description: The type of summary. ,
Enum:
{
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 ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_GenerateUploadUrl (new)
Description :  Generate a URL for uploading a firmware image.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/generateUploadUrl
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
body:
{
Description: Parameters when requesting a URL to upload firmware. ,
Required: True ,
}
{
firmwareId:
{
Description: A unique ID for the firmware to be uploaded. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
url:
{
Description: SAS URL for creating or accessing a blob file. ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UsageMetrics_ListByWorkspace (new)
Description :  Lists monthly usage information for a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/usageMetrics
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The UsageMetric items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
monthlyFirmwareUploadCount:
{
Description: The number of firmware analysis jobs that have been submitted in the current month. ,
Format: int64 ,
Required: True ,
}
integer ,
totalFirmwareCount:
{
Description: The total number of firmwares that are in the workspace. ,
Format: int64 ,
Required: True ,
}
integer ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UsageMetrics_Get (new)
Description :  Gets monthly usage information for a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/usageMetrics/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the firmware analysis workspace. ,
Required: True ,
}
string ,
name:
{
Description: The Firmware analysis summary name describing the type of summary. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
monthlyFirmwareUploadCount:
{
Description: The number of firmware analysis jobs that have been submitted in the current month. ,
Format: int64 ,
Required: True ,
}
integer ,
totalFirmwareCount:
{
Description: The total number of firmwares that are in the workspace. ,
Format: int64 ,
Required: True ,
}
integer ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}