Iot Dps Resource - List Keys

Get the security metadata for a provisioning service.
List the primary and secondary keys for a provisioning service.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/listkeys?api-version=2018-01-22

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription identifier.

resourceGroupName
path True
  • string

resource group name

provisioningServiceName
path True
  • string

The provisioning service name to get the shared access keys for.

api-version
query True
  • string

The version of the API.

Responses

Name Type Description
200 OK

This is a synchronous operation. The body contains a JSON-serialized array of shared access policies, including keys, that you can use to access the provisioning service endpoints.

Other Status Codes

Default error response.

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

DPSListKeys

Sample Request

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService/listkeys?api-version=2018-01-22

Sample Response

{
  "value": [
    {
      "keyName": "key1",
      "primaryKey": "#####################################",
      "secondaryKey": "###################################",
      "rights": "ServiceConfig"
    },
    {
      "keyName": "key2",
      "primaryKey": "#######################################",
      "secondaryKey": "####################################=",
      "rights": "ServiceConfig"
    }
  ]
}

Definitions

AccessRightsDescription

Rights that this key has.

ErrorDetails

Error details.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Description of the shared access key.

SharedAccessSignatureAuthorizationRuleListResult

List of shared access keys.

AccessRightsDescription

Rights that this key has.

Name Type Description
DeviceConnect
  • string
EnrollmentRead
  • string
EnrollmentWrite
  • string
RegistrationStatusRead
  • string
RegistrationStatusWrite
  • string
ServiceConfig
  • string

ErrorDetails

Error details.

Name Type Description
code
  • string

The error code.

details
  • string

The error details.

httpStatusCode
  • string

The HTTP status code.

message
  • string

The error message.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Description of the shared access key.

Name Type Description
keyName
  • string

Name of the key.

primaryKey
  • string

Primary SAS key value.

rights

Rights that this key has.

secondaryKey
  • string

Secondary SAS key value.

SharedAccessSignatureAuthorizationRuleListResult

List of shared access keys.

Name Type Description
nextLink
  • string

The next link.

value

The list of shared access policies.