ConnectionString class

Pacote:

azure-iot-common

Descreve os parâmetros que permitem que um dispositivo ou aplicativo de nuvem se conecte a um hub IoT do Azure.

Propriedades

DeviceId	Identificador de dispositivo exclusivo tal como existe no registo de identidade do dispositivo. Isso é usado apenas para cadeias de conexão de dispositivo.
GatewayHostName	Endereço IP ou nome da Internet da máquina host que funciona como um dispositivo ou gateway de protocolo. Usado ao se comunicar com dispositivos de Borda do Azure.
HostName	Nome do host do hub IoT do Azure.
ModuleId	Identificador de módulo exclusivo tal como existe no registo de identidade do dispositivo. Isso é usado apenas para cadeias de conexão de dispositivo.
SharedAccessKey	Chave simétrica usada para criar tokens de assinatura de acesso compartilhado que, por sua vez, são usados para autenticar a conexão. Associado a um dispositivo específico ou a uma política de serviço específica.
SharedAccessKeyName	Nome da política de acesso usada para se conectar ao hub IoT do Azure. usado apenas no caso do SDK do serviço, não usado com o SDK do dispositivo (que usa DeviceId em vez disso).
SharedAccessSignature	Uma assinatura de acesso compartilhado que encapsula permissões de "conexão de dispositivo" em um hub IoT.
x509	Essa propriedade só existe se um dispositivo usa certificados x509 para autenticação e, se existir, será definida como True.

Métodos

parse(string, string[])

Analisa uma cadeia de caracteres e retorna o objeto ConnectionString correspondente.

Detalhes de Propriedade

DeviceId

Identificador de dispositivo exclusivo tal como existe no registo de identidade do dispositivo. Isso é usado apenas para cadeias de conexão de dispositivo.

DeviceId?: string

Valor de Propriedade

string

GatewayHostName

Endereço IP ou nome da Internet da máquina host que funciona como um dispositivo ou gateway de protocolo. Usado ao se comunicar com dispositivos de Borda do Azure.

GatewayHostName?: string

Valor de Propriedade

string

HostName

Nome do host do hub IoT do Azure.

HostName?: string

Valor de Propriedade

string

ModuleId

Identificador de módulo exclusivo tal como existe no registo de identidade do dispositivo. Isso é usado apenas para cadeias de conexão de dispositivo.

ModuleId?: string

Valor de Propriedade

string

SharedAccessKey

Chave simétrica usada para criar tokens de assinatura de acesso compartilhado que, por sua vez, são usados para autenticar a conexão. Associado a um dispositivo específico ou a uma política de serviço específica.

SharedAccessKey?: string

Valor de Propriedade

string

SharedAccessKeyName

Nome da política de acesso usada para se conectar ao hub IoT do Azure. usado apenas no caso do SDK do serviço, não usado com o SDK do dispositivo (que usa DeviceId em vez disso).

SharedAccessKeyName?: string

Valor de Propriedade

string

SharedAccessSignature

Uma assinatura de acesso compartilhado que encapsula permissões de "conexão de dispositivo" em um hub IoT.

SharedAccessSignature?: string

Valor de Propriedade

string

x509

Essa propriedade só existe se um dispositivo usa certificados x509 para autenticação e, se existir, será definida como True.

x509?: string

Valor de Propriedade

string

Detalhes de Método

parse(string, string[])

Analisa uma cadeia de caracteres e retorna o objeto ConnectionString correspondente.

static function parse(source: string, requiredFields?: string[]): ConnectionString

Parâmetros

source

string

string da qual a cadeia de conexão será extraída

requiredFields

string[]

matriz de cadeias de caracteres listando os campos que se espera que sejam encontrados.

Devoluções

ConnectionString