Iot Dps Resource - List Keys

Hizmet:

IoT Hub Device Provisioning Service

API Sürümü:

2022-12-12

Sağlama hizmeti için güvenlik meta verilerini alın.
Sağlama hizmeti için birincil ve ikincil anahtarları listeleme.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
provisioningServiceName	path	True	string	Paylaşılan erişim anahtarlarını almak için sağlanan hizmet adı.
resourceGroupName	path	True	string	kaynak grubu adı
subscriptionId	path	True	string	Abonelik tanımlayıcısı.
api-version	query	True	string	API'nin sürümü.

Yanıtlar

Name	Tür	Description
200 OK	SharedAccessSignatureAuthorizationRuleListResult	Bu zaman uyumlu bir işlemdir. Gövde, sağlama hizmeti uç noktalarına erişmek için kullanabileceğiniz anahtarlar da dahil olmak üzere JSON serileştirilmiş bir paylaşılan erişim ilkeleri dizisi içerir.
Other Status Codes	ErrorDetails	Varsayılan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

DPSListKeys

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:

200

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

Tanımlar

Name	Description
AccessRightsDescription	Bu anahtarın sahip olduğu haklar.
ErrorDetails	Hata ayrıntıları.
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Paylaşılan erişim anahtarının açıklaması.
SharedAccessSignatureAuthorizationRuleListResult	Paylaşılan erişim anahtarlarının listesi.

AccessRightsDescription

Listeleme

Bu anahtarın sahip olduğu haklar.

Değer	Description
ServiceConfig
EnrollmentRead
EnrollmentWrite
DeviceConnect
RegistrationStatusRead
RegistrationStatusWrite

ErrorDetails

Object

Hata ayrıntıları.

Name	Tür	Description
code	integer (int32)	Hata kodu.
details	string	Hata ayrıntıları.
httpStatusCode	string	HTTP durum kodu.
message	string	Hata iletisi.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Object

Paylaşılan erişim anahtarının açıklaması.

Name	Tür	Description
keyName	string	Anahtarın adı.
primaryKey	string	Birincil SAS anahtar değeri.
rights	AccessRightsDescription	Bu anahtarın sahip olduğu haklar.
secondaryKey	string	İkincil SAS anahtar değeri.

SharedAccessSignatureAuthorizationRuleListResult

Object

Paylaşılan erişim anahtarlarının listesi.

Name	Tür	Description
nextLink	string	Sonraki bağlantı.
value	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	Paylaşılan erişim ilkelerinin listesi.