Aracılığıyla paylaş

IoTHubConfigurationManager Sınıf

  • Başvuru

Otomatik olarak oluşturulan IotHub REST API'lerini temel alarak IoTHub Configuration Manager işlemleri için kullanışlı API'ler sağlayan bir sınıf

Configuration Manager Hizmeti istemcisi için başlatıcı.

Başarılı bir oluşturma işleminden sonra sınıfın kimliği IoTHub ile doğrulanır ve IoTHub ile iletişim kurmak için üye API'leri çağırmaya hazır olur.

Devralma
builtins.object
IoTHubConfigurationManager

Oluşturucu

IoTHubConfigurationManager(connection_string=None, host=None, auth=None)

Parametreler

Name Description
connection_string
str

connection_str kimlik doğrulaması kullanıyorsak IoTHub ile bağlantının kimliğini doğrulamak için kullanılan IoTHub bağlantı dizesi. Varsayılan değer: Yok

varsayılan değer: None
host
str

Belirteç kimlik bilgisi kimlik doğrulaması kullanıyorsak Azure hizmeti URL'si. Varsayılan değer: Yok

varsayılan değer: None
auth
str

Belirteç kimlik bilgisi kimlik doğrulaması kullanıyorsak Azure kimlik doğrulama nesnesi. Varsayılan değer: Yok

varsayılan değer: None

Yöntemler

apply_configuration_on_edge_device

Sağlanan yapılandırma içeriğini belirtilen uç cihazına uygular. Modül içeriği zorunludur.
create_configuration

IoTHub'ın cihazları veya modülleri için bir yapılandırma oluşturur.
delete_configuration

IoTHub'dan yapılandırmayı siler.
from_connection_string

IoTHubConfigurationManager Hizmeti istemcisi için Classmethod başlatıcısı. Bağlantı dizesinden IoTHubConfigurationManager sınıfı oluşturur.

Başarılı bir oluşturma işleminden sonra sınıfın kimliği IoTHub ile doğrulanır ve IoTHub ile iletişim kurmak için üye API'leri çağırmaya hazır olur.
from_token_credential

IoTHubConfigurationManager Hizmeti istemcisi için Classmethod başlatıcısı. Ana bilgisayar adı URL'si ve Azure belirteci kimlik bilgisinden IoTHubConfigurationManager sınıfı oluşturur.

Başarılı bir oluşturma işleminden sonra sınıfın kimliği IoTHub ile doğrulanır ve IoTHub ile iletişim kurmak için üye API'leri çağırmaya hazır olur.
get_configuration

Belirli bir cihaz için IoTHub yapılandırmasını alır.
get_configurations

IoTHub'ın cihaz ve modülleri için birden çok yapılandırma alır. Belirtilen sayıda yapılandırma döndürür. Sayfalandırma desteklenmez.
test_configuration_queries

Yapılandırma için hedef koşul sorgusunu ve özel ölçüm sorgularını doğrular.
update_configuration

IoTHub'ın cihazları veya modülleri için yapılandırma Güncelleştirmeler. Not: Yapılandırma kimliği ve İçerik kullanıcı tarafından güncelleştirilemez.

apply_configuration_on_edge_device

Sağlanan yapılandırma içeriğini belirtilen uç cihazına uygular. Modül içeriği zorunludur.

apply_configuration_on_edge_device(device_id, configuration_content)

Parametreler

Name Description
configuration_content
Gerekli
ConfigurationContent

Uç cihazın adı (Kimlik).
device_id
Gerekli

Döndürülenler

Tür Description

Bir nesne.

Özel durumlar

Tür Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_configuration

IoTHub'ın cihazları veya modülleri için bir yapılandırma oluşturur.

create_configuration(configuration)

Parametreler

Name Description
configuration_id
Gerekli
str

Yapılandırmanın kimliği.
configuration
Gerekli
Configuration

Oluşturulacak yapılandırma.

Döndürülenler

Tür Description

Oluşturulan yapılandırmayı içeren yapılandırma nesnesi.

