Freigeben über


Iot Dps Resource - Get

Rufen Sie die nicht sicherheitsrelevanten Metadaten des Bereitstellungsdiensts ab.
Rufen Sie die Metadaten des Bereitstellungsdiensts ohne SAS-Schlüssel ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
provisioningServiceName
path True

string

Name des abzurufenden Bereitstellungsdiensts.

resourceGroupName
path True

string

Ressourcengruppenname.

subscriptionId
path True

string

Der Abonnementbezeichner.

api-version
query True

string

Die Version der API.

Antworten

Name Typ Beschreibung
200 OK

ProvisioningServiceDescription

Die Bereitstellungsdienstbeschreibung ohne Schlüssel ist in der Antwort enthalten.

Other Status Codes

ErrorDetails

Standardfehlerantwort

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

DPSGet

Beispielanforderung

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

Beispiel für eine Antwort

{
  "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
  }
}

Definitionen

Name Beschreibung
AccessRightsDescription

Rechte, die dieser Schlüssel hat.

AllocationPolicy

Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

ErrorDetails

Fehlerdetails.

IotDpsPropertiesDescription

die dienstspezifischen Eigenschaften eines Bereitstellungsdiensts, einschließlich Schlüsseln, verknüpften Iot-Hubs, aktueller Status und vom System generierte Eigenschaften wie Hostname und idScope

IotDpsSku

Sku-Name.

IotDpsSkuInfo

Liste der möglichen Bereitstellungsdienst-SKUs.

IotHubDefinitionDescription

Beschreibung des IoT-Hubs.

IpFilterActionType

Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden.

IpFilterRule

Die IP-Filterregeln für einen Bereitstellungsdienst.

IpFilterTargetType

Ziel für Anforderungen, die von dieser Regel erfasst werden.

PrivateEndpoint

Die private Endpunkteigenschaft einer privaten Endpunktverbindung

PrivateEndpointConnection

Die private Endpunktverbindung eines Bereitstellungsdiensts

PrivateEndpointConnectionProperties

Die Eigenschaften einer privaten Endpunktverbindung

PrivateLinkServiceConnectionState

Der aktuelle Status einer privaten Endpunktverbindung

PrivateLinkServiceConnectionStatus

Der Status einer privaten Endpunktverbindung

ProvisioningServiceDescription

Die Beschreibung des Bereitstellungsdiensts.

PublicNetworkAccess

Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Beschreibung des freigegebenen Zugriffsschlüssels.

state

Aktueller Status des Bereitstellungsdiensts.

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

AccessRightsDescription

Rechte, die dieser Schlüssel hat.

Wert Beschreibung
DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig

AllocationPolicy

Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll.

Wert Beschreibung
GeoLatency
Hashed
Static

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Wert Beschreibung
Application
Key
ManagedIdentity
User

ErrorDetails

Fehlerdetails.

Name Typ Beschreibung
code

integer (int32)

Der Fehlercode.

details

string

Die Fehlerdetails.

httpStatusCode

string

Der HTTP-Statuscode.

message

string

Die Fehlermeldung.

IotDpsPropertiesDescription

die dienstspezifischen Eigenschaften eines Bereitstellungsdiensts, einschließlich Schlüsseln, verknüpften Iot-Hubs, aktueller Status und vom System generierte Eigenschaften wie Hostname und idScope

Name Typ Beschreibung
allocationPolicy

AllocationPolicy

Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll.

authorizationPolicies

SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]

Liste der Autorisierungsschlüssel für einen Bereitstellungsdienst.

deviceProvisioningHostName

string

Geräteendpunkt für diesen Bereitstellungsdienst.

enableDataResidency

boolean

Wahlfrei. Gibt an, ob die DPS-Instanz Data Residency aktiviert hat und die cross-geo-pair-Notfallwiederherstellung entfernt wird.

idScope

string

Eindeutiger Bezeichner dieses Bereitstellungsdiensts.

iotHubs

IotHubDefinitionDescription[]

Liste der IoT-Hubs, die diesem Bereitstellungsdienst zugeordnet sind.

ipFilterRules

IpFilterRule[]

Die IP-Filterregeln.

portalOperationsHostName

string

Portalendpunkt zum Aktivieren von CORS für diesen Bereitstellungsdienst.

privateEndpointConnections

PrivateEndpointConnection[]

Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden

provisioningState

string

Der ARM-Bereitstellungsstatus des Bereitstellungsdiensts.

publicNetworkAccess

PublicNetworkAccess

Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind.

serviceOperationsHostName

string

Dienstendpunkt für den Bereitstellungsdienst.

state

state

Aktueller Status des Bereitstellungsdiensts.

IotDpsSku

Sku-Name.

Wert Beschreibung
S1

IotDpsSkuInfo

Liste der möglichen Bereitstellungsdienst-SKUs.

