Class ConnectorFileMountSettings

Namespace

Azure.Iot.Operations.Connector.ConnectorConfigurations

Assembly

Azure.Iot.Operations.Connector.dll

public class ConnectorFileMountSettings

Inheritance

object

ConnectorFileMountSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

AdditionalConnectorConfigFileName

public const string AdditionalConnectorConfigFileName = "ADDITIONAL_CONNECTOR_CONFIGURATION"

Field Value

string

AzureExtensionResourceIdEnvVar

public const string AzureExtensionResourceIdEnvVar = "AZURE_EXTENSION_RESOURCEID"

Field Value

string

BrokerSatMountPathEnvVar

public const string BrokerSatMountPathEnvVar = "BROKER_SAT_MOUNT_PATH"

Field Value

string

BrokerTrustBundleMountPathEnvVar

public const string BrokerTrustBundleMountPathEnvVar = "BROKER_TLS_TRUST_BUNDLE_CACERT_MOUNT_PATH"

Field Value

string

ConnectorAioMetadataFileName

public const string ConnectorAioMetadataFileName = "AIO_METADATA"

Field Value

string

ConnectorClientIdEnvVar

public const string ConnectorClientIdEnvVar = "CONNECTOR_ID"

Field Value

string

ConnectorConfigMountPathEnvVar

public const string ConnectorConfigMountPathEnvVar = "CONNECTOR_CONFIGURATION_MOUNT_PATH"

Field Value

string

ConnectorDiagnosticsConfigFileName

public const string ConnectorDiagnosticsConfigFileName = "DIAGNOSTICS"

Field Value

string

ConnectorMqttConfigFileName

public const string ConnectorMqttConfigFileName = "MQTT_CONNECTION_CONFIGURATION"

Field Value

string

ConnectorNamespaceEnvVar

public const string ConnectorNamespaceEnvVar = "CONNECTOR_NAMESPACE"

Field Value

string

ConnectorSecretsMetadataMountPathEnvVar

public const string ConnectorSecretsMetadataMountPathEnvVar = "CONNECTOR_SECRETS_METADATA_MOUNT_PATH"

Field Value

string

ConnectorTrustSettingsMountPathEnvVar

public const string ConnectorTrustSettingsMountPathEnvVar = "CONNECTOR_TRUST_SETTINGS_MOUNT_PATH"

Field Value

string

DeviceEndpointCredentialsMountPathEnvVar

public const string DeviceEndpointCredentialsMountPathEnvVar = "DEVICE_ENDPOINT_CREDENTIALS_MOUNT_PATH"

Field Value

string

DeviceEndpointTrustBundleMountPathEnvVar

public const string DeviceEndpointTrustBundleMountPathEnvVar = "DEVICE_ENDPOINT_TLS_TRUST_BUNDLE_CA_CERT_MOUNT_PATH"

Field Value

string

FirstPartyGrpcLogCollectorCaPathEnvVar

public const string FirstPartyGrpcLogCollectorCaPathEnvVar = "FIRST_PARTY_OTLP_GRPC_LOG_COLLECTOR_CA_PATH"

Field Value

string

FirstPartyGrpcMetricsCollectorCaPathEnvVar

public const string FirstPartyGrpcMetricsCollectorCaPathEnvVar = "FIRST_PARTY_OTLP_GRPC_METRICS_COLLECTOR_CA_PATH"

Field Value

string

OtlpGrpcLogEndpointEnvVar

public const string OtlpGrpcLogEndpointEnvVar = "OTLP_GRPC_LOG_ENDPOINT"

Field Value

string

OtlpGrpcMetricEndpointEnvVar

public const string OtlpGrpcMetricEndpointEnvVar = "OTLP_GRPC_METRIC_ENDPOINT"

Field Value

string

OtlpGrpcTraceEndpointEnvVar

public const string OtlpGrpcTraceEndpointEnvVar = "OTLP_GRPC_TRACE_ENDPOINT"

Field Value

string

OtlpHttpLogEndpointEnvVar

public const string OtlpHttpLogEndpointEnvVar = "OTLP_HTTP_LOG_ENDPOINT"

Field Value

string

OtlpHttpMetricEndpointEnvVar

public const string OtlpHttpMetricEndpointEnvVar = "OTLP_HTTP_METRIC_ENDPOINT"

Field Value

string

OtlpHttpTraceEndpointEnvVar

public const string OtlpHttpTraceEndpointEnvVar = "OTLP_HTTP_TRACE_ENDPOINT"

Field Value

string

PersistentVolumeMountPathFileName

public const string PersistentVolumeMountPathFileName = "PERSISTENT_VOLUME_MOUNT_PATH"

Field Value

string

Methods

FromFileMount()

Create an instance of MqttConnectionSettings using the files mounted when this connector was deployed.

public static MqttConnectionSettings FromFileMount()

Returns

MqttConnectionSettings

The instance of MqttConnectionSettings that allows the connector to connect to the MQTT broker.

GetAdditionalConfiguration()

Get the additional configuration JSON string from the connector configuration mount.

public static string? GetAdditionalConfiguration()

Returns

string

The additional configuration as a JSON string, or null if not configured.

GetAioMetadata()

