Getting information about a broker
Note
The broker is at the Preview stage.
To find out the ID or name of a broker, get a list of brokers in a folder.
Getting a list of brokers in a folder
- In the management console
, select the folder where you want to get a list of brokers. - Select IoT Core.
- In the left-hand panel, select Brokers. A list of brokers will be displayed on the Brokers page.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID>
command. You can also set a different folder for any specific command using the --folder-name
or --folder-id
parameter.
-
View the description of the CLI command to get a list of brokers:
yc iot broker list --help
-
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.
Getting detailed information about a broker
To access a broker, use the ID or name of the broker from the previous step.
- In the management console
, select the folder where the broker is located. - Select IoT Core.
- In the left-hand panel, select Brokers.
- Select the broker. Detailed information about the broker will be displayed on the Overview page.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID>
command. You can also set a different folder for any specific command using the --folder-name
or --folder-id
parameter.
-
View the description of the CLI command to get information about a broker:
yc iot broker get --help
-
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
Terraform is distributed under the Business Source License
For more information about the provider resources, see the relevant documentation on the Terraform
If you do not have Terraform yet, install it and configure the Yandex Cloud provider.
To get information about a broker using Terraform:
-
Add the
data
andoutput
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 theyandex_iot_core_broker
data source parameters, see the relevant provider documentation . -
Create resources:
-
In the terminal, go to the directory where you edited the configuration file.
-
Make sure the configuration file is correct using this command:
terraform validate
If the configuration is correct, you will get this message:
Success! The configuration is valid.
-
Run this command:
terraform plan
You will see a detailed list of resources. No changes will be made at this step. If the configuration contains any errors, Terraform will show them.
-
Apply the changes:
terraform apply
-
Type
yes
and press Enter to confirm the changes.
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.