Instances - Create
Erstellt oder aktualisiert instance.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/instances/{instanceName}?api-version=2023-07-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
account
|
path | True |
string |
Kontoname. Regex pattern: |
instance
|
path | True |
string |
Der Instanzname. Regex pattern: |
resource
|
path | True |
string |
Der Name der Ressourcengruppe. |
subscription
|
path | True |
string |
Die Azure-Abonnement-ID. |
api-version
|
query | True |
string |
ADU-Schema-API-Version. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
location | True |
string |
Der geografische Standort, an dem sich die Ressource befindet |
properties.diagnosticStorageProperties |
Vom Kunden initiierte Speichereigenschaften der Diagnoseprotokollsammlung |
||
properties.enableDiagnostics |
boolean |
Aktiviert oder deaktiviert die Sammlung von Diagnoseprotokollen. |
|
properties.iotHubs |
Liste der IoT Hubs, die dem Konto zugeordnet sind. |
||
tags |
object |
Ressourcentags. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
201 Created |
Asynchroner Vorgang zum Erstellen oder Aktualisieren der Instanz wurde erstellt. |
|
Other Status Codes |
Fehlerantwort, die den Grund für einen Vorgangsfehler beschreibt. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
Creates or updates Instance
Sample Request
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/instances/blue?api-version=2023-07-01
{
"location": "westus2",
"properties": {
"iotHubs": [
{
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/blue-contoso-hub"
}
],
"enableDiagnostics": false,
"diagnosticStorageProperties": {
"authenticationType": "KeyBased",
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/adu-resource-group/providers/Microsoft.Storage/storageAccounts/testAccount",
"connectionString": "string"
}
}
}
Sample Response
{
"name": "blue",
"location": "westus2",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/instances/blue",
"type": "Microsoft.DeviceUpdate/accounts/instances",
"properties": {
"provisioningState": "Accepted",
"accountName": "contoso",
"iotHubs": [
{
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/blue-contoso-hub"
}
],
"enableDiagnostics": false,
"diagnosticStorageProperties": {
"authenticationType": "KeyBased",
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/adu-resource-group/providers/Microsoft.Storage/storageAccounts/testAccount"
}
}
}
Definitionen
Name | Beschreibung |
---|---|
Authentication |
Authentifizierungstyp |
created |
Der Identitätstyp, der die Ressource erstellt hat. |
Diagnostic |
Vom Kunden initiierte Speichereigenschaften der Diagnoseprotokollsammlung |
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Error |
Die Fehlerdetails. |
Error |
Fehlerantwort |
Instance |
Device Update instance Details. |
Iot |
Integration des Device Update-Kontos mit IoT Hub Einstellungen. |
Provisioning |
Bereitstellungsstatus. |
system |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. |
AuthenticationType
Authentifizierungstyp
Name | Typ | Beschreibung |
---|---|---|
KeyBased |
string |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
Name | Typ | Beschreibung |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DiagnosticStorageProperties
Vom Kunden initiierte Speichereigenschaften der Diagnoseprotokollsammlung
Name | Typ | Beschreibung |
---|---|---|
authenticationType |
Authentifizierungstyp |
|
connectionString |
string |
ConnectionString des Diagnosespeicherkontos |
resourceId |
string |
ResourceId des Diagnosespeicherkontos |
ErrorAdditionalInfo
Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Zusätzliche Informationen. |
type |
string |
Typ der zusätzlichen Informationen. |
ErrorDetail
Die Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Fehlerinformationen. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
Instance
Device Update instance Details.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
Der geografische Standort, an dem sich die Ressource befindet |
name |
string |
Der Name der Ressource |
properties.accountName |
string |
Name des übergeordneten Geräteupdatekontos, zu dem die Instanz gehört. |
properties.diagnosticStorageProperties |
Vom Kunden initiierte Speichereigenschaften der Diagnoseprotokollsammlung |
|
properties.enableDiagnostics |
boolean |
Aktiviert oder deaktiviert die Sammlung von Diagnoseprotokollen. |
properties.iotHubs |
Liste der IoT Hubs, die dem Konto zugeordnet sind. |
|
properties.provisioningState |
Bereitstellungsstatus. |
|
systemData |
Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen. |
|
tags |
object |
Ressourcentags. |
type |
string |
Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
IotHubSettings
Integration des Device Update-Kontos mit IoT Hub Einstellungen.
Name | Typ | Beschreibung |
---|---|---|
resourceId |
string |
IoTHub-Ressourcen-ID |
ProvisioningState
Bereitstellungsstatus.
Name | Typ | Beschreibung |
---|---|---|
Accepted |
string |
|
Canceled |
string |
|
Creating |
string |
|
Deleted |
string |
|
Failed |
string |
|
Succeeded |
string |
systemData
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string |
Der Zeitstempel der Ressourcenerstellung (UTC). |
createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
createdByType |
Der Identitätstyp, der die Ressource erstellt hat. |
|
lastModifiedAt |
string |
Der Zeitstempel der letzten Änderung der Ressource (UTC) |
lastModifiedBy |
string |
Die Identität, die die Ressource zuletzt geändert hat. |
lastModifiedByType |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |