Compartilhar via


Iot Dps Resource - Create Or Update

Crie ou atualize os metadados do serviço de provisionamento. O padrão usual para modificar uma propriedade é recuperar os metadados de serviço de provisionamento e os metadados de segurança e combiná-los com os valores modificados em um novo corpo para atualizar o serviço de provisionamento.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
provisioningServiceName
path True

string

Nome do serviço de provisionamento para criar ou atualizar.

resourceGroupName
path True

string

Identificador do grupo de recursos.

subscriptionId
path True

string

O identificador da assinatura.

api-version
query True

string

A versão da API.

Corpo da solicitação

Nome Obrigatório Tipo Description
location True

string

O local do recurso.

properties True

IotDpsPropertiesDescription

Propriedades específicas do serviço para um serviço de provisionamento

sku True

IotDpsSkuInfo

Informações de SKU para um serviço de provisionamento.

etag

string

O campo Etag não é necessário. Se for fornecido no corpo da resposta, ele também deverá ser fornecido como um cabeçalho de acordo com a convenção ETag normal.

resourcegroup

string

O grupo de recursos do recurso.

subscriptionid

string

A ID da assinatura do recurso.

tags

object

As marcas de recurso.

Respostas

Nome Tipo Description
200 OK

ProvisioningServiceDescription

O corpo contém todas as propriedades não de segurança do serviço de provisionamento. As propriedades relacionadas à segurança são definidas como nulas.

201 Created

ProvisioningServiceDescription

Esta é uma operação de execução longa. A operação retornará um 201 se a validação for concluída. A resposta inclui um cabeçalho Azure-AsyncOperation que contém uma URL de status. Espera-se que os clientes pesquisem a URL de status para o status da operação. Se bem-sucedida, a operação retornará o código de status HTTP de 201 (OK).

Other Status Codes

ErrorDetails

Resposta de erro padrão.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

DPSCreate

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
AccessRightsDescription

Direitos que essa chave tem.

AllocationPolicy

Política de alocação a ser usada por esse serviço de provisionamento.

createdByType

O tipo de identidade que criou o recurso.

ErrorDetails

Detalhes do erro.

IotDpsPropertiesDescription

as propriedades específicas do serviço de um serviço de provisionamento, incluindo chaves, hubs iot vinculados, estado atual e propriedades geradas pelo sistema, como nome do host e idScope

IotDpsSku

Nome do SKU.

IotDpsSkuInfo

Lista de possíveis SKUs do serviço de provisionamento.

IotHubDefinitionDescription

Descrição do hub IoT.

IpFilterActionType

A ação desejada para solicitações capturadas por essa regra.

IpFilterRule

As regras de filtro IP para um serviço de provisionamento.

IpFilterTargetType

Destino para solicitações capturadas por essa regra.

PrivateEndpoint

A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privado

PrivateEndpointConnection

A conexão de ponto de extremidade privado de um serviço de provisionamento

PrivateEndpointConnectionProperties

As propriedades de uma conexão de ponto de extremidade privado

PrivateLinkServiceConnectionState

O estado atual de uma conexão de ponto de extremidade privado

PrivateLinkServiceConnectionStatus

O status de uma conexão de ponto de extremidade privado

ProvisioningServiceDescription

A descrição do serviço de provisionamento.

PublicNetworkAccess

Se as solicitações da Rede Pública são permitidas

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Descrição da chave de acesso compartilhado.

state

Estado atual do serviço de provisionamento.

systemData

Metadados relativos à criação e última modificação do recurso.

AccessRightsDescription

Direitos que essa chave tem.

Valor Description
DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig

AllocationPolicy

Política de alocação a ser usada por esse serviço de provisionamento.

Valor Description
GeoLatency
Hashed
Static

createdByType

O tipo de identidade que criou o recurso.

Valor Description
Application
Key
ManagedIdentity
User

ErrorDetails

Detalhes do erro.

Nome Tipo Description
code

integer (int32)

O código de erro.

details

string

Os detalhes do erro.

httpStatusCode

string

O código de status HTTP.

message

string

A mensagem de erro.

IotDpsPropertiesDescription

as propriedades específicas do serviço de um serviço de provisionamento, incluindo chaves, hubs iot vinculados, estado atual e propriedades geradas pelo sistema, como nome do host e idScope

Nome Tipo Description
allocationPolicy

AllocationPolicy

Política de alocação a ser usada por esse serviço de provisionamento.

authorizationPolicies

SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]

Lista de chaves de autorização para um serviço de provisionamento.

deviceProvisioningHostName

string

Ponto de extremidade do dispositivo para este serviço de provisionamento.

enableDataResidency

boolean

Opcional. Indica se a instância do DPS tem a Residência de Dados habilitada, removendo a recuperação de desastre entre pares geográficos.

idScope

string

Identificador exclusivo desse serviço de provisionamento.

iotHubs

IotHubDefinitionDescription[]

Lista de hubs IoT associados a esse serviço de provisionamento.

ipFilterRules

IpFilterRule[]

As regras de filtro IP.

portalOperationsHostName

