brokers

Creates, updates, deletes, gets or lists a brokers resource.

Overview

Name	brokers
Type	Resource
Id	azure.iotoperations.brokers

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	Edge location of the resource.
properties	object	The resource-specific properties for this resource.

list_by_resource_group

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	Edge location of the resource.
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, instanceName, brokerName		Get a BrokerResource
list_by_resource_group	select	subscriptionId, resourceGroupName, instanceName		List BrokerResource resources by InstanceResource
create_or_update	insert	subscriptionId, resourceGroupName, instanceName, brokerName, data__extendedLocation		Create a BrokerResource
delete	delete	subscriptionId, resourceGroupName, instanceName, brokerName		Delete a BrokerResource

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
brokerName	string	Name of broker.
instanceName	string	Name of instance.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get a BrokerResource

SELECT
extendedLocation,
properties
FROM azure.iotoperations.brokers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND instanceName = '{{ instanceName }}' -- required
AND brokerName = '{{ brokerName }}' -- required
;

list_by_resource_group

List BrokerResource resources by InstanceResource

SELECT
extendedLocation,
properties
FROM azure.iotoperations.brokers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND instanceName = '{{ instanceName }}' -- required
;

INSERT examples

create_or_update

Create a BrokerResource

INSERT INTO azure.iotoperations.brokers (
data__properties,
data__extendedLocation,
subscriptionId,
resourceGroupName,
instanceName,
brokerName
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ instanceName }}',
'{{ brokerName }}'
RETURNING
extendedLocation,
properties
;

Manifest

# Description fields are for documentation purposes
- name: brokers
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the brokers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the brokers resource.
    - name: instanceName
      value: string
      description: Required parameter for the brokers resource.
    - name: brokerName
      value: string
      description: Required parameter for the brokers resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: extendedLocation
      value: object
      description: |
        Edge location of the resource.

DELETE examples

delete

Delete a BrokerResource

DELETE FROM azure.iotoperations.brokers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND instanceName = '{{ instanceName }}' --required
AND brokerName = '{{ brokerName }}' --required
;