Iot Dps Resource - List Keys

Referens

Service:: IoT Hub Device Provisioning Service

API Version:: 2018-01-22

Hämta säkerhetsmetadata för en etableringstjänst.
Ange de primära och sekundära nycklarna för en etableringstjänst.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
provisioningServiceName	path	True	string	Namnet på etableringstjänsten som de delade åtkomstnycklarna ska hämtas för.
resourceGroupName	path	True	string	resursgruppsnamn
subscriptionId	path	True	string	Prenumerationsidentifieraren.
api-version	query	True	string	Versionen av API:et.

Svar

Name	Typ	Description
200 OK	SharedAccessSignatureAuthorizationRuleListResult	Det här är en synkron åtgärd. Brödtexten innehåller en JSON-serialiserad matris med principer för delad åtkomst, inklusive nycklar, som du kan använda för att komma åt tjänstslutpunkterna för etablering.
Other Status Codes	ErrorDetails	Standardfelsvar.

Säkerhet

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	personifiera ditt användarkonto

Exempel

DPSListKeys

Sample Request

HTTP

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

Status code:: 200

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

Definitioner

Name	Description
AccessRightsDescription	Rättigheter som nyckeln har.
ErrorDetails	Felinformation.
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Beskrivning av den delade åtkomstnyckeln.
SharedAccessSignatureAuthorizationRuleListResult	Lista över delade åtkomstnycklar.

AccessRightsDescription

Rättigheter som nyckeln har.

Name	Typ	Description
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

ErrorDetails

Felinformation.

Name	Typ	Description
code	string	Felkoden.
details	string	Felinformationen.
httpStatusCode	string	HTTP-statuskoden.
message	string	Felmeddelandet.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Beskrivning av den delade åtkomstnyckeln.

Name	Typ	Description
keyName	string	Namnet på nyckeln.
primaryKey	string	Primärt SAS-nyckelvärde.
rights	AccessRightsDescription	Rättigheter som nyckeln har.
secondaryKey	string	Sekundärt SAS-nyckelvärde.

SharedAccessSignatureAuthorizationRuleListResult

Lista över delade åtkomstnycklar.

Name	Typ	Description
nextLink	string	Nästa länk.
value	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	Listan över principer för delad åtkomst.