broker_listener

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

Overview

Name	broker_listener
Type	Resource
Id	azure.iot_operations.broker_listener

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.
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)
ports	array	Ports on which this listener accepts client connections. Required.
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)
serviceName	string	Kubernetes Service name of this listener.
serviceType	string	Kubernetes Service type of this listener. Known values are: "ClusterIp", "LoadBalancer", and "NodePort". (ClusterIp, LoadBalancer, NodePort)
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.
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)
ports	array	Ports on which this listener accepts client connections. Required.
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)
serviceName	string	Kubernetes Service name of this listener.
serviceType	string	Kubernetes Service type of this listener. Known values are: "ClusterIp", "LoadBalancer", and "NodePort". (ClusterIp, LoadBalancer, NodePort)
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, listener_name, subscription_id		Get a BrokerListenerResource.
list_by_resource_group	select	resource_group_name, instance_name, broker_name, subscription_id		List BrokerListenerResource resources by BrokerResource.
create_or_update	insert	resource_group_name, instance_name, broker_name, listener_name, subscription_id		Create a BrokerListenerResource.
create_or_update	replace	resource_group_name, instance_name, broker_name, listener_name, subscription_id		Create a BrokerListenerResource.
delete	delete	resource_group_name, instance_name, broker_name, listener_name, subscription_id		Delete a BrokerListenerResource.

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
broker_name	string	Name of broker. Required.
instance_name	string	Name of instance. Required.
listener_name	string	Name of Instance broker listener resource. 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 BrokerListenerResource.

SELECT
id,
name,
extendedLocation,
healthState,
ports,
provisioningState,
serviceName,
serviceType,
systemData,
type
FROM azure.iot_operations.broker_listener
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND instance_name = '{{ instance_name }}' -- required
AND broker_name = '{{ broker_name }}' -- required
AND listener_name = '{{ listener_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List BrokerListenerResource resources by BrokerResource.

SELECT
id,
name,
extendedLocation,
healthState,
ports,
provisioningState,
serviceName,
serviceType,
systemData,
type
FROM azure.iot_operations.broker_listener
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 BrokerListenerResource.

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

Manifest

# Description fields are for documentation purposes
- name: broker_listener
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the broker_listener resource.
  - name: instance_name
    value: "{{ instance_name }}"
    description: Required parameter for the broker_listener resource.
  - name: broker_name
    value: "{{ broker_name }}"
    description: Required parameter for the broker_listener resource.
  - name: listener_name
    value: "{{ listener_name }}"
    description: Required parameter for the broker_listener resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the broker_listener resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      serviceName: "{{ serviceName }}"
      ports:
        - authenticationRef: "{{ authenticationRef }}"
          authorizationRef: "{{ authorizationRef }}"
          nodePort: {{ nodePort }}
          port: {{ port }}
          protocol: "{{ protocol }}"
          tls:
            mode: "{{ mode }}"
            certManagerCertificateSpec:
              duration: "{{ duration }}"
              secretName: "{{ secretName }}"
              renewBefore: "{{ renewBefore }}"
              issuerRef:
                group: "{{ group }}"
                kind: "{{ kind }}"
                name: "{{ name }}"
              privateKey:
                algorithm: "{{ algorithm }}"
                rotationPolicy: "{{ rotationPolicy }}"
              san:
                dns: "{{ dns }}"
                ip: "{{ ip }}"
            manual:
              secretRef: "{{ secretRef }}"
      serviceType: "{{ serviceType }}"
      provisioningState: "{{ provisioningState }}"
      healthState: "{{ healthState }}"
  - name: extendedLocation
    description: |
      Edge location of the resource.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

REPLACE examples

create_or_update

Create a BrokerListenerResource.

REPLACE azure.iot_operations.broker_listener
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 listener_name = '{{ listener_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
properties,
systemData,
type;

DELETE examples

delete

Delete a BrokerListenerResource.

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