Özel durumlar

Tür Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

delete_configuration

IoTHub'dan yapılandırmayı siler.

delete_configuration(configuration_id, etag=None)

Parametreler

Name Description
configuration_id
Gerekli
str

Yapılandırmanın kimliği.
configuration
Gerekli
Configuration

Oluşturulacak yapılandırma.
etag
str

Silme işlemi için kullanılacak etag (if_match) değeri.

varsayılan değer: None

Döndürülenler

Tür Description

Güncelleştirilmiş yapılandırmayı içeren yapılandırma nesnesi.

Özel durumlar

Tür Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_connection_string

IoTHubConfigurationManager Hizmeti istemcisi için Classmethod başlatıcısı. Bağlantı dizesinden IoTHubConfigurationManager sınıfı oluşturur.

Başarılı bir oluşturma işleminden sonra sınıfın kimliği IoTHub ile doğrulanır ve IoTHub ile iletişim kurmak için üye API'leri çağırmaya hazır olur.

from_connection_string(connection_string)

Parametreler

Name Description
connection_string
Gerekli
str

IoTHub ile bağlantı kimliğini doğrulamak için kullanılan IoTHub bağlantı dizesi.

Döndürülenler

Tür Description
IoTHubConfigurationManager

Özel durumlar

Tür Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_token_credential

IoTHubConfigurationManager Hizmeti istemcisi için Classmethod başlatıcısı. Ana bilgisayar adı URL'si ve Azure belirteci kimlik bilgisinden IoTHubConfigurationManager sınıfı oluşturur.

Başarılı bir oluşturma işleminden sonra sınıfın kimliği IoTHub ile doğrulanır ve IoTHub ile iletişim kurmak için üye API'leri çağırmaya hazır olur.

from_token_credential(url, token_credential)

Parametreler

Name Description
url
Gerekli
str

Azure hizmet URL'si (ana bilgisayar adı).
token_credential
Gerekli
<xref:azure.core.TokenCredential>

Azure belirteci kimlik bilgisi nesnesi

Döndürülenler

Tür Description
IoTHubConfigurationManager

Özel durumlar

Tür Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_configuration

Belirli bir cihaz için IoTHub yapılandırmasını alır.

get_configuration(configuration_id)

Parametreler

Name Description
configuration_id
Gerekli
str

Yapılandırmanın kimliği.

Döndürülenler

Tür Description

Configuration nesnesi.

Özel durumlar

Tür Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_configurations

IoTHub'ın cihaz ve modülleri için birden çok yapılandırma alır. Belirtilen sayıda yapılandırma döndürür. Sayfalandırma desteklenmez.

get_configurations(max_count=None)

Parametreler

Name Description
max_count
int

İstenen en fazla yapılandırma sayısı.

varsayılan değer: None

Döndürülenler

Tür Description

List[Configuration] nesnesi.

Özel durumlar

Tür Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

test_configuration_queries

Yapılandırma için hedef koşul sorgusunu ve özel ölçüm sorgularını doğrular.

test_configuration_queries(configuration_queries_test_input)

Parametreler

Name Description
configuration_queries_test_input
Gerekli
ConfigurationQueriesTestInput

Sorgular girişi test etti.

Döndürülenler

Tür Description

ConfigurationQueriesTestResponse nesnesi.

Özel durumlar

Tür Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_configuration

IoTHub'ın cihazları veya modülleri için yapılandırma Güncelleştirmeler. Not: Yapılandırma kimliği ve İçerik kullanıcı tarafından güncelleştirilemez.

update_configuration(configuration, etag)

Parametreler

Name Description
configuration_id
Gerekli
str

Yapılandırmanın kimliği.
configuration
Gerekli
Configuration

Yapılandırma, güncelleştirilmiş yapılandırmayı içerir.
etag
Gerekli
str

Güncelleştirme işlemi için kullanılacak etag (if_match) değeri.

Döndürülenler

Tür Description

Güncelleştirilmiş yapılandırmayı içeren yapılandırma nesnesi.

Özel durumlar

Tür Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>