string

Ponto de extremidade do portal para habilitar o CORS para esse serviço de provisionamento.

privateEndpointConnections

PrivateEndpointConnection[]

Conexões de ponto de extremidade privado criadas neste IotHub

provisioningState

string

O estado de provisionamento do ARM do serviço de provisionamento.

publicNetworkAccess

PublicNetworkAccess

Se as solicitações da Rede Pública são permitidas

serviceOperationsHostName

string

Ponto de extremidade de serviço para o serviço de provisionamento.

state

state

Estado atual do serviço de provisionamento.

IotDpsSku

Nome do SKU.

Valor Description
S1

IotDpsSkuInfo

Lista de possíveis SKUs do serviço de provisionamento.

Nome Tipo Description
capacity

integer (int64)

O número de unidades a serem provisionadas

name

IotDpsSku

Nome do SKU.

tier

string

Nome do tipo de preço do serviço de provisionamento.

IotHubDefinitionDescription

Descrição do hub IoT.

Nome Tipo Description
allocationWeight

integer (int32)

peso a ser aplicado a um determinado iot h.

applyAllocationPolicy

boolean

sinalizador para aplicar allocationPolicy ou não para um determinado hub iot.

connectionString

string

Cadeia de conexão do hub IoT.

location

string

Região do ARM do hub IoT.

name

string

Nome do host do hub IoT.

IpFilterActionType

A ação desejada para solicitações capturadas por essa regra.

Valor Description
Accept
Reject

IpFilterRule

As regras de filtro IP para um serviço de provisionamento.

Nome Tipo Description
action

IpFilterActionType

A ação desejada para solicitações capturadas por essa regra.

filterName

string

O nome da regra de filtro IP.

ipMask

string

Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra.

target

IpFilterTargetType

Destino para solicitações capturadas por essa regra.

IpFilterTargetType

Destino para solicitações capturadas por essa regra.

Valor Description
all
deviceApi
serviceApi

PrivateEndpoint

A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privado

Nome Tipo Description
id

string

O identificador de recurso.

PrivateEndpointConnection

A conexão de ponto de extremidade privado de um serviço de provisionamento

Nome Tipo Description
id

string

O identificador de recurso.

name

string

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

O nome do recurso.

properties

PrivateEndpointConnectionProperties

As propriedades de uma conexão de ponto de extremidade privado

systemData

systemData

Metadados relativos à criação e última modificação do recurso.

type

string

O tipo de recurso.

PrivateEndpointConnectionProperties

As propriedades de uma conexão de ponto de extremidade privado

Nome Tipo Description
privateEndpoint

PrivateEndpoint

A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privado

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

O estado atual de uma conexão de ponto de extremidade privado

PrivateLinkServiceConnectionState

O estado atual de uma conexão de ponto de extremidade privado

Nome Tipo Description
actionsRequired

string

Ações necessárias para uma conexão de ponto de extremidade privado

description

string

A descrição do estado atual de uma conexão de ponto de extremidade privado

status

PrivateLinkServiceConnectionStatus

O status de uma conexão de ponto de extremidade privado

PrivateLinkServiceConnectionStatus

O status de uma conexão de ponto de extremidade privado

Valor Description
Approved
Disconnected
Pending
Rejected

ProvisioningServiceDescription

A descrição do serviço de provisionamento.

Nome Tipo Description
etag

string

O campo Etag não é necessário. Se for fornecido no corpo da resposta, ele também deverá ser fornecido como um cabeçalho de acordo com a convenção ETag normal.

id

string

O identificador de recurso.

location

string

O local do recurso.

name

string

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

O nome do recurso.

properties

IotDpsPropertiesDescription

Propriedades específicas do serviço para um serviço de provisionamento

resourcegroup

string

O grupo de recursos do recurso.

sku

IotDpsSkuInfo

Informações de SKU para um serviço de provisionamento.

subscriptionid

string

A ID da assinatura do recurso.

systemData

systemData

Metadados relativos à criação e última modificação do recurso.

tags

object

As marcas de recurso.

type

string

O tipo de recurso.

PublicNetworkAccess

Se as solicitações da Rede Pública são permitidas

Valor Description
Disabled
Enabled

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Descrição da chave de acesso compartilhado.

Nome Tipo Description
keyName

string

Nome da chave.

primaryKey

string

Valor da chave SAS primária.

rights

AccessRightsDescription

Direitos que essa chave tem.

secondaryKey

string

Valor de chave SAS secundário.

state

Estado atual do serviço de provisionamento.

Valor Description
Activating
ActivationFailed
Active
Deleted
Deleting
DeletionFailed
FailingOver
FailoverFailed
Resuming
Suspended
Suspending
Transitioning

systemData

Metadados relativos à criação e última modificação do recurso.

Nome Tipo Description
createdAt

string (date-time)

O carimbo de data/hora da criação de recursos (UTC).

createdBy

string

A identidade que criou o recurso.

createdByType

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt

string (date-time)

O carimbo de data/hora da última modificação do recurso (UTC)

lastModifiedBy

string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.