Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. cloudiot
  5. cloudiot/v1
  6. getRegistry

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.cloudiot/v1.getRegistry

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Gets a device registry configuration.

    Using getRegistry

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRegistry(args: GetRegistryArgs, opts?: InvokeOptions): Promise<GetRegistryResult>
function getRegistryOutput(args: GetRegistryOutputArgs, opts?: InvokeOptions): Output<GetRegistryResult>
    def get_registry(location: Optional[str] = None,
                 project: Optional[str] = None,
                 registry_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetRegistryResult
def get_registry_output(location: Optional[pulumi.Input[str]] = None,
                 project: Optional[pulumi.Input[str]] = None,
                 registry_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetRegistryResult]
    func LookupRegistry(ctx *Context, args *LookupRegistryArgs, opts ...InvokeOption) (*LookupRegistryResult, error)
func LookupRegistryOutput(ctx *Context, args *LookupRegistryOutputArgs, opts ...InvokeOption) LookupRegistryResultOutput

    > Note: This function is named LookupRegistry in the Go SDK.

    public static class GetRegistry 
{
    public static Task<GetRegistryResult> InvokeAsync(GetRegistryArgs args, InvokeOptions? opts = null)
    public static Output<GetRegistryResult> Invoke(GetRegistryInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRegistryResult> getRegistry(GetRegistryArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:cloudiot/v1:getRegistry
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Location string
    RegistryId string
    Project string
    Location string
    RegistryId string
    Project string
    location String
    registryId String
    project String
    location string
    registryId string
    project string
    location String
    registryId String
    project String

    getRegistry Result

    The following output properties are available:

    Credentials List<Pulumi.GoogleNative.CloudIoT.V1.Outputs.RegistryCredentialResponse>
    The credentials used to verify the device credentials. No more than 10 credentials can be bound to a single registry at a time. The verification process occurs at the time of device creation or update. If this field is empty, no verification is performed. Otherwise, the credentials of a newly created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified.
    EventNotificationConfigs List<Pulumi.GoogleNative.CloudIoT.V1.Outputs.EventNotificationConfigResponse>
    The configuration for notification of telemetry events received from the device. All telemetry events that were successfully published by the device and acknowledged by Cloud IoT Core are guaranteed to be delivered to Cloud Pub/Sub. If multiple configurations match a message, only the first matching configuration is used. If you try to publish a device telemetry event using MQTT without specifying a Cloud Pub/Sub topic for the device's registry, the connection closes automatically. If you try to do so using an HTTP connection, an error is returned. Up to 10 configurations may be provided.
    HttpConfig Pulumi.GoogleNative.CloudIoT.V1.Outputs.HttpConfigResponse
    The DeviceService (HTTP) configuration for this device registry.
    LogLevel string
    Beta Feature The default logging verbosity for activity from devices in this registry. The verbosity level can be overridden by Device.log_level.
    MqttConfig Pulumi.GoogleNative.CloudIoT.V1.Outputs.MqttConfigResponse
    The MQTT configuration for this device registry.
    Name string
    The resource path name. For example, projects/example-project/locations/us-central1/registries/my-registry.
    StateNotificationConfig Pulumi.GoogleNative.CloudIoT.V1.Outputs.StateNotificationConfigResponse
    The configuration for notification of new states received from the device. State updates are guaranteed to be stored in the state history, but notifications to Cloud Pub/Sub are not guaranteed. For example, if permissions are misconfigured or the specified topic doesn't exist, no notification will be published but the state will still be stored in Cloud IoT Core.
    Credentials []RegistryCredentialResponse
    The credentials used to verify the device credentials. No more than 10 credentials can be bound to a single registry at a time. The verification process occurs at the time of device creation or update. If this field is empty, no verification is performed. Otherwise, the credentials of a newly created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified.
    EventNotificationConfigs []EventNotificationConfigResponse
    The configuration for notification of telemetry events received from the device. All telemetry events that were successfully published by the device and acknowledged by Cloud IoT Core are guaranteed to be delivered to Cloud Pub/Sub. If multiple configurations match a message, only the first matching configuration is used. If you try to publish a device telemetry event using MQTT without specifying a Cloud Pub/Sub topic for the device's registry, the connection closes automatically. If you try to do so using an HTTP connection, an error is returned. Up to 10 configurations may be provided.
    HttpConfig HttpConfigResponse
    The DeviceService (HTTP) configuration for this device registry.
    LogLevel string
    Beta Feature The default logging verbosity for activity from devices in this registry. The verbosity level can be overridden by Device.log_level.
    MqttConfig MqttConfigResponse
    The MQTT configuration for this device registry.
    Name string
    The resource path name. For example, projects/example-project/locations/us-central1/registries/my-registry.
    StateNotificationConfig StateNotificationConfigResponse
    The configuration for notification of new states received from the device. State updates are guaranteed to be stored in the state history, but notifications to Cloud Pub/Sub are not guaranteed. For example, if permissions are misconfigured or the specified topic doesn't exist, no notification will be published but the state will still be stored in Cloud IoT Core.
    credentials List<RegistryCredentialResponse>
    The credentials used to verify the device credentials. No more than 10 credentials can be bound to a single registry at a time. The verification process occurs at the time of device creation or update. If this field is empty, no verification is performed. Otherwise, the credentials of a newly created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified.
    eventNotificationConfigs List<EventNotificationConfigResponse>
    The configuration for notification of telemetry events received from the device. All telemetry events that were successfully published by the device and acknowledged by Cloud IoT Core are guaranteed to be delivered to Cloud Pub/Sub. If multiple configurations match a message, only the first matching configuration is used. If you try to publish a device telemetry event using MQTT without specifying a Cloud Pub/Sub topic for the device's registry, the connection closes automatically. If you try to do so using an HTTP connection, an error is returned. Up to 10 configurations may be provided.
    httpConfig HttpConfigResponse
    The DeviceService (HTTP) configuration for this device registry.
    logLevel String
    Beta Feature The default logging verbosity for activity from devices in this registry. The verbosity level can be overridden by Device.log_level.
    mqttConfig MqttConfigResponse
    The MQTT configuration for this device registry.
    name String
    The resource path name. For example, projects/example-project/locations/us-central1/registries/my-registry.
    stateNotificationConfig StateNotificationConfigResponse
    The configuration for notification of new states received from the device. State updates are guaranteed to be stored in the state history, but notifications to Cloud Pub/Sub are not guaranteed. For example, if permissions are misconfigured or the specified topic doesn't exist, no notification will be published but the state will still be stored in Cloud IoT Core.
    credentials RegistryCredentialResponse[]
    The credentials used to verify the device credentials. No more than 10 credentials can be bound to a single registry at a time. The verification process occurs at the time of device creation or update. If this field is empty, no verification is performed. Otherwise, the credentials of a newly created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified.
    eventNotificationConfigs EventNotificationConfigResponse[]
    The configuration for notification of telemetry events received from the device. All telemetry events that were successfully published by the device and acknowledged by Cloud IoT Core are guaranteed to be delivered to Cloud Pub/Sub. If multiple configurations match a message, only the first matching configuration is used. If you try to publish a device telemetry event using MQTT without specifying a Cloud Pub/Sub topic for the device's registry, the connection closes automatically. If you try to do so using an HTTP connection, an error is returned. Up to 10 configurations may be provided.
    httpConfig HttpConfigResponse
    The DeviceService (HTTP) configuration for this device registry.
    logLevel string
    Beta Feature The default logging verbosity for activity from devices in this registry. The verbosity level can be overridden by Device.log_level.
    mqttConfig MqttConfigResponse
    The MQTT configuration for this device registry.
    name string
    The resource path name. For example, projects/example-project/locations/us-central1/registries/my-registry.
    stateNotificationConfig StateNotificationConfigResponse
    The configuration for notification of new states received from the device. State updates are guaranteed to be stored in the state history, but notifications to Cloud Pub/Sub are not guaranteed. For example, if permissions are misconfigured or the specified topic doesn't exist, no notification will be published but the state will still be stored in Cloud IoT Core.
    credentials Sequence[RegistryCredentialResponse]
    The credentials used to verify the device credentials. No more than 10 credentials can be bound to a single registry at a time. The verification process occurs at the time of device creation or update. If this field is empty, no verification is performed. Otherwise, the credentials of a newly created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified.
    event_notification_configs Sequence[EventNotificationConfigResponse]
    The configuration for notification of telemetry events received from the device. All telemetry events that were successfully published by the device and acknowledged by Cloud IoT Core are guaranteed to be delivered to Cloud Pub/Sub. If multiple configurations match a message, only the first matching configuration is used. If you try to publish a device telemetry event using MQTT without specifying a Cloud Pub/Sub topic for the device's registry, the connection closes automatically. If you try to do so using an HTTP connection, an error is returned. Up to 10 configurations may be provided.
    http_config HttpConfigResponse
    The DeviceService (HTTP) configuration for this device registry.
    log_level str
    Beta Feature The default logging verbosity for activity from devices in this registry. The verbosity level can be overridden by Device.log_level.
    mqtt_config MqttConfigResponse
    The MQTT configuration for this device registry.
    name str
    The resource path name. For example, projects/example-project/locations/us-central1/registries/my-registry.
    state_notification_config StateNotificationConfigResponse
    The configuration for notification of new states received from the device. State updates are guaranteed to be stored in the state history, but notifications to Cloud Pub/Sub are not guaranteed. For example, if permissions are misconfigured or the specified topic doesn't exist, no notification will be published but the state will still be stored in Cloud IoT Core.
    credentials List<Property Map>
    The credentials used to verify the device credentials. No more than 10 credentials can be bound to a single registry at a time. The verification process occurs at the time of device creation or update. If this field is empty, no verification is performed. Otherwise, the credentials of a newly created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified.
    eventNotificationConfigs List<Property Map>
    The configuration for notification of telemetry events received from the device. All telemetry events that were successfully published by the device and acknowledged by Cloud IoT Core are guaranteed to be delivered to Cloud Pub/Sub. If multiple configurations match a message, only the first matching configuration is used. If you try to publish a device telemetry event using MQTT without specifying a Cloud Pub/Sub topic for the device's registry, the connection closes automatically. If you try to do so using an HTTP connection, an error is returned. Up to 10 configurations may be provided.
    httpConfig Property Map
    The DeviceService (HTTP) configuration for this device registry.
    logLevel String
    Beta Feature The default logging verbosity for activity from devices in this registry. The verbosity level can be overridden by Device.log_level.
    mqttConfig Property Map
    The MQTT configuration for this device registry.
    name String
    The resource path name. For example, projects/example-project/locations/us-central1/registries/my-registry.
    stateNotificationConfig Property Map
    The configuration for notification of new states received from the device. State updates are guaranteed to be stored in the state history, but notifications to Cloud Pub/Sub are not guaranteed. For example, if permissions are misconfigured or the specified topic doesn't exist, no notification will be published but the state will still be stored in Cloud IoT Core.

    Supporting Types

    EventNotificationConfigResponse

    PubsubTopicName string
    A Cloud Pub/Sub topic name. For example, projects/myProject/topics/deviceEvents.
    SubfolderMatches string
    If the subfolder name matches this string exactly, this configuration will be used. The string must not include the leading '/' character. If empty, all strings are matched. This field is used only for telemetry events; subfolders are not supported for state changes.
    PubsubTopicName string
    A Cloud Pub/Sub topic name. For example, projects/myProject/topics/deviceEvents.
    SubfolderMatches string
    If the subfolder name matches this string exactly, this configuration will be used. The string must not include the leading '/' character. If empty, all strings are matched. This field is used only for telemetry events; subfolders are not supported for state changes.
    pubsubTopicName String
    A Cloud Pub/Sub topic name. For example, projects/myProject/topics/deviceEvents.
    subfolderMatches String
    If the subfolder name matches this string exactly, this configuration will be used. The string must not include the leading '/' character. If empty, all strings are matched. This field is used only for telemetry events; subfolders are not supported for state changes.
    pubsubTopicName string
    A Cloud Pub/Sub topic name. For example, projects/myProject/topics/deviceEvents.
    subfolderMatches string
    If the subfolder name matches this string exactly, this configuration will be used. The string must not include the leading '/' character. If empty, all strings are matched. This field is used only for telemetry events; subfolders are not supported for state changes.
    pubsub_topic_name str
    A Cloud Pub/Sub topic name. For example, projects/myProject/topics/deviceEvents.
    subfolder_matches str
    If the subfolder name matches this string exactly, this configuration will be used. The string must not include the leading '/' character. If empty, all strings are matched. This field is used only for telemetry events; subfolders are not supported for state changes.
    pubsubTopicName String
    A Cloud Pub/Sub topic name. For example, projects/myProject/topics/deviceEvents.
    subfolderMatches String
    If the subfolder name matches this string exactly, this configuration will be used. The string must not include the leading '/' character. If empty, all strings are matched. This field is used only for telemetry events; subfolders are not supported for state changes.

    HttpConfigResponse

    HttpEnabledState string
    If enabled, allows devices to use DeviceService via the HTTP protocol. Otherwise, any requests to DeviceService will fail for this registry.
    HttpEnabledState string
    If enabled, allows devices to use DeviceService via the HTTP protocol. Otherwise, any requests to DeviceService will fail for this registry.
    httpEnabledState String
    If enabled, allows devices to use DeviceService via the HTTP protocol. Otherwise, any requests to DeviceService will fail for this registry.
    httpEnabledState string
    If enabled, allows devices to use DeviceService via the HTTP protocol. Otherwise, any requests to DeviceService will fail for this registry.
    http_enabled_state str
    If enabled, allows devices to use DeviceService via the HTTP protocol. Otherwise, any requests to DeviceService will fail for this registry.
    httpEnabledState String
    If enabled, allows devices to use DeviceService via the HTTP protocol. Otherwise, any requests to DeviceService will fail for this registry.

    MqttConfigResponse

    MqttEnabledState string
    If enabled, allows connections using the MQTT protocol. Otherwise, MQTT connections to this registry will fail.
    MqttEnabledState string
    If enabled, allows connections using the MQTT protocol. Otherwise, MQTT connections to this registry will fail.
    mqttEnabledState String
    If enabled, allows connections using the MQTT protocol. Otherwise, MQTT connections to this registry will fail.
    mqttEnabledState string
    If enabled, allows connections using the MQTT protocol. Otherwise, MQTT connections to this registry will fail.
    mqtt_enabled_state str
    If enabled, allows connections using the MQTT protocol. Otherwise, MQTT connections to this registry will fail.
    mqttEnabledState String
    If enabled, allows connections using the MQTT protocol. Otherwise, MQTT connections to this registry will fail.

    PublicKeyCertificateResponse

    Certificate string
    The certificate data.
    Format string
    The certificate format.
    X509Details Pulumi.GoogleNative.CloudIoT.V1.Inputs.X509CertificateDetailsResponse
    [Output only] The certificate details. Used only for X.509 certificates.
    Certificate string
    The certificate data.
    Format string
    The certificate format.
    X509Details X509CertificateDetailsResponse
    [Output only] The certificate details. Used only for X.509 certificates.
    certificate String
    The certificate data.
    format String
    The certificate format.
    x509Details X509CertificateDetailsResponse
    [Output only] The certificate details. Used only for X.509 certificates.
    certificate string
    The certificate data.
    format string
    The certificate format.
    x509Details X509CertificateDetailsResponse
    [Output only] The certificate details. Used only for X.509 certificates.
    certificate str
    The certificate data.
    format str
    The certificate format.
    x509_details X509CertificateDetailsResponse
    [Output only] The certificate details. Used only for X.509 certificates.
    certificate String
    The certificate data.
    format String
    The certificate format.
    x509Details Property Map
    [Output only] The certificate details. Used only for X.509 certificates.

    RegistryCredentialResponse

    PublicKeyCertificate Pulumi.GoogleNative.CloudIoT.V1.Inputs.PublicKeyCertificateResponse
    A public key certificate used to verify the device credentials.
    PublicKeyCertificate PublicKeyCertificateResponse
    A public key certificate used to verify the device credentials.
    publicKeyCertificate PublicKeyCertificateResponse
    A public key certificate used to verify the device credentials.
    publicKeyCertificate PublicKeyCertificateResponse
    A public key certificate used to verify the device credentials.
    public_key_certificate PublicKeyCertificateResponse
    A public key certificate used to verify the device credentials.
    publicKeyCertificate Property Map
    A public key certificate used to verify the device credentials.

    StateNotificationConfigResponse

    PubsubTopicName string
    A Cloud Pub/Sub topic name. For example, projects/myProject/topics/deviceEvents.
    PubsubTopicName string
    A Cloud Pub/Sub topic name. For example, projects/myProject/topics/deviceEvents.
    pubsubTopicName String
    A Cloud Pub/Sub topic name. For example, projects/myProject/topics/deviceEvents.
    pubsubTopicName string
    A Cloud Pub/Sub topic name. For example, projects/myProject/topics/deviceEvents.
    pubsub_topic_name str
    A Cloud Pub/Sub topic name. For example, projects/myProject/topics/deviceEvents.
    pubsubTopicName String
    A Cloud Pub/Sub topic name. For example, projects/myProject/topics/deviceEvents.

    X509CertificateDetailsResponse

    ExpiryTime string
    The time the certificate becomes invalid.
    Issuer string
    The entity that signed the certificate.
    PublicKeyType string
    The type of public key in the certificate.
    SignatureAlgorithm string
    The algorithm used to sign the certificate.
    StartTime string
    The time the certificate becomes valid.
    Subject string
    The entity the certificate and public key belong to.
    ExpiryTime string
    The time the certificate becomes invalid.
    Issuer string
    The entity that signed the certificate.
    PublicKeyType string
    The type of public key in the certificate.
    SignatureAlgorithm string
    The algorithm used to sign the certificate.
    StartTime string
    The time the certificate becomes valid.
    Subject string
    The entity the certificate and public key belong to.
    expiryTime String
    The time the certificate becomes invalid.
    issuer String
    The entity that signed the certificate.
    publicKeyType String
    The type of public key in the certificate.
    signatureAlgorithm String
    The algorithm used to sign the certificate.
    startTime String
    The time the certificate becomes valid.
    subject String
    The entity the certificate and public key belong to.
    expiryTime string
    The time the certificate becomes invalid.
    issuer string
    The entity that signed the certificate.
    publicKeyType string
    The type of public key in the certificate.
    signatureAlgorithm string
    The algorithm used to sign the certificate.
    startTime string
    The time the certificate becomes valid.
    subject string
    The entity the certificate and public key belong to.
    expiry_time str
    The time the certificate becomes invalid.
    issuer str
    The entity that signed the certificate.
    public_key_type str
    The type of public key in the certificate.
    signature_algorithm str
    The algorithm used to sign the certificate.
    start_time str
    The time the certificate becomes valid.
    subject str
    The entity the certificate and public key belong to.
    expiryTime String
    The time the certificate becomes invalid.
    issuer String
    The entity that signed the certificate.
    publicKeyType String
    The type of public key in the certificate.
    signatureAlgorithm String
    The algorithm used to sign the certificate.
    startTime String
    The time the certificate becomes valid.
    subject String
    The entity the certificate and public key belong to.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native