Name Typ Beschreibung
capacity

integer (int64)

Die Anzahl der bereitzustellenden Einheiten

name

IotDpsSku

Sku-Name.

tier

string

Preisstufenname des Bereitstellungsdiensts.

IotHubDefinitionDescription

Beschreibung des IoT-Hubs.

Name Typ Beschreibung
allocationWeight

integer (int32)

Gewichtung, um für einen bestimmten Iot h anzuwenden.

applyAllocationPolicy

boolean

flag for applying allocationPolicy or not for a given iot hub.

connectionString

string

Verbindungszeichenfolge des IoT-Hubs.

location

string

ARM-Region des IoT-Hubs.

name

string

Hostname des IoT-Hubs.

IpFilterActionType

Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden.

Wert Beschreibung
Accept
Reject

IpFilterRule

Die IP-Filterregeln für einen Bereitstellungsdienst.

Name Typ Beschreibung
action

IpFilterActionType

Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden.

filterName

string

Der Name der IP-Filterregel.

ipMask

string

Eine Zeichenfolge, die den IP-Adressbereich in der CIDR-Notation für die Regel enthält.

target

IpFilterTargetType

Ziel für Anforderungen, die von dieser Regel erfasst werden.

IpFilterTargetType

Ziel für Anforderungen, die von dieser Regel erfasst werden.

Wert Beschreibung
all
deviceApi
serviceApi

PrivateEndpoint

Die private Endpunkteigenschaft einer privaten Endpunktverbindung

Name Typ Beschreibung
id

string

Der Ressourcenbezeichner.

PrivateEndpointConnection

Die private Endpunktverbindung eines Bereitstellungsdiensts

Name Typ Beschreibung
id

string

Der Ressourcenbezeichner.

name

string

pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

Der Ressourcenname.

properties

PrivateEndpointConnectionProperties

Die Eigenschaften einer privaten Endpunktverbindung

systemData

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

type

string

Der Ressourcentyp.

PrivateEndpointConnectionProperties

Die Eigenschaften einer privaten Endpunktverbindung

Name Typ Beschreibung
privateEndpoint

PrivateEndpoint

Die private Endpunkteigenschaft einer privaten Endpunktverbindung

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Der aktuelle Status einer privaten Endpunktverbindung

PrivateLinkServiceConnectionState

Der aktuelle Status einer privaten Endpunktverbindung

Name Typ Beschreibung
actionsRequired

string

Aktionen, die für eine private Endpunktverbindung erforderlich sind

description

string

Die Beschreibung für den aktuellen Status einer privaten Endpunktverbindung

status

PrivateLinkServiceConnectionStatus

Der Status einer privaten Endpunktverbindung

PrivateLinkServiceConnectionStatus

Der Status einer privaten Endpunktverbindung

Wert Beschreibung
Approved
Disconnected
Pending
Rejected

ProvisioningServiceDescription

Die Beschreibung des Bereitstellungsdiensts.

Name Typ Beschreibung
etag

string

Das Feld "Etag" ist nicht erforderlich. Wenn sie im Antworttext bereitgestellt wird, muss sie auch als Kopfzeile gemäß der normalen ETag-Konvention bereitgestellt werden.

id

string

Der Ressourcenbezeichner.

location

string

Der Ressourcenspeicherort.

name

string

pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

Der Ressourcenname.

properties

IotDpsPropertiesDescription

Dienstspezifische Eigenschaften für einen Bereitstellungsdienst

resourcegroup

string

Die Ressourcengruppe der Ressource.

sku

IotDpsSkuInfo

Sku-Informationen für einen Bereitstellungsdienst.

subscriptionid

string

Die Abonnement-ID der Ressource.

systemData

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

tags

object

Die Ressourcentags.

type

string

Der Ressourcentyp.

PublicNetworkAccess

Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind.

Wert Beschreibung
Disabled
Enabled

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Beschreibung des freigegebenen Zugriffsschlüssels.

Name Typ Beschreibung
keyName

string

Der Name des Schlüssels.

primaryKey

string

Primärer SAS-Schlüsselwert.

rights

AccessRightsDescription

Rechte, die dieser Schlüssel hat.

secondaryKey

string

Sekundärer SAS-Schlüsselwert.

state

Aktueller Status des Bereitstellungsdiensts.

Wert Beschreibung
Activating
ActivationFailed
Active
Deleted
Deleting
DeletionFailed
FailingOver
FailoverFailed
Resuming
Suspended
Suspending
Transitioning

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name Typ Beschreibung
createdAt

string (date-time)

Der Zeitstempel der Ressourcenerstellung (UTC).

createdBy

string

Die Identität, die die Ressource erstellt hat.

createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

lastModifiedAt

string (date-time)

Der Zeitstempel der letzten Änderung der Ressource (UTC)

lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.

lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.