broker_authentication

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

Overview

Name	broker_authentication
Type	Resource
Id	azure.iot_operations.broker_authentication

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
authenticationMethods	array	Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported. Required.
extendedLocation	object	Edge location of the resource.
healthState	string	The health state of the resource. Known values are: "Available", "Degraded", "Unavailable", and "Unknown". (Available, Degraded, Unavailable, Unknown)
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
authenticationMethods	array	Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported. Required.
extendedLocation	object	Edge location of the resource.
healthState	string	The health state of the resource. Known values are: "Available", "Degraded", "Unavailable", and "Unknown". (Available, Degraded, Unavailable, Unknown)
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, instance_name, broker_name, authentication_name, subscription_id		Get a BrokerAuthenticationResource.
list_by_resource_group	select	resource_group_name, instance_name, broker_name, subscription_id		List BrokerAuthenticationResource resources by BrokerResource.
create_or_update	insert	resource_group_name, instance_name, broker_name, authentication_name, subscription_id		Create a BrokerAuthenticationResource.
create_or_update	replace	resource_group_name, instance_name, broker_name, authentication_name, subscription_id		Create a BrokerAuthenticationResource.
delete	delete	resource_group_name, instance_name, broker_name, authentication_name, subscription_id		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
authentication_name	string	Name of Instance broker authentication resource. Required.
broker_name	string	Name of broker. Required.
instance_name	string	Name of instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a BrokerAuthenticationResource.

SELECT
id,
name,
authenticationMethods,
extendedLocation,
healthState,
provisioningState,
systemData,
type
FROM azure.iot_operations.broker_authentication
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND instance_name = '{{ instance_name }}' -- required
AND broker_name = '{{ broker_name }}' -- required
AND authentication_name = '{{ authentication_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List BrokerAuthenticationResource resources by BrokerResource.

SELECT
id,
name,
authenticationMethods,
extendedLocation,
healthState,
provisioningState,
systemData,
type
FROM azure.iot_operations.broker_authentication
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND instance_name = '{{ instance_name }}' -- required
AND broker_name = '{{ broker_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a BrokerAuthenticationResource.

INSERT INTO azure.iot_operations.broker_authentication (
properties,
extendedLocation,
resource_group_name,
instance_name,
broker_name,
authentication_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ instance_name }}',
'{{ broker_name }}',
'{{ authentication_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: broker_authentication
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the broker_authentication resource.
  - name: instance_name
    value: "{{ instance_name }}"
    description: Required parameter for the broker_authentication resource.
  - name: broker_name
    value: "{{ broker_name }}"
    description: Required parameter for the broker_authentication resource.
  - name: authentication_name
    value: "{{ authentication_name }}"
    description: Required parameter for the broker_authentication resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the broker_authentication resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      authenticationMethods:
        - method: "{{ method }}"
          customSettings:
            auth:
              x509:
                secretRef: "{{ secretRef }}"
            caCertConfigMap: "{{ caCertConfigMap }}"
            endpoint: "{{ endpoint }}"
            headers: "{{ headers }}"
          serviceAccountTokenSettings:
            audiences:
              - "{{ audiences }}"
          x509Settings:
            authorizationAttributes: "{{ authorizationAttributes }}"
            trustedClientCaCert: "{{ trustedClientCaCert }}"
            additionalValidation: "{{ additionalValidation }}"
      provisioningState: "{{ provisioningState }}"
      healthState: "{{ healthState }}"
  - name: extendedLocation
    description: |
      Edge location of the resource.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

REPLACE examples

create_or_update

Create a BrokerAuthenticationResource.

REPLACE azure.iot_operations.broker_authentication
SET 
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND instance_name = '{{ instance_name }}' --required
AND broker_name = '{{ broker_name }}' --required
AND authentication_name = '{{ authentication_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
properties,
systemData,
type;

DELETE examples

delete

Delete a BrokerAuthenticationResource.

DELETE FROM azure.iot_operations.broker_authentication
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND instance_name = '{{ instance_name }}' --required
AND broker_name = '{{ broker_name }}' --required
AND authentication_name = '{{ authentication_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;