Get the AIO Metadata from the connector configuration mount.

public static AioMetadata GetAioMetadata()

Returns

AioMetadata

The AIO Metadata.

GetAzureExtensionResourceId()

Get the Azure Extension Resource ID from the environment.

public static string GetAzureExtensionResourceId()

Returns

string

The Azure Extension Resource ID.

GetBrokerSatMountPath()

Get the Broker SAT mount path from the environment.

public static string? GetBrokerSatMountPath()

Returns

string

The path to the broker SAT mount, or null if not configured.

Exceptions

InvalidOperationException

Thrown when the path is configured but does not exist.

GetBrokerTrustBundleMountPath()

Get the Broker Trust Bundle mount path from the environment.

public static string? GetBrokerTrustBundleMountPath()

Returns

string

The path to the broker trust bundle mount, or null if not configured.

Exceptions

InvalidOperationException

Thrown when the path is configured but does not exist.

GetConnectorDiagnostics()

Get the Connector Diagnostics configuration from the connector configuration mount.

public static ConnectorDiagnostics GetConnectorDiagnostics()

Returns

ConnectorDiagnostics

The Connector Diagnostics configuration.

GetConnectorId()

Get the Connector ID from the environment.

public static string GetConnectorId()

Returns

string

The Connector ID.

GetConnectorNamespace()

Get the Connector Namespace from the environment.

public static string GetConnectorNamespace()

Returns

string

The Connector Namespace.

GetConnectorSecretsMetadataMountPath()

Get the Connector Secrets Metadata mount path from the environment.

public static string? GetConnectorSecretsMetadataMountPath()

Returns

string

The path to the connector secrets metadata mount, or null if not configured.

Exceptions

InvalidOperationException

Thrown when the path is configured but does not exist.

GetConnectorTrustSettingsMountPath()

Get the Connector Trust Settings mount path from the environment.

public static string? GetConnectorTrustSettingsMountPath()

Returns

string

The path to the connector trust settings mount, or null if not configured.

Exceptions

InvalidOperationException

Thrown when the path is configured but does not exist.

GetDeviceEndpointCredentialsMountPath()

Get the Device Endpoint Credentials mount path from the environment.

public static string? GetDeviceEndpointCredentialsMountPath()

Returns

string

The path to the device endpoint credentials mount, or null if not configured.

Exceptions

InvalidOperationException

Thrown when the path is configured but does not exist.

GetDeviceEndpointTrustBundleMountPath()

Get the Device Endpoint Trust Bundle mount path from the environment.

public static string? GetDeviceEndpointTrustBundleMountPath()

Returns

string

The path to the device endpoint trust bundle mount, or null if not configured.

Exceptions

InvalidOperationException

Thrown when the path is configured but does not exist.

GetGrpcLogCollector1pCaMount()

Get the first-party gRPC log collector CA mount path from the environment.

public static string? GetGrpcLogCollector1pCaMount()

Returns

string

The path to the first-party gRPC log collector CA mount, or null if not configured.

Exceptions

InvalidOperationException

Thrown when the path is configured but does not exist.

GetGrpcLogEndpoint()

Get the OTLP gRPC log endpoint from the environment.

public static string? GetGrpcLogEndpoint()

Returns

string

The OTLP gRPC log endpoint, or null if not configured.

GetGrpcMetricCollector1pCaMount()

Get the first-party gRPC metrics collector CA mount path from the environment.

public static string? GetGrpcMetricCollector1pCaMount()

Returns

string

The path to the first-party gRPC metrics collector CA mount, or null if not configured.

Exceptions

InvalidOperationException

Thrown when the path is configured but does not exist.

GetGrpcMetricEndpoint()

Get the OTLP gRPC metric endpoint from the environment.

public static string? GetGrpcMetricEndpoint()

Returns

string

The OTLP gRPC metric endpoint, or null if not configured.

GetGrpcTraceEndpoint()

Get the OTLP gRPC trace endpoint from the environment.

public static string? GetGrpcTraceEndpoint()

Returns

string

The OTLP gRPC trace endpoint, or null if not configured.

GetHttpLogEndpoint()

Get the OTLP HTTP log endpoint from the environment.

public static string? GetHttpLogEndpoint()

Returns

string

The OTLP HTTP log endpoint, or null if not configured.

GetHttpMetricEndpoint()

Get the OTLP HTTP metric endpoint from the environment.

public static string? GetHttpMetricEndpoint()

Returns

string

The OTLP HTTP metric endpoint, or null if not configured.

GetHttpTraceEndpoint()

Get the OTLP HTTP trace endpoint from the environment.

public static string? GetHttpTraceEndpoint()

Returns

string

The OTLP HTTP trace endpoint, or null if not configured.

GetMqttConnectionConfiguration()

Get the MQTT Connection Configuration from the connector configuration mount.

public static ConnectorMqttConnectionConfiguration GetMqttConnectionConfiguration()

Returns

ConnectorMqttConnectionConfiguration

The MQTT Connection Configuration.

GetPersistentVolumes()

Get the list of persistent volumes from the connector configuration mount.

public static List<string> GetPersistentVolumes()

Returns

List<string>

A list of persistent volume mount paths.