Partager via


Iot Dps Resource - Create Or Update

Create ou mettre à jour les métadonnées du service d’approvisionnement. Le modèle habituel pour modifier une propriété consiste à récupérer les métadonnées et les métadonnées de sécurité du service d’approvisionnement, puis à les combiner avec les valeurs modifiées dans un nouveau corps pour mettre à jour le service d’approvisionnement.

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

Paramètres URI

Nom Dans Obligatoire Type Description
provisioningServiceName
path True

string

Nom du service d’approvisionnement à créer ou à mettre à jour.

resourceGroupName
path True

string

Identificateur du groupe de ressources.

subscriptionId
path True

string

Identificateur de l’abonnement.

api-version
query True

string

Version de l’API.

Corps de la demande

Nom Obligatoire Type Description
location True

string

Emplacement de la ressource.

properties True

IotDpsPropertiesDescription

Propriétés spécifiques au service pour un service d’approvisionnement

sku True

IotDpsSkuInfo

Informations de référence SKU pour un service d’approvisionnement.

etag

string

Le champ Etag n’est pas obligatoire. Si elle est fournie dans le corps de la réponse, elle doit également être fournie en tant qu’en-tête conformément à la convention ETag normale.

resourcegroup

string

Groupe de ressources de la ressource.

subscriptionid

string

ID d’abonnement de la ressource.

tags

object

Étiquettes de la ressource.

Réponses

Nom Type Description
200 OK

ProvisioningServiceDescription

Le corps contient toutes les propriétés non liées à la sécurité du service d’approvisionnement. Les propriétés liées à la sécurité sont définies sur null.

201 Created

ProvisioningServiceDescription

Cette opération est longue. L’opération retourne une valeur 201 si la validation est terminée. La réponse inclut un en-tête Azure-AsyncOperation qui contient une URL status. Les clients sont censés interroger l’URL status pour la status de l’opération. Si elle réussit, l’opération retourne http status code 201 (OK).

Other Status Codes

ErrorDetails

Réponse d’erreur par défaut.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

DPSCreate

Exemple de requête

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

{
  "location": "East US",
  "properties": {
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  },
  "tags": {}
}

Exemple de réponse

{
  "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": [],
    "enableDataResidency": false,
    "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
  },
  "resourcegroup": "myResourceGroup",
  "type": "Microsoft.Devices/ProvisioningServices",
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
  "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
  "tags": {},
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}
{
  "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": [],
    "enableDataResidency": false,
    "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
  },
  "resourcegroup": "myResourceGroup",
  "type": "Microsoft.Devices/ProvisioningServices",
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
  "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
  "tags": {},
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

Définitions

Nom Description
AccessRightsDescription

Droits dont dispose cette clé.

AllocationPolicy

Stratégie d’allocation à utiliser par ce service d’approvisionnement.

createdByType

Type d’identité qui a créé la ressource.

ErrorDetails

Détails de l’erreur.

IotDpsPropertiesDescription

les propriétés spécifiques au service d’un service d’approvisionnement, y compris les clés, les hubs iot liés, l’état actuel et les propriétés générées par le système, telles que le nom d’hôte et idScope

IotDpsSku

Nom de la référence SKU.

IotDpsSkuInfo

Liste des références SKU de service d’approvisionnement possibles.

IotHubDefinitionDescription

Description du hub IoT.

IpFilterActionType

Action souhaitée pour les demandes capturées par cette règle.

IpFilterRule

Règles de filtre IP pour un service d’approvisionnement.

IpFilterTargetType

Cible pour les demandes capturées par cette règle.

PrivateEndpoint

Propriété de point de terminaison privé d’une connexion de point de terminaison privé

PrivateEndpointConnection

Connexion de point de terminaison privé d’un service d’approvisionnement

PrivateEndpointConnectionProperties

Propriétés d’une connexion de point de terminaison privé

PrivateLinkServiceConnectionState

État actuel d’une connexion de point de terminaison privé

PrivateLinkServiceConnectionStatus

Status d’une connexion de point de terminaison privé

ProvisioningServiceDescription

Description du service d’approvisionnement.

PublicNetworkAccess

Si les demandes provenant du réseau public sont autorisées

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Description de la clé d’accès partagé.

state

État actuel du service d’approvisionnement.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

AccessRightsDescription

Droits dont dispose cette clé.

Nom Type Description
DeviceConnect

string

EnrollmentRead

string

EnrollmentWrite

string

RegistrationStatusRead

string

RegistrationStatusWrite

string

ServiceConfig

string

AllocationPolicy

Stratégie d’allocation à utiliser par ce service d’approvisionnement.

Nom Type Description
GeoLatency

string

Hashed

string

Static

string

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDetails

Détails de l’erreur.

Nom Type Description
code

integer

Code d'erreur.

details

string

Détails de l’erreur.

httpStatusCode

string

Code d’état HTTP.

message

string

Message d’erreur.

IotDpsPropertiesDescription

les propriétés spécifiques au service d’un service d’approvisionnement, y compris les clés, les hubs iot liés, l’état actuel et les propriétés générées par le système, telles que le nom d’hôte et idScope

Nom Type Description
allocationPolicy

AllocationPolicy

Stratégie d’allocation à utiliser par ce service d’approvisionnement.

