Getting information about a broker

If you do not have the Yandex Cloud (CLI) command line interface yet, install and initialize it.

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

1. View the description of the CLI command to get a list of brokers:

   yc iot broker list --help
   

2. Get a list of brokers in the default folder:

   yc iot broker list
   

   Result:

   +----------------------+-------------+
   |          ID          |    NAME     |
   +----------------------+-------------+
   | b91ki3851h********** | my-broker   |
   +----------------------+-------------+
   

To get a list of brokers, use the list REST API method for the Broker resource or the BrokerService/List gRPC API call.

If you do not have the Yandex Cloud (CLI) command line interface yet, install and initialize it.

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

1. View the description of the CLI command to get information about a broker:

   yc iot broker get --help
   

2. Get detailed information about a broker by specifying its name or ID:

   yc iot broker get <broker_name>
   

   Result:

   id: b91ki3851h**********
   folder_id: aoek49ghmk**********
   created_at: "2022-05-28T11:29:42.420Z"
   name: my-broker
   

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the documentation on the Terraform website or mirror website.

If you do not have Terraform yet, install it and configure its Yandex Cloud provider.

To get information about a broker using Terraform:

1. Add the data and output sections to the Terraform configuration file:

   data "yandex_iot_core_broker" "my_broker" {
     broker_id = "<broker_ID>"
   }
   
   output "broker_params" {
     value = data.yandex_iot_core_broker.my_broker.created_at
   }
   

   Where:

   • data "yandex_iot_core_broker": Description of the broker as a data source:
     • broker_id: Broker ID.
   • output "broker_params": Output variable that contains information about the broker creation timestamp:
     • value: Returned value.

   You can replace created_at with any other parameter to get the information you need. For more information about the yandex_iot_core_broker data source parameters, see the relevant provider documentation.

2. Create resources:

   1. In the terminal, change to the folder where you edited the configuration file.

   2. Make sure the configuration file is correct using the command:

      terraform validate
      

      If the configuration is correct, the following message is returned:

      Success! The configuration is valid.
      

   3. Run the command:

      terraform plan
      

      The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.

   4. Apply the configuration changes:

      terraform apply
      

   5. Confirm the changes: type yes in the terminal and press Enter.

   Terraform will create the required resources and display the output variable values in the terminal. To check the results, run:

   terraform output
   

   Result:

   broker_params = "2024-05-09T17:39:54Z"
   

To get detailed information about a broker, use the get REST API method for the Broker resource or the BrokerService/Get gRPC API call.