Partilhar via


Iot Dps Resource - Update

Atualize as tags de um serviço de provisionamento existente. para atualizar outros campos, use o método CreateOrUpdate

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

Parâmetros do URI

Name Em Necessário Tipo Description
provisioningServiceName
path True

string

Nome do serviço de provisionamento a ser criado ou atualizado.

resourceGroupName
path True

string

Identificador do grupo de recursos.

subscriptionId
path True

string

O identificador de assinatura.

api-version
query True

string

A versão da API.

Corpo do Pedido

Name Tipo Description
tags

object

Tags de recursos

Respostas

Name Tipo Description
200 OK

ProvisioningServiceDescription

O Serviço de Provisionamento foi atualizado com êxito

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

DPSPatch

Pedido de amostra

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

{
  "tags": {
    "foo": "bar"
  }
}

Resposta da amostra

{
  "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",
    "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": {
    "foo": "bar"
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

Definições

Name Description
AccessRightsDescription

Direitos que esta chave tem.

AllocationPolicy

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

createdByType

O tipo de identidade que criou o recurso.

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 hostname e idScope

IotDpsSku

Nome Sku.

IotDpsSkuInfo

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

IotHubDefinitionDescription

Descrição do hub IoT.

IpFilterActionType

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

IpFilterRule

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

IpFilterTargetType

Destino para solicitações capturadas por esta regra.

PrivateEndpoint

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

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 privada

PrivateLinkServiceConnectionState

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

PrivateLinkServiceConnectionStatus

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

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 partilhada.

state

Estado atual do serviço de provisionamento.

systemData

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

TagsResource

Um contêiner que contém apenas as Tags de um recurso, permitindo que o usuário atualize as tags em uma instância do Serviço de Provisionamento.

AccessRightsDescription

Direitos que esta chave tem.

Valor Description
DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig

AllocationPolicy

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

Valor Description
GeoLatency
Hashed
Static

createdByType

O tipo de identidade que criou o recurso.

Valor Description
Application
Key
ManagedIdentity
User

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 hostname e idScope

Name Tipo Description
allocationPolicy

AllocationPolicy

Política de alocação a ser usada por este 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 desastres entre pares geográficos.

idScope

string

Identificador exclusivo deste serviço de provisionamento.

iotHubs

IotHubDefinitionDescription[]

Lista de hubs IoT associados a este 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 privadas criadas neste IotHub

provisioningState

string

O estado de provisionamento 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 serviço de provisionamento.

state

state

Estado atual do serviço de provisionamento.

IotDpsSku

Nome Sku.

Valor Description
S1

IotDpsSkuInfo

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

Name Tipo Description
capacity

integer (int64)

O número de unidades a provisionar

name

IotDpsSku

Nome Sku.

tier

string

Nome da camada de preço do serviço de provisionamento.

IotHubDefinitionDescription

Descrição do hub IoT.

Name Tipo Description
allocationWeight

integer (int32)

peso para aplicar para 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 ARM do hub IoT.

name

string

Nome do host do hub IoT.

IpFilterActionType

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

Valor Description
Accept
Reject

IpFilterRule

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

Name Tipo Description
action

IpFilterActionType

A ação desejada para solicitações capturadas por esta 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 esta regra.

IpFilterTargetType

Destino para solicitações capturadas por esta regra.

Valor Description
all
deviceApi
serviceApi

PrivateEndpoint

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

Name Tipo Description
id

string

O identificador de recurso.

PrivateEndpointConnection

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

Name 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 privada

systemData

systemData

Metadados referentes à 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 privada

Name Tipo Description
privateEndpoint

PrivateEndpoint

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

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

Name Tipo Description
actionsRequired

string

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

description

string

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

status

PrivateLinkServiceConnectionStatus

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

PrivateLinkServiceConnectionStatus

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

Valor Description
Approved
Disconnected
Pending
Rejected

ProvisioningServiceDescription

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

Name Tipo Description
etag

string

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

id

string

O identificador de recurso.

location

string

A localização 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 de assinatura do recurso.

systemData

systemData

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

tags

object

As tags 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 partilhada.

Name Tipo Description
keyName

string

Nome da chave.

primaryKey

string

Valor da chave SAS primária.

rights

AccessRightsDescription

Direitos que esta chave tem.

secondaryKey

string

Valor da chave SAS secundária.

state

Estado atual do serviço de provisionamento.

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

systemData

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

Name 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.

TagsResource

Um contêiner que contém apenas as Tags de um recurso, permitindo que o usuário atualize as tags em uma instância do Serviço de Provisionamento.

Name Tipo Description
tags

object

Tags de recursos