broker_authentications

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

Overview

Name	broker_authentications
Type	Resource
Id	azure.iotoperations.broker_authentications

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, authenticationName		Get a BrokerAuthenticationResource
list_by_resource_group	select	subscriptionId, resourceGroupName, instanceName, brokerName		List BrokerAuthenticationResource resources by BrokerResource
create_or_update	insert	subscriptionId, resourceGroupName, instanceName, brokerName, authenticationName, data__extendedLocation		Create a BrokerAuthenticationResource
delete	delete	subscriptionId, resourceGroupName, instanceName, brokerName, authenticationName		Delete a BrokerAuthenticationResource

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
authenticationName	string	Name of Instance broker authentication resource
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 BrokerAuthenticationResource

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

list_by_resource_group

List BrokerAuthenticationResource resources by BrokerResource

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

INSERT examples

create_or_update

Create a BrokerAuthenticationResource

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

Manifest

# Description fields are for documentation purposes
- name: broker_authentications
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the broker_authentications resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the broker_authentications resource.
    - name: instanceName
      value: string
      description: Required parameter for the broker_authentications resource.
    - name: brokerName
      value: string
      description: Required parameter for the broker_authentications resource.
    - name: authenticationName
      value: string
      description: Required parameter for the broker_authentications 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 BrokerAuthenticationResource

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