broker_authentications

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

Overview

Name	broker_authentications
Type	Resource
Id	azure.iotoperations.broker_authentications

Fields

vw_broker_authentications

Name	Datatype	Description
authenticationName	text	field from the properties object
authentication_methods	text	field from the properties object
brokerName	text	field from the properties object
extended_location	text	field from the properties object
instanceName	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object

broker_authentications

Name	Datatype	Description
extendedLocation	object	Extended location is an extension of Azure locations. They provide a way to use their Azure ARC enabled Kubernetes clusters as target locations for deploying Azure services instances.
properties	object	BrokerAuthentication Resource properties

Methods

Name	Accessible by	Required Params	Description
get	SELECT	authenticationName, brokerName, instanceName, resourceGroupName, subscriptionId	Get a BrokerAuthenticationResource
list_by_resource_group	SELECT	brokerName, instanceName, resourceGroupName, subscriptionId	List BrokerAuthenticationResource resources by BrokerResource
create_or_update	INSERT	authenticationName, brokerName, instanceName, resourceGroupName, subscriptionId, data__extendedLocation	Create a BrokerAuthenticationResource
delete	DELETE	authenticationName, brokerName, instanceName, resourceGroupName, subscriptionId	Delete a BrokerAuthenticationResource

SELECT examples

List BrokerAuthenticationResource resources by BrokerResource

vw_broker_authentications

SELECT
authenticationName,
authentication_methods,
brokerName,
extended_location,
instanceName,
provisioning_state,
resourceGroupName,
subscriptionId
FROM azure.iotoperations.vw_broker_authentications
WHERE brokerName = '{{ brokerName }}'
AND instanceName = '{{ instanceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

broker_authentications

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

INSERT example

Use the following StackQL query and manifest file to create a new broker_authentications resource.

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: authenticationMethods
          value:
            - - name: method
                value: []
              - name: customSettings
                value:
                  - name: auth
                    value:
                      - name: x509
                        value:
                          - name: secretRef
                            value: string
                  - name: caCertConfigMap
                    value: string
                  - name: endpoint
                    value: string
                  - name: headers
                    value: object
              - name: serviceAccountTokenSettings
                value:
                  - name: audiences
                    value:
                      - string
              - name: x509Settings
                value:
                  - name: authorizationAttributes
                    value: object
                  - name: trustedClientCaCert
                    value: string
        - name: provisioningState
          value: []
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: []

DELETE example

Deletes the specified broker_authentications resource.

/*+ delete */
DELETE FROM azure.iotoperations.broker_authentications
WHERE authenticationName = '{{ authenticationName }}'
AND brokerName = '{{ brokerName }}'
AND instanceName = '{{ instanceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';