Bit Locker Keys - List

Returns the BitLocker Keys for all drives in the specified job.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}/listBitLockerKeys?api-version=2016-11-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription ID for the Azure user.

resourceGroupName
path True
  • string

The resource group name uniquely identifies the resource group within the user subscription.

jobName
path True
  • string

The name of the import/export job.

api-version
query True
  • string

Specifies the API version to use for this request.

Request Header

Name Required Type Description
Accept-Language
  • string

Specifies the preferred language for the response.

Responses

Name Type Description
200 OK

OK

Other Status Codes

An error occurs.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

List BitLocker Keys for drives in a job

Sample Request

POST https://management.azure.com/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ImportExport/jobs/test-by1-import/listBitLockerKeys?api-version=2016-11-01

Sample Response

{
  "value": [
    {
      "driveId": "9CA995BB",
      "bitLockerKey": "000000-000000-111111-222222-333333-444444-555555-666666"
    }
  ]
}

Definitions

Details

Describes the error details if present.

DriveBitLockerKey

BitLocker recovery key or password to the specified drive

ErrorResponse

Response when errors occurred

GetBitLockerKeysResponse

GetBitLockerKeys response

Details

Describes the error details if present.

Name Type Description
code
  • string

Provides information about the error code.

message
  • string

Provides information about the error message.

target
  • string

Provides information about the error target.

DriveBitLockerKey

BitLocker recovery key or password to the specified drive

Name Type Description
bitLockerKey
  • string

BitLocker recovery key or password

driveId
  • string

Drive ID

ErrorResponse

Response when errors occurred

Name Type Description
error.code
  • string

Provides information about the error code.

error.details

Describes the error details if present.

error.innererror
  • object

Inner error object if present.

error.message
  • string

Provides information about the error message.

error.target
  • string

Provides information about the error target.

GetBitLockerKeysResponse

GetBitLockerKeys response

Name Type Description
value

drive status