{ "swagger": "2.0", "info": { "version": "2024-01-10", "title": "IoT Firmware Defense", "description": "Firmware & IoT Security REST API" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.IoTFirmwareDefense/workspaces": { "get": { "tags": [ "Workspaces" ], "operationId": "Workspaces_ListBySubscription", "description": "Lists all of the firmware analysis workspaces in the specified subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkspaceList" } }, "default": { "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "Workspaces_ListBySubscription_MaximumSet_Gen": { "$ref": "./examples/Workspaces_ListBySubscription_MaximumSet_Gen.json" }, "Workspaces_ListBySubscription_MinimumSet_Gen": { "$ref": "./examples/Workspaces_ListBySubscription_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces": { "get": { "tags": [ "Workspaces" ], "operationId": "Workspaces_ListByResourceGroup", "description": "Lists all of the firmware analysis workspaces in the specified resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkspaceList" } }, "default": { "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "Workspaces_ListByResourceGroup_MaximumSet_Gen": { "$ref": "./examples/Workspaces_ListByResourceGroup_MaximumSet_Gen.json" }, "Workspaces_ListByResourceGroup_MinimumSet_Gen": { "$ref": "./examples/Workspaces_ListByResourceGroup_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}": { "put": { "tags": [ "Workspaces" ], "operationId": "Workspaces_Create", "description": "The operation to create or update a firmware analysis workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common.json#/parameters/WorkspaceNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/WorkspaceCreateBodyParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Workspace" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/Workspace" } }, "default": { "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Workspaces_Create_MaximumSet_Gen": { "$ref": "./examples/Workspaces_Create_MaximumSet_Gen.json" }, "Workspaces_Create_MinimumSet_Gen": { "$ref": "./examples/Workspaces_Create_MinimumSet_Gen.json" } } }, "patch": { "tags": [ "Workspaces" ], "operationId": "Workspaces_Update", "description": "The operation to update a firmware analysis workspaces.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common.json#/parameters/WorkspaceNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/WorkspaceUpdateBodyParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Workspace" } }, "default": { "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Workspaces_Update_MaximumSet_Gen": { "$ref": "./examples/Workspaces_Update_MaximumSet_Gen.json" }, "Workspaces_Update_MinimumSet_Gen": { "$ref": "./examples/Workspaces_Update_MinimumSet_Gen.json" } } }, "delete": { "tags": [ "Workspaces" ], "operationId": "Workspaces_Delete", "description": "The operation to delete a firmware analysis workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common.json#/parameters/WorkspaceNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "default": { "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Workspaces_Delete_MaximumSet_Gen": { "$ref": "./examples/Workspaces_Delete_MaximumSet_Gen.json" }, "Workspaces_Delete_MinimumSet_Gen": { "$ref": "./examples/Workspaces_Delete_MinimumSet_Gen.json" } } }, "get": { "tags": [ "Workspaces" ], "operationId": "Workspaces_Get", "description": "Get firmware analysis workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common.json#/parameters/WorkspaceNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Workspace" } }, "default": { "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Workspaces_Get_MaximumSet_Gen": { "$ref": "./examples/Workspaces_Get_MaximumSet_Gen.json" }, "Workspaces_Get_MinimumSet_Gen": { "$ref": "./examples/Workspaces_Get_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/generateUploadUrl": { "post": { "tags": [ "Workspaces" ], "operationId": "Workspaces_GenerateUploadUrl", "description": "The operation to get a url for file upload.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common.json#/parameters/WorkspaceNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/GenerateUploadUrlBodyParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./common.json#/definitions/UrlToken" } }, "default": { "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Workspaces_GenerateUploadUrl_MaximumSet_Gen": { "$ref": "./examples/Workspaces_GenerateUploadUrl_MaximumSet_Gen.json" }, "Workspaces_GenerateUploadUrl_MinimumSet_Gen": { "$ref": "./examples/Workspaces_GenerateUploadUrl_MinimumSet_Gen.json" } } } } }, "definitions": { "WorkspaceProperties": { "type": "object", "properties": { "provisioningState": { "description": "Provisioning state of the resource.", "type": "string", "enum": [ "Accepted", "Succeeded", "Canceled", "Failed" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true }, "readOnly": true } }, "description": "Workspace properties." }, "Workspace": { "type": "object", "description": "Firmware analysis workspace.", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/WorkspaceProperties" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "WorkspaceUpdateDefinition": { "type": "object", "description": "Firmware analysis workspace.", "properties": { "properties": { "description": "The editable workspace properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/WorkspaceProperties" } } }, "WorkspaceList": { "type": "object", "description": "Return a list of firmware analysis workspaces.", "properties": { "value": { "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/Workspace" }, "description": "The list of firmware analysis workspaces." }, "nextLink": { "type": "string", "description": "The uri to fetch the next page of asset." } } }, "GenerateUploadUrlRequest": { "type": "object", "description": "Properties for generating an upload URL", "properties": { "firmwareId": { "type": "string", "description": "A unique ID for the firmware to be uploaded." } } } }, "parameters": { "WorkspaceCreateBodyParameter": { "name": "workspace", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Workspace" }, "description": "Parameters when creating a firmware analysis workspace.", "x-ms-parameter-location": "method" }, "WorkspaceUpdateBodyParameter": { "name": "workspace", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WorkspaceUpdateDefinition" }, "description": "Parameters when updating a firmware analysis workspace.", "x-ms-parameter-location": "method" }, "GenerateUploadUrlBodyParameter": { "name": "generateUploadUrl", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GenerateUploadUrlRequest" }, "description": "Parameters when requesting a URL to upload firmware.", "x-ms-parameter-location": "method" } } }