Iot Hub Resource - Delete
Exclua um hub IoT.
DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2023-06-30
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
O nome do grupo de recursos que contém o hub IoT. |
resource
|
path | True |
string |
O nome do Hub IoT. |
subscription
|
path | True |
string |
O identificador da assinatura. |
api-version
|
query | True |
string |
A versão da API. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Isso é retornado como uma resposta ao status solicitação de sondagem para a operação de exclusão. O corpo contém a representação de recurso que indica um estado de provisionamento transitório. |
|
202 Accepted |
O provedor de recursos do Hub Iot sempre retorna um código 202 Accepted status com cabeçalhos de Localização e Retry-After válidos. O provedor de recursos também define o cabeçalho Azure-AsyncOperation com uma URL que aponta para o recurso de operação dessa operação. As tentativas GET subsequentes no recurso após uma operação DELETE retornam uma representação de recurso que indica um estado de provisionamento transitório (como Terminação). Para recuperar o status da operação, um cliente pode sondar a URL retornada no cabeçalho Local após o intervalo de Retry-After, obter o serviço Hub IoT status diretamente ou consultar o recurso de operação. Headers
|
|
204 No Content |
Depois que a operação de exclusão de execução prolongada for concluída com êxito, um código 204 No Content status será retornado quando a solicitação de sondagem status localizar os metadados do hub Iot no serviço e o status da operação de exclusão for definido como um estado concluído. |
|
404 Not Found |
Depois que a operação de exclusão de execução prolongada for concluída com êxito, um 404 Não Encontrado será retornado quando o status solicitação de sondagem não encontrar mais os metadados do hub Iot no serviço. |
|
Other Status Codes |
DefaultErrorResponse |
Segurança
azure_auth
Fluxo do OAuth2 do Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Description |
---|---|
user_impersonation | representar sua conta de usuário |
Exemplos
IotHubResource_Delete
Sample Request
Sample Response
{
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
"name": "testHub",
"type": "Microsoft.Devices/IotHubs",
"location": "centraluseuap",
"tags": {},
"etag": "AAAAAAFD6M4=",
"properties": {
"state": "Active",
"provisioningState": "Succeeded",
"ipFilterRules": [
{
"filterName": "rule1",
"action": "Accept",
"ipMask": "131.117.159.53"
},
{
"filterName": "rule2",
"action": "Accept",
"ipMask": "157.55.59.128/25"
}
],
"networkRuleSets": {
"defaultAction": "Deny",
"applyToBuiltInEventHubEndpoint": true,
"ipRules": [
{
"filterName": "rule1",
"action": "Allow",
"ipMask": "131.117.159.53"
},
{
"filterName": "rule2",
"action": "Allow",
"ipMask": "157.55.59.128/25"
}
]
},
"hostName": "iot-dps-cit-hub-1.azure-devices.net",
"eventHubEndpoints": {
"events": {
"retentionTimeInDays": 1,
"partitionCount": 2,
"partitionIds": [
"0",
"1"
],
"path": "iot-dps-cit-hub-1",
"endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
}
},
"routing": {
"endpoints": {
"serviceBusQueues": [],
"serviceBusTopics": [],
"eventHubs": [],
"storageContainers": []
},
"routes": [],
"fallbackRoute": {
"source": "DeviceMessages",
"condition": "true",
"endpointNames": [
"events"
],
"isEnabled": true
}
},
"storageEndpoints": {
"$default": {
"sasTtlAsIso8601": "PT1H",
"connectionString": "",
"containerName": ""
}
},
"messagingEndpoints": {
"fileNotifications": {
"lockDurationAsIso8601": "PT1M",
"ttlAsIso8601": "PT1H",
"maxDeliveryCount": 10
}
},
"enableFileUploadNotifications": false,
"cloudToDevice": {
"maxDeliveryCount": 10,
"defaultTtlAsIso8601": "PT1H",
"feedback": {
"lockDurationAsIso8601": "PT1M",
"ttlAsIso8601": "PT1H",
"maxDeliveryCount": 10
}
},
"features": "None"
},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
},
"systemData": {
"createdAt": "2021-01-30T00:28:38.963Z"
}
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/operationResults/b3NfaWhfYmJhZmM4OWItNzQ3My00OWExLTg0NWUtNzQ3NWU2ODBkNDA3?api-version=2023-06-30-preview&operationSource=os_ih&asyncinfo
Location: https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/operationResults/b3NfaWhfYmJhZmM4OWItNzQ3My00OWExLTg0NWUtNzQ3NWU2ODBkNDA3?api-version=2022-11-01-preview&operationSource=os_ih
{
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
"name": "testHub",
"type": "Microsoft.Devices/IotHubs",
"location": "centraluseuap",
"tags": {},
"etag": "AAAAAAFD6M4=",
"properties": {
"state": "Active",
"provisioningState": "Succeeded",
"ipFilterRules": [
{
"filterName": "rule1",
"action": "Accept",
"ipMask": "131.117.159.53"
},
{
"filterName": "rule2",
"action": "Accept",
"ipMask": "157.55.59.128/25"
}
],
"networkRuleSets": {
"defaultAction": "Deny",
"applyToBuiltInEventHubEndpoint": true,
"ipRules": [
{
"filterName": "rule1",
"action": "Allow",
"ipMask": "131.117.159.53"
},
{
"filterName": "rule2",
"action": "Allow",
"ipMask": "157.55.59.128/25"
}
]
},
"hostName": "iot-dps-cit-hub-1.azure-devices.net",
"eventHubEndpoints": {
"events": {
"retentionTimeInDays": 1,
"partitionCount": 2,
"partitionIds": [
"0",
"1"
],
"path": "iot-dps-cit-hub-1",
"endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
}
},
"routing": {
"endpoints": {
"serviceBusQueues": [],
"serviceBusTopics": [],
"eventHubs": [],
"storageContainers": []
},
"routes": [],
"fallbackRoute": {
"source": "DeviceMessages",
"condition": "true",
"endpointNames": [
"events"
],
"isEnabled": true
}
},
"storageEndpoints": {
"$default": {
"sasTtlAsIso8601": "PT1H",
"connectionString": "",
"containerName": ""
}
},
"messagingEndpoints": {
"fileNotifications": {
"lockDurationAsIso8601": "PT1M",
"ttlAsIso8601": "PT1H",
"maxDeliveryCount": 10
}
},
"enableFileUploadNotifications": false,
"cloudToDevice": {
"maxDeliveryCount": 10,
"defaultTtlAsIso8601": "PT1H",
"feedback": {
"lockDurationAsIso8601": "PT1M",
"ttlAsIso8601": "PT1H",
"maxDeliveryCount": 10
}
},
"features": "None"
},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
}
}
{}
Definições
Nome | Description |
---|---|
Access |
As permissões atribuídas à política de acesso compartilhado. |
Arm |
|
Arm |
|
Authentication |
Especifica o tipo de autenticação que está sendo usado para se conectar à conta de armazenamento. |
authentication |
Método usado para autenticar no ponto de extremidade da fila do barramento de serviço |
Capabilities |
Os recursos e recursos habilitados para o Hub IoT. |
Cloud |
As propriedades de mensagens de nuvem para dispositivo do Hub IoT. |
created |
O tipo de identidade que criou o recurso. |
Default |
Ação padrão para conjunto de regras de rede |
Enrichment |
As propriedades de um enriquecimento que seu hub IoT se aplica às mensagens entregues aos pontos de extremidade. |
Error |
Detalhes do erro. |
Event |
As propriedades do ponto de extremidade compatível com o Hub de Eventos provisionado usado pelo Hub IoT. |
Fallback |
As propriedades da rota de fallback. Hub IoT usa essas propriedades quando roteia mensagens para o ponto de extremidade de fallback. |
Feedback |
As propriedades da fila de comentários para mensagens de nuvem para dispositivo. |
Iot |
A descrição do hub IoT. |
Iot |
Representação pública de um dos locais em que um recurso é provisionado. |
Iot |
As propriedades de um hub IoT. |
Iot |
A função da região pode ser primária ou secundária. A região primária é onde o hub IoT está provisionado no momento. A região secundária é a região emparelhada de DR (recuperação de desastre) do Azure e também a região na qual o hub IoT pode fazer failover. |
Iot |
O nome da SKU. |
Iot |
Informações sobre a SKU do hub IoT. |
Iot |
A camada de cobrança para o hub IoT. |
Ip |
A ação desejada para solicitações capturadas por essa regra. |
Ip |
As regras de filtro IP para o hub IoT. |
Managed |
As propriedades da identidade gerenciada. |
Messaging |
As propriedades dos pontos de extremidade de mensagens usados por esse hub IoT. |
Network |
Ação de filtro IP |
Network |
Regra IP a ser aplicada como parte do conjunto de regras de rede |
Network |
Propriedades do conjunto de regras de rede do IotHub |
Private |
A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privado |
Private |
A conexão de ponto de extremidade privado de um IotHub |
Private |
As propriedades de uma conexão de ponto de extremidade privado |
Private |
O estado atual de uma conexão de ponto de extremidade privado |
Private |
O status de uma conexão de ponto de extremidade privado |
Public |
Se as solicitações da Rede Pública são permitidas |
Resource |
O tipo de identidade usado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço. |
Route |
As propriedades de uma regra de roteamento que seu hub IoT usa para rotear mensagens para pontos de extremidade. |
Routing |
As propriedades relacionadas a um ponto de extremidade de contêiner sql do Cosmos DB. |
Routing |
As propriedades relacionadas aos pontos de extremidade personalizados para os quais o hub IoT roteia mensagens com base nas regras de roteamento. No máximo 10 pontos de extremidade personalizados são permitidos em todos os tipos de ponto de extremidade para hubs pagos e apenas 1 ponto de extremidade personalizado é permitido em todos os tipos de ponto de extremidade para hubs gratuitos. |
Routing |
As propriedades relacionadas a um ponto de extremidade do hub de eventos. |
Routing |
As propriedades relacionadas ao roteamento do hub IoT. Confira: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
Routing |
As propriedades relacionadas aos tipos de ponto de extremidade da fila do barramento de serviço. |
Routing |
As propriedades relacionadas aos tipos de ponto de extremidade do tópico do barramento de serviço. |
Routing |
A origem à qual a regra de roteamento deve ser aplicada, como DeviceMessages. |
Routing |
As propriedades relacionadas a um ponto de extremidade de contêiner de armazenamento. |
Shared |
As propriedades de uma política de acesso compartilhado do Hub IoT. |
Storage |
As propriedades do ponto de extremidade do Armazenamento do Azure para upload de arquivo. |
system |
Metadados relativos à criação e à última modificação do recurso. |
AccessRights
As permissões atribuídas à política de acesso compartilhado.
Nome | Tipo | Description |
---|---|---|
DeviceConnect |
string |
|
RegistryRead |
string |
|
RegistryRead, DeviceConnect |
string |
|
RegistryRead, RegistryWrite |
string |
|
RegistryRead, RegistryWrite, DeviceConnect |
string |
|
RegistryRead, RegistryWrite, ServiceConnect |
string |
|
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect |
string |
|
RegistryRead, ServiceConnect |
string |
|
RegistryRead, ServiceConnect, DeviceConnect |
string |
|
RegistryWrite |
string |
|
RegistryWrite, DeviceConnect |
string |
|
RegistryWrite, ServiceConnect |
string |
|
RegistryWrite, ServiceConnect, DeviceConnect |
string |
|
ServiceConnect |
string |
|
ServiceConnect, DeviceConnect |
string |
ArmIdentity
Nome | Tipo | Description |
---|---|---|
principalId |
string |
ID da entidade de segurança |
tenantId |
string |
ID do locatário |
type |
O tipo de identidade usado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço. |
|
userAssignedIdentities |
<string,
Arm |
ArmUserIdentity
Nome | Tipo | Description |
---|---|---|
clientId |
string |
|
principalId |
string |
AuthenticationType
Especifica o tipo de autenticação que está sendo usado para se conectar à conta de armazenamento.
Nome | Tipo | Description |
---|---|---|
identityBased |
string |
|
keyBased |
string |
authenticationType
Método usado para autenticar no ponto de extremidade da fila do barramento de serviço
Nome | Tipo | Description |
---|---|---|
identityBased |
string |
|
keyBased |
string |
Capabilities
Os recursos e recursos habilitados para o Hub IoT.
Nome | Tipo | Description |
---|---|---|
DeviceManagement |
string |
|
None |
string |
CloudToDeviceProperties
As propriedades de mensagens de nuvem para dispositivo do Hub IoT.
Nome | Tipo | Description |
---|---|---|
defaultTtlAsIso8601 |
string |
O tempo padrão de vida para mensagens de nuvem para dispositivo na fila do dispositivo. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
feedback |
As propriedades da fila de comentários para mensagens de nuvem para dispositivo. |
|
maxDeliveryCount |
integer |
A contagem máxima de entrega para mensagens de nuvem para dispositivo na fila do dispositivo. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
createdByType
O tipo de identidade que criou o recurso.
Nome | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DefaultAction
Ação padrão para conjunto de regras de rede
Nome | Tipo | Description |
---|---|---|
Allow |
string |
|
Deny |
string |
EnrichmentProperties
As propriedades de um enriquecimento que seu hub IoT se aplica às mensagens entregues aos pontos de extremidade.
Nome | Tipo | Description |
---|---|---|
endpointNames |
string[] |
A lista de pontos de extremidade para os quais o enriquecimento é aplicado à mensagem. |
key |
string |
A chave ou o nome da propriedade de enriquecimento. |
value |
string |
O valor da propriedade de enriquecimento. |
ErrorDetails
Detalhes do erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
O código de erro. |
details |
string |
Os detalhes do erro. |
httpStatusCode |
string |
O código de status do HTTP. |
message |
string |
A mensagem de erro. |
EventHubProperties
As propriedades do ponto de extremidade compatível com o Hub de Eventos provisionado usado pelo Hub IoT.
Nome | Tipo | Description |
---|---|---|
endpoint |
string |
O ponto de extremidade compatível com o Hub de Eventos. |
partitionCount |
integer |
O número de partições para receber mensagens do dispositivo para a nuvem no ponto de extremidade compatível com o Hub de Eventos. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. |
partitionIds |
string[] |
As IDs de partição no ponto de extremidade compatível com o Hub de Eventos. |
path |
string |
O nome compatível com o Hub de Eventos. |
retentionTimeInDays |
integer |
O tempo de retenção para mensagens de dispositivo para nuvem em dias. Confira: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages |
FallbackRouteProperties
As propriedades da rota de fallback. Hub IoT usa essas propriedades quando roteia mensagens para o ponto de extremidade de fallback.
Nome | Tipo | Description |
---|---|---|
condition |
string |
A condição que é avaliada para aplicar a rota de fallback. Se a condição não for fornecida, ela será avaliada como true por padrão. Para gramática, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
A lista de pontos de extremidade para os quais as mensagens que atendem à condição são roteadas. Atualmente, apenas 1 ponto de extremidade é permitido. |
isEnabled |
boolean |
Usado para especificar se a rota de fallback está habilitada. |
name |
string |
O nome da rota. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens, tem um comprimento máximo de 64 caracteres e deve ser exclusivo. |
source |
A origem à qual a regra de roteamento deve ser aplicada. Por exemplo, DeviceMessages |
FeedbackProperties
As propriedades da fila de comentários para mensagens de nuvem para dispositivo.
Nome | Tipo | Description |
---|---|---|
lockDurationAsIso8601 |
string |
A duração do bloqueio da fila de comentários. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
maxDeliveryCount |
integer |
O número de vezes que o Hub IoT tenta entregar uma mensagem na fila de comentários. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
ttlAsIso8601 |
string |
O período de tempo para o qual uma mensagem está disponível para consumir antes de expirar pelo Hub IoT. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
IotHubDescription
A descrição do hub IoT.
Nome | Tipo | Description |
---|---|---|
etag |
string |
O campo Etag não é necessário. Se ele 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 do recurso. |
identity |
As identidades gerenciadas para o IotHub. |
|
location |
string |
O local do recurso. |
name |
string |
O nome do recurso. |
properties |
Propriedades do IotHub |
|
sku |
Informações de SKU do IotHub |
|
systemData |
Os metadados do sistema relacionados a esse recurso. |
|
tags |
object |
As marcas do recurso. |
type |
string |
O tipo de recurso. |
IotHubLocationDescription
Representação pública de um dos locais em que um recurso é provisionado.
Nome | Tipo | Description |
---|---|---|
location |
string |
O nome da região do Azure |
role |
A função da região pode ser primária ou secundária. A região primária é onde o hub IoT está provisionado no momento. A região secundária é a região emparelhada de DR (recuperação de desastre) do Azure e também a região na qual o hub IoT pode fazer failover. |
IotHubProperties
As propriedades de um hub IoT.
Nome | Tipo | Description |
---|---|---|
allowedFqdnList |
string[] |
Lista de FQDNs permitidos (Nome de Domínio Totalmente Qualificado) para saída do Hub Iot. |
authorizationPolicies |
As políticas de acesso compartilhado que você pode usar para proteger uma conexão com o Hub IoT. |
|
cloudToDevice |
As propriedades de mensagens de nuvem para dispositivo do Hub IoT. |
|
comments |
string |
Comentários do Hub IoT. |
disableDeviceSAS |
boolean |
Se for true, todas as chaves SAS com escopo de dispositivo (incluindo dispositivos edge, mas excluindo módulos) não poderão ser usadas para autenticação. |
disableLocalAuth |
boolean |
Se for true, os tokens SAS com chaves SAS no escopo do hub Iot não poderão ser usados para autenticação. |
disableModuleSAS |
boolean |
Se for true, todas as chaves SAS no escopo do módulo não poderão ser usadas para autenticação. |
enableDataResidency |
boolean |
Essa propriedade, quando definida como true, habilitará a residência de dados, desabilitando a recuperação de desastre. |
enableFileUploadNotifications |
boolean |
Se True, as notificações de upload de arquivo serão habilitadas. |
eventHubEndpoints |
<string,
Event |
As propriedades do ponto de extremidade compatíveis com o Hub de Eventos. As únicas chaves possíveis para esse dicionário são os eventos. Essa chave precisa estar presente no dicionário ao fazer chamadas de criação ou atualização para o Hub IoT. |
features |
Os recursos e recursos habilitados para o Hub IoT. |
|
hostName |
string |
O nome do host. |
ipFilterRules |
As regras de filtro IP. |
|
locations |
Local primário e secundário para o hub iot |
|
messagingEndpoints |
<string,
Messaging |
As propriedades do ponto de extremidade de mensagens para a fila de notificação de upload de arquivo. |
minTlsVersion |
string |
Especifica a versão mínima do TLS para dar suporte a esse hub. Pode ser definido como "1.2" para que os clientes que usam uma versão do TLS abaixo da 1.2 sejam rejeitados. |
networkRuleSets |
Propriedades do conjunto de regras de rede do IotHub |
|
privateEndpointConnections |
Conexões de ponto de extremidade privado criadas neste IotHub |
|
provisioningState |
string |
O estado de provisionamento. |
publicNetworkAccess |
Se as solicitações da Rede Pública são permitidas |
|
restrictOutboundNetworkAccess |
boolean |
Se for true, a saída do IotHub será restrita apenas aos FQDNs permitidos configurados por meio de allowedFqdnList. |
routing |
As propriedades relacionadas ao roteamento do hub IoT. Confira: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
|
state |
string |
O estado do hub. |
storageEndpoints |
<string,
Storage |
A lista de pontos de extremidade do Armazenamento do Azure em que você pode carregar arquivos. Atualmente, você pode configurar apenas uma conta de Armazenamento do Azure e que DEVE ter sua chave como $default. Especificar mais de uma conta de armazenamento faz com que um erro seja gerado. Não especificar um valor para essa propriedade quando a propriedade enableFileUploadNotifications é definida como True, faz com que um erro seja gerado. |
IotHubReplicaRoleType
A função da região pode ser primária ou secundária. A região primária é onde o hub IoT está provisionado no momento. A região secundária é a região emparelhada de DR (recuperação de desastre) do Azure e também a região na qual o hub IoT pode fazer failover.
Nome | Tipo | Description |
---|---|---|
primary |
string |
|
secondary |
string |
IotHubSku
O nome da SKU.
Nome | Tipo | Description |
---|---|---|
B1 |
string |
|
B2 |
string |
|
B3 |
string |
|
F1 |
string |
|
S1 |
string |
|
S2 |
string |
|
S3 |
string |
IotHubSkuInfo
Informações sobre a SKU do hub IoT.
Nome | Tipo | Description |
---|---|---|
capacity |
integer |
O número de unidades de Hub IoT provisionadas. Veja: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. |
name |
O nome da SKU. |
|
tier |
A camada de cobrança para o hub IoT. |
IotHubSkuTier
A camada de cobrança para o hub IoT.
Nome | Tipo | Description |
---|---|---|
Basic |
string |
|
Free |
string |
|
Standard |
string |
IpFilterActionType
A ação desejada para solicitações capturadas por essa regra.
Nome | Tipo | Description |
---|---|---|
Accept |
string |
|
Reject |
string |
IpFilterRule
As regras de filtro IP para o hub IoT.
Nome | Tipo | Description |
---|---|---|
action |
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. |
ManagedIdentity
As propriedades da identidade gerenciada.
Nome | Tipo | Description |
---|---|---|
userAssignedIdentity |
string |
A identidade atribuída pelo usuário. |
MessagingEndpointProperties
As propriedades dos pontos de extremidade de mensagens usados por esse hub IoT.
Nome | Tipo | Description |
---|---|---|
lockDurationAsIso8601 |
string |
A duração do bloqueio. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
maxDeliveryCount |
integer |
O número de vezes que o Hub IoT tenta entregar uma mensagem. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
ttlAsIso8601 |
string |
O período de tempo para o qual uma mensagem está disponível para consumir antes de expirar pelo Hub IoT. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
NetworkRuleIPAction
Ação de filtro IP
Nome | Tipo | Description |
---|---|---|
Allow |
string |
NetworkRuleSetIpRule
Regra IP a ser aplicada como parte do conjunto de regras de rede
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
action | Allow |
Ação de filtro IP |
|
filterName |
string |
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. |
NetworkRuleSetProperties
Propriedades do conjunto de regras de rede do IotHub
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
applyToBuiltInEventHubEndpoint |
boolean |
Se True, o Conjunto de Regras de Rede também será aplicado ao Ponto de Extremidade do EventHub BuiltIn do IotHub |
|
defaultAction | Deny |
Ação padrão para conjunto de regras de rede |
|
ipRules |
Lista de regras de IP |
PrivateEndpoint
A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privado
Nome | Tipo | Description |
---|---|---|
id |
string |
O identificador do recurso. |
PrivateEndpointConnection
A conexão de ponto de extremidade privado de um IotHub
Nome | Tipo | Description |
---|---|---|
id |
string |
O identificador do recurso. |
name |
string |
O nome do recurso. |
properties |
As propriedades de uma conexão de ponto de extremidade privado |
|
type |
string |
O tipo de recurso. |
PrivateEndpointConnectionProperties
As propriedades de uma conexão de ponto de extremidade privado
Nome | Tipo | Description |
---|---|---|
privateEndpoint |
A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privado |
|
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 |
O status de uma conexão de ponto de extremidade privado |
PrivateLinkServiceConnectionStatus
O status de uma conexão de ponto de extremidade privado
Nome | Tipo | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PublicNetworkAccess
Se as solicitações da Rede Pública são permitidas
Nome | Tipo | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ResourceIdentityType
O tipo de identidade usado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço.
Nome | Tipo | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
RouteProperties
As propriedades de uma regra de roteamento que seu hub IoT usa para rotear mensagens para pontos de extremidade.
Nome | Tipo | Description |
---|---|---|
condition |
string |
A condição que é avaliada para aplicar a regra de roteamento. Se nenhuma condição for fornecida, ela será avaliada como true por padrão. Para gramática, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
A lista de pontos de extremidade para os quais as mensagens que atendem à condição são roteadas. Atualmente, apenas um ponto de extremidade é permitido. |
isEnabled |
boolean |
Usado para especificar se uma rota está habilitada. |
name |
string |
O nome da rota. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens, tem um comprimento máximo de 64 caracteres e deve ser exclusivo. |
source |
A origem à qual a regra de roteamento deve ser aplicada, como DeviceMessages. |
RoutingCosmosDBSqlApiProperties
As propriedades relacionadas a um ponto de extremidade de contêiner sql do Cosmos DB.
Nome | Tipo | Description |
---|---|---|
authenticationType |
Método usado para autenticar no ponto de extremidade do contêiner sql do Cosmos DB |
|
containerName |
string |
O nome do contêiner sql do cosmos DB no banco de dados cosmos DB. |
databaseName |
string |
O nome do banco de dados cosmos DB na conta do cosmos DB. |
endpointUri |
string |
A URL da conta do cosmos DB. Ele deve incluir o protocolo https:// |
id |
string |
ID do ponto de extremidade do contêiner sql do Cosmos DB |
identity |
Propriedades de identidade gerenciada do ponto de extremidade de contêiner do Cosmos DB de roteamento. |
|
name |
string |
O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. |
partitionKeyName |
string |
O nome da chave de partição associada a esse contêiner sql do Cosmos DB, se houver. Esse é um parâmetro opcional. |
partitionKeyTemplate |
string |
O modelo para gerar um valor de chave de partição sintética para uso com esse contêiner sql do Cosmos DB. O modelo deve incluir pelo menos um dos seguintes espaços reservados: {iothub}, {deviceid}, {DD}, {MM}e {YYYY}. Qualquer espaço reservado pode ser especificado no máximo uma vez, mas os componentes de ordem e não espaço reservado são arbitrários. Esse parâmetro só será necessário se PartitionKeyName for especificado. |
primaryKey |
string |
A chave primária da conta do cosmos DB. |
resourceGroup |
string |
O nome do grupo de recursos da conta do cosmos DB. |
secondaryKey |
string |
A chave secundária da conta do cosmos DB. |
subscriptionId |
string |
O identificador de assinatura da conta do Cosmos DB. |
RoutingEndpoints
As propriedades relacionadas aos pontos de extremidade personalizados para os quais o hub IoT roteia mensagens com base nas regras de roteamento. No máximo 10 pontos de extremidade personalizados são permitidos em todos os tipos de ponto de extremidade para hubs pagos e apenas 1 ponto de extremidade personalizado é permitido em todos os tipos de ponto de extremidade para hubs gratuitos.
Nome | Tipo | Description |
---|---|---|
cosmosDBSqlContainers |
A lista de pontos de extremidade de contêiner do Cosmos DB para os quais o Hub IoT roteia mensagens, com base nas regras de roteamento. |
|
eventHubs |
A lista de pontos de extremidade dos Hubs de Eventos para os quais o Hub IoT roteia mensagens, com base nas regras de roteamento. Essa lista não inclui o ponto de extremidade interno dos Hubs de Eventos. |
|
serviceBusQueues |
A lista de pontos de extremidade da fila do Barramento de Serviço para os quais o Hub IoT roteia as mensagens, com base nas regras de roteamento. |
|
serviceBusTopics |
A lista de pontos de extremidade de tópico do Barramento de Serviço para os quais o Hub IoT roteia as mensagens, com base nas regras de roteamento. |
|
storageContainers |
A lista de pontos de extremidade de contêiner de armazenamento para os quais o Hub IoT roteia mensagens, com base nas regras de roteamento. |
RoutingEventHubProperties
As propriedades relacionadas a um ponto de extremidade do hub de eventos.
Nome | Tipo | Description |
---|---|---|
authenticationType |
Método usado para autenticar no ponto de extremidade do hub de eventos |
|
connectionString |
string |
O cadeia de conexão do ponto de extremidade do hub de eventos. |
endpointUri |
string |
A URL do ponto de extremidade do hub de eventos. Ele deve incluir o protocolo sb:// |
entityPath |
string |
Nome do hub de eventos no namespace do hub de eventos |
id |
string |
Id do ponto de extremidade do hub de eventos |
identity |
Propriedades de identidade gerenciada do ponto de extremidade do hub de eventos de roteamento. |
|
name |
string |
O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. |
resourceGroup |
string |
O nome do grupo de recursos do ponto de extremidade do hub de eventos. |
subscriptionId |
string |
O identificador de assinatura do ponto de extremidade do hub de eventos. |
RoutingProperties
As propriedades relacionadas ao roteamento do hub IoT. Confira: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
Nome | Tipo | Description |
---|---|---|
endpoints |
As propriedades relacionadas aos pontos de extremidade personalizados para os quais o hub IoT roteia mensagens com base nas regras de roteamento. No máximo 10 pontos de extremidade personalizados são permitidos em todos os tipos de ponto de extremidade para hubs pagos e apenas 1 ponto de extremidade personalizado é permitido em todos os tipos de ponto de extremidade para hubs gratuitos. |
|
enrichments |
A lista de enriquecimentos fornecidos pelo usuário que o Hub IoT aplica às mensagens a serem entregues a pontos de extremidade internos e personalizados. Confira: https://aka.ms/telemetryoneventgrid |
|
fallbackRoute |
As propriedades da rota que é usada como uma rota de fall-back quando nenhuma das condições especificadas na seção "rotas" são atendidas. Esse é um parâmetro opcional. Quando essa propriedade não está presente no modelo, a rota de fallback é desabilitada por padrão. |
|
routes |
A lista de regras de roteamento fornecidas pelo usuário que o Hub IoT usa para rotear mensagens para pontos de extremidade internos e personalizados. No máximo 100 regras de roteamento são permitidas para hubs pagos e um máximo de 5 regras de roteamento são permitidas para hubs gratuitos. |
RoutingServiceBusQueueEndpointProperties
As propriedades relacionadas aos tipos de ponto de extremidade da fila do barramento de serviço.
Nome | Tipo | Description |
---|---|---|
authenticationType |
Método usado para autenticar no ponto de extremidade da fila do barramento de serviço |
|
connectionString |
string |
O cadeia de conexão do ponto de extremidade da fila do barramento de serviço. |
endpointUri |
string |
A URL do ponto de extremidade da fila do barramento de serviço. Ele deve incluir o protocolo sb:// |
entityPath |
string |
Nome da fila no namespace do barramento de serviço |
id |
string |
ID do ponto de extremidade da fila do barramento de serviço |
identity |
Propriedades de identidade gerenciada do ponto de extremidade da fila do barramento de serviço de roteamento. |
|
name |
string |
O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. O nome não precisa ser o mesmo que o nome real da fila. |
resourceGroup |
string |
O nome do grupo de recursos do ponto de extremidade da fila do barramento de serviço. |
subscriptionId |
string |
O identificador de assinatura do ponto de extremidade da fila do barramento de serviço. |
RoutingServiceBusTopicEndpointProperties
As propriedades relacionadas aos tipos de ponto de extremidade do tópico do barramento de serviço.
Nome | Tipo | Description |
---|---|---|
authenticationType |
Método usado para autenticar no ponto de extremidade do tópico do barramento de serviço |
|
connectionString |
string |
O cadeia de conexão do ponto de extremidade do tópico do barramento de serviço. |
endpointUri |
string |
A URL do ponto de extremidade do tópico do barramento de serviço. Ele deve incluir o protocolo sb:// |
entityPath |
string |
Nome da fila no tópico do barramento de serviço |
id |
string |
ID do ponto de extremidade do tópico do barramento de serviço |
identity |
Propriedades de identidade gerenciada do ponto de extremidade do tópico do barramento de serviço de roteamento. |
|
name |
string |
O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. O nome não precisa ser o mesmo que o nome real do tópico. |
resourceGroup |
string |
O nome do grupo de recursos do ponto de extremidade do tópico do barramento de serviço. |
subscriptionId |
string |
O identificador de assinatura do ponto de extremidade do tópico do barramento de serviço. |
RoutingSource
A origem à qual a regra de roteamento deve ser aplicada, como DeviceMessages.
Nome | Tipo | Description |
---|---|---|
DeviceConnectionStateEvents |
string |
|
DeviceJobLifecycleEvents |
string |
|
DeviceLifecycleEvents |
string |
|
DeviceMessages |
string |
|
Invalid |
string |
|
TwinChangeEvents |
string |
RoutingStorageContainerProperties
As propriedades relacionadas a um ponto de extremidade de contêiner de armazenamento.
Nome | Tipo | Description |
---|---|---|
authenticationType |
Método usado para autenticar no ponto de extremidade de armazenamento |
|
batchFrequencyInSeconds |
integer |
Intervalo de tempo no qual os blobs são gravados no armazenamento. O valor deve estar entre 60 e 720 segundos. O valor padrão é 300 segundos. |
connectionString |
string |
O cadeia de conexão da conta de armazenamento. |
containerName |
string |
O nome do contêiner de armazenamento na conta de armazenamento. |
encoding |
enum:
|
Codificação usada para serializar mensagens em blobs. Os valores com suporte são 'avro', 'avrodeflate' e 'JSON'. O valor padrão é 'avro'. |
endpointUri |
string |
A URL do ponto de extremidade de armazenamento. Ele deve incluir o protocolo https:// |
fileNameFormat |
string |
Formato de nome de arquivo para o blob. O formato padrão é {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados. |
id |
string |
Id do ponto de extremidade do contêiner de armazenamento |
identity |
Propriedades de identidade gerenciada do ponto de extremidade de armazenamento de roteamento. |
|
maxChunkSizeInBytes |
integer |
Número máximo de bytes para cada blob gravado no armazenamento. O valor deve estar entre 10485760(10 MB) e 524288000(500 MB). O valor padrão é 314572800(300 MB). |
name |
string |
O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, períodos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. |
resourceGroup |
string |
O nome do grupo de recursos da conta de armazenamento. |
subscriptionId |
string |
O identificador de assinatura da conta de armazenamento. |
SharedAccessSignatureAuthorizationRule
As propriedades de uma política de acesso compartilhado do Hub IoT.
Nome | Tipo | Description |
---|---|---|
keyName |
string |
O nome da política de acesso compartilhado. |
primaryKey |
string |
A chave principal. |
rights |
As permissões atribuídas à política de acesso compartilhado. |
|
secondaryKey |
string |
A chave secundária. |
StorageEndpointProperties
As propriedades do ponto de extremidade do Armazenamento do Azure para upload de arquivo.
Nome | Tipo | Description |
---|---|---|
authenticationType |
Especifica o tipo de autenticação que está sendo usado para se conectar à conta de armazenamento. |
|
connectionString |
string |
O cadeia de conexão para a conta de Armazenamento do Azure na qual os arquivos são carregados. |
containerName |
string |
O nome do contêiner raiz em que você carrega arquivos. O contêiner não precisa existir, mas deve ser cretável usando connectionString especificado. |
identity |
Propriedades de identidade gerenciada do ponto de extremidade de armazenamento para upload de arquivo. |
|
sasTtlAsIso8601 |
string |
O período de tempo para o qual o URI sas gerado por Hub IoT para upload de arquivo é válido. Veja: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. |
systemData
Metadados relativos à criação e à última modificação do recurso.
Nome | Tipo | Description |
---|---|---|
createdAt |
string |
O carimbo de data/hora da criação de recursos (UTC). |
createdBy |
string |
A identidade que criou o recurso. |
createdByType |
O tipo de identidade que criou o recurso. |
|
lastModifiedAt |
string |
O carimbo de data/hora da última modificação do recurso (UTC) |
lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
lastModifiedByType |
O tipo de identidade que modificou o recurso pela última vez. |