broker_listeners

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

Overview

Name	broker_listeners
Type	Resource
Id	azure.iotoperations.broker_listeners

Fields

vw_broker_listeners

Name	Datatype	Description
brokerName	text	field from the properties object
extended_location	text	field from the properties object
instanceName	text	field from the properties object
listenerName	text	field from the properties object
ports	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
service_name	text	field from the properties object
service_type	text	field from the properties object
subscriptionId	text	field from the properties object

broker_listeners

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	Defines a Broker listener. A listener is a collection of ports on which the broker accepts connections from clients.

Methods

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

SELECT examples

List BrokerListenerResource resources by BrokerResource

vw_broker_listeners

SELECT
brokerName,
extended_location,
instanceName,
listenerName,
ports,
provisioning_state,
resourceGroupName,
service_name,
service_type,
subscriptionId
FROM azure.iotoperations.vw_broker_listeners
WHERE brokerName = '{{ brokerName }}'
AND instanceName = '{{ instanceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

broker_listeners

SELECT
extendedLocation,
properties
FROM azure.iotoperations.broker_listeners
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_listeners resource.

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: serviceName
          value: string
        - name: ports
          value:
            - - name: authenticationRef
                value: string
              - name: authorizationRef
                value: string
              - name: nodePort
                value: integer
              - name: port
                value: integer
              - name: protocol
                value: string
              - name: tls
                value:
                  - name: mode
                    value: []
                  - name: certManagerCertificateSpec
                    value:
                      - name: duration
                        value: string
                      - name: secretName
                        value: string
                      - name: renewBefore
                        value: string
                      - name: issuerRef
                        value:
                          - name: group
                            value: string
                          - name: kind
                            value: []
                          - name: name
                            value: string
                      - name: privateKey
                        value:
                          - name: algorithm
                            value: []
                          - name: rotationPolicy
                            value: []
                      - name: san
                        value:
                          - name: dns
                            value:
                              - string
                          - name: ip
                            value:
                              - string
                  - name: manual
                    value:
                      - name: secretRef
                        value: string
        - name: serviceType
          value: string
        - name: provisioningState
          value: []
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: []

DELETE example

Deletes the specified broker_listeners resource.

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