authorizationPolicies

SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]

Liste des clés d’autorisation pour un service d’approvisionnement.

deviceProvisioningHostName

string

Point de terminaison d’appareil pour ce service d’approvisionnement.

enableDataResidency

boolean

facultatif. Indique si le instance DPS a Data Residency activé, ce qui supprime la récupération d’urgence des géo-paires croisées.

idScope

string

Identificateur unique de ce service d’approvisionnement.

iotHubs

IotHubDefinitionDescription[]

Liste des hubs IoT associés à ce service d’approvisionnement.

ipFilterRules

IpFilterRule[]

Règles de filtre IP.

portalOperationsHostName

string

Point de terminaison du portail pour activer CORS pour ce service d’approvisionnement.

privateEndpointConnections

PrivateEndpointConnection[]

Connexions de point de terminaison privé créées sur cet IotHub

provisioningState

string

État d’approvisionnement ARM du service d’approvisionnement.

publicNetworkAccess

PublicNetworkAccess

Si les demandes provenant du réseau public sont autorisées

serviceOperationsHostName

string

Point de terminaison de service pour le service d’approvisionnement.

state

state

État actuel du service d’approvisionnement.

IotDpsSku

Nom de la référence SKU.

Nom Type Description
S1

string

IotDpsSkuInfo

Liste des références SKU de service d’approvisionnement possibles.

Nom Type Description
capacity

integer

Nombre d’unités à provisionner

name

IotDpsSku

Nom de la référence SKU.

tier

string

Nom du niveau tarifaire du service d’approvisionnement.

IotHubDefinitionDescription

Description du hub IoT.

Nom Type Description
allocationWeight

integer

poids à appliquer pour un iot h donné.

applyAllocationPolicy

boolean

indicateur permettant d’appliquer allocationPolicy ou non à un hub iot donné.

connectionString

string

Chaîne de connexion du hub IoT.

location

string

Région ARM du hub IoT.

name

string

Nom d’hôte du hub IoT.

IpFilterActionType

Action souhaitée pour les demandes capturées par cette règle.

Nom Type Description
Accept

string

Reject

string

IpFilterRule

Règles de filtre IP pour un service d’approvisionnement.

Nom Type Description
action

IpFilterActionType

Action souhaitée pour les demandes capturées par cette règle.

filterName

string

Nom de la règle de filtre IP.

ipMask

string

Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle.

target

IpFilterTargetType

Cible pour les demandes capturées par cette règle.

IpFilterTargetType

Cible pour les demandes capturées par cette règle.

Nom Type Description
all

string

deviceApi

string

serviceApi

string

PrivateEndpoint

Propriété de point de terminaison privé d’une connexion de point de terminaison privé

Nom Type Description
id

string

Identificateur de ressource.

PrivateEndpointConnection

Connexion de point de terminaison privé d’un service d’approvisionnement

Nom Type Description
id

string

Identificateur de ressource.

name

string

Nom de la ressource.

properties

PrivateEndpointConnectionProperties

Propriétés d’une connexion de point de terminaison privé

systemData

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

type

string

Type de ressource.

PrivateEndpointConnectionProperties

Propriétés d’une connexion de point de terminaison privé

Nom Type Description
privateEndpoint

PrivateEndpoint

Propriété de point de terminaison privé d’une connexion de point de terminaison privé

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

État actuel d’une connexion de point de terminaison privé

PrivateLinkServiceConnectionState

État actuel d’une connexion de point de terminaison privé

Nom Type Description
actionsRequired

string

Actions requises pour une connexion de point de terminaison privé

description

string

Description de l’état actuel d’une connexion de point de terminaison privé

status

PrivateLinkServiceConnectionStatus

Status d’une connexion de point de terminaison privé

PrivateLinkServiceConnectionStatus

Status d’une connexion de point de terminaison privé

Nom Type Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

ProvisioningServiceDescription

Description du service d’approvisionnement.

Nom Type Description
etag

string

Le champ Etag n’est pas obligatoire. Si elle est fournie dans le corps de la réponse, elle doit également être fournie en tant qu’en-tête conformément à la convention ETag normale.

id

string

Identificateur de ressource.

location

string

Emplacement de la ressource.

name

string

Nom de la ressource.

properties

IotDpsPropertiesDescription

Propriétés spécifiques au service pour un service d’approvisionnement

resourcegroup

string

Groupe de ressources de la ressource.

sku

IotDpsSkuInfo

Informations de référence SKU pour un service d’approvisionnement.

subscriptionid

string

ID d’abonnement de la ressource.

systemData

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

tags

object

Étiquettes de la ressource.

type

string

Type de ressource.

PublicNetworkAccess

Si les demandes provenant du réseau public sont autorisées

Nom Type Description
Disabled

string

Enabled

string

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Description de la clé d’accès partagé.

Nom Type Description
keyName

string

Nom de la clé.

primaryKey

string

Valeur de clé SAS primaire.

rights

AccessRightsDescription

Droits dont dispose cette clé.

secondaryKey

string

Valeur de clé SAS secondaire.

state

État actuel du service d’approvisionnement.

Nom Type Description
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

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string

Horodatage de la dernière modification de la ressource (UTC)

lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.