Iot Dps Resource - Get

Odwołanie

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Pobierz metadane związane z zabezpieczeniami usługi aprowizacji.
Pobierz metadane usługi aprowizacji bez kluczy SAS.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
provisioningServiceName	path	True	string	Nazwa usługi aprowizacji do pobrania.
resourceGroupName	path	True	string	Nazwa grupy zasobów.
subscriptionId	path	True	string	Identyfikator subskrypcji.
api-version	query	True	string	Wersja interfejsu API.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ProvisioningServiceDescription	Opis usługi aprowizacji bez kluczy nie jest uwzględniany w odpowiedzi.
Other Status Codes	ErrorDetails	Domyślna odpowiedź na błąd

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

DPSGet

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "etag": "AAAAAAAADGk=",
  "name": "myFirstProvisioningService",
  "location": "eastus",
  "properties": {
    "state": "Active",
    "allocationPolicy": "Hashed",
    "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
    "deviceProvisioningHostName": "global.azure-devices-provisioning.net",
    "idScope": "0ne00000012",
    "authorizationPolicies": [],
    "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
  },
  "resourcegroup": "myResourceGroup",
  "type": "Microsoft.Devices/ProvisioningServices",
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
  "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
  "tags": {},
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

Definicje

Nazwa	Opis
AccessRightsDescription	Prawa, które ma ten klucz.
AllocationPolicy	Zasady alokacji, które mają być używane przez tę usługę aprowizacji.
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorDetails	Szczegóły błędu.
IotDpsPropertiesDescription	właściwości specyficzne dla usługi aprowizacji, w tym klucze, połączone centra iot, bieżący stan i system wygenerowane właściwości, takie jak nazwa hosta i idScope
IotDpsSku	Nazwa jednostki SKU.
IotDpsSkuInfo	Lista możliwych jednostek SKU usługi aprowizacji.
IotHubDefinitionDescription	Opis centrum IoT.
IpFilterActionType	Żądana akcja żądań przechwyconych przez tę regułę.
IpFilterRule	Reguły filtrowania adresów IP dla usługi aprowizacji.
IpFilterTargetType	Element docelowy dla żądań przechwyconych przez tę regułę.
PrivateEndpoint	Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego
PrivateEndpointConnection	Połączenie prywatnego punktu końcowego usługi aprowizacji
PrivateEndpointConnectionProperties	Właściwości połączenia prywatnego punktu końcowego
PrivateLinkServiceConnectionState	Bieżący stan połączenia prywatnego punktu końcowego
PrivateLinkServiceConnectionStatus	Stan połączenia prywatnego punktu końcowego
ProvisioningServiceDescription	Opis usługi aprowizacji.
PublicNetworkAccess	Czy żądania z sieci publicznej są dozwolone
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Opis klucza dostępu współdzielonego.
state	Bieżący stan usługi aprowizacji.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

AccessRightsDescription

Prawa, które ma ten klucz.

Nazwa	Typ	Opis
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

AllocationPolicy

Zasady alokacji, które mają być używane przez tę usługę aprowizacji.

Nazwa	Typ	Opis
GeoLatency	string
Hashed	string
Static	string

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDetails

Szczegóły błędu.

Nazwa	Typ	Opis
code	integer	Kod błędu.
details	string	Szczegóły błędu.
httpStatusCode	string	Kod stanu HTTP.
message	string	Komunikat o błędzie.

IotDpsPropertiesDescription

właściwości specyficzne dla usługi aprowizacji, w tym klucze, połączone centra iot, bieżący stan i system wygenerowane właściwości, takie jak nazwa hosta i idScope

Nazwa	Typ	Opis
allocationPolicy	AllocationPolicy	Zasady alokacji, które mają być używane przez tę usługę aprowizacji.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	Lista kluczy autoryzacji dla usługi aprowizacji.
deviceProvisioningHostName	string	Punkt końcowy urządzenia dla tej usługi aprowizacji.
enableDataResidency	boolean	Opcjonalny. Wskazuje, czy wystąpienie usługi DPS Data Residency włączone, usunięcie odzyskiwania po awarii między parami geograficznymi.
idScope	string	Unikatowy identyfikator tej usługi aprowizacji.
iotHubs	IotHubDefinitionDescription[]	Lista centrów IoT skojarzonych z tą usługą aprowizacji.
ipFilterRules	IpFilterRule[]	Reguły filtrowania adresów IP.
portalOperationsHostName	string	Punkt końcowy portalu umożliwiający włączenie mechanizmu CORS dla tej usługi aprowizacji.
privateEndpointConnections	PrivateEndpointConnection[]	Połączenia prywatnego punktu końcowego utworzone w tej usłudze IotHub
provisioningState	string	Stan aprowizacji usługi ARM dla usługi aprowizacji.
publicNetworkAccess	PublicNetworkAccess	Czy żądania z sieci publicznej są dozwolone
serviceOperationsHostName	string	Punkt końcowy usługi na potrzeby aprowizacji usługi.
state	state	Bieżący stan usługi aprowizacji.

IotDpsSku

Nazwa jednostki SKU.

Nazwa	Typ	Opis
S1	string

IotDpsSkuInfo

Lista możliwych jednostek SKU usługi aprowizacji.

Nazwa	Typ	Opis
capacity	integer	Liczba jednostek do aprowizacji
name	IotDpsSku	Nazwa jednostki SKU.
tier	string	Nazwa warstwy cenowej usługi aprowizacji.

IotHubDefinitionDescription

Opis centrum IoT.

Nazwa	Typ	Opis
allocationWeight	integer	wagi do ubiegania się o daną iot h.
applyAllocationPolicy	boolean	flaga stosowania właściwości allocationPolicy lub nie dla danego centrum iot.
connectionString	string	Parametry połączenia centrum IoT.
location	string	Region usługi ARM centrum IoT.
name	string	Nazwa hosta centrum IoT.

IpFilterActionType

Żądana akcja żądań przechwyconych przez tę regułę.

Nazwa	Typ	Opis
Accept	string
Reject	string

IpFilterRule

Reguły filtrowania adresów IP dla usługi aprowizacji.

Nazwa	Typ	Opis
action	IpFilterActionType	Żądana akcja żądań przechwyconych przez tę regułę.
filterName	string	Nazwa reguły filtrowania adresów IP.
ipMask	string	Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły.
target	IpFilterTargetType	Element docelowy dla żądań przechwyconych przez tę regułę.

IpFilterTargetType

Element docelowy dla żądań przechwyconych przez tę regułę.

Nazwa	Typ	Opis
all	string
deviceApi	string
serviceApi	string

PrivateEndpoint

Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.

PrivateEndpointConnection

Połączenie prywatnego punktu końcowego usługi aprowizacji

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties	PrivateEndpointConnectionProperties	Właściwości połączenia prywatnego punktu końcowego
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
type	string	Typ zasobu.

PrivateEndpointConnectionProperties

Właściwości połączenia prywatnego punktu końcowego

Nazwa	Typ	Opis
privateEndpoint	PrivateEndpoint	Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Bieżący stan połączenia prywatnego punktu końcowego

PrivateLinkServiceConnectionState

Bieżący stan połączenia prywatnego punktu końcowego

Nazwa	Typ	Opis
actionsRequired	string	Akcje wymagane dla połączenia prywatnego punktu końcowego
description	string	Opis bieżącego stanu połączenia prywatnego punktu końcowego
status	PrivateLinkServiceConnectionStatus	Stan połączenia prywatnego punktu końcowego

PrivateLinkServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego

Nazwa	Typ	Opis
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningServiceDescription

Opis usługi aprowizacji.

Nazwa	Typ	Opis
etag	string	Pole Etag nie jest wymagane. Jeśli jest on podany w treści odpowiedzi, musi być również podany jako nagłówek zgodnie z normalną konwencją ETag.
id	string	Identyfikator zasobu.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu.
properties	IotDpsPropertiesDescription	Właściwości specyficzne dla usługi aprowizacji
resourcegroup	string	Grupa zasobów zasobu.
sku	IotDpsSkuInfo	Informacje o jednostce SKU dla usługi aprowizacji.
subscriptionid	string	Identyfikator subskrypcji zasobu.
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
tags	object	Tagi zasobów.
type	string	Typ zasobu.

PublicNetworkAccess

Czy żądania z sieci publicznej są dozwolone

Nazwa	Typ	Opis
Disabled	string
Enabled	string

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Opis klucza dostępu współdzielonego.

Nazwa	Typ	Opis
keyName	string	Nazwa klucza.
primaryKey	string	Podstawowa wartość klucza sygnatury dostępu współdzielonego.
rights	AccessRightsDescription	Prawa, które ma ten klucz.
secondaryKey	string	Wartość pomocniczego klucza sygnatury dostępu współdzielonego.

state

Bieżący stan usługi aprowizacji.

Nazwa	Typ	Opis
Activating	string
ActivationFailed	string
Active	string
Deleted	string
Deleting	string
DeletionFailed	string
FailingOver	string
FailoverFailed	string
Resuming	string
Suspended	string
Suspending	string
Transitioning	string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.