operator_api_connections

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

Overview

Name	operator_api_connections
Type	Resource
Id	azure.programmableconnectivity.operator_api_connections

Fields

vw_operator_api_connections

Name	Datatype	Description
account_type	text	field from the properties object
app_id	text	field from the properties object
app_secret	text	field from the properties object
camara_api_name	text	field from the properties object
configured_application	text	field from the properties object
gateway_id	text	field from the properties object
location	text	The geo-location where the resource lives
operatorApiConnectionName	text	field from the properties object
operator_api_plan_id	text	field from the properties object
operator_name	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
saas_properties	text	field from the properties object
status	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.

operator_api_connections

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Operator API Connection resource properties that cannot be updated once a resource has been created.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	operatorApiConnectionName, resourceGroupName, subscriptionId	Get an Operator API Connection.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	List OperatorApiConnection resources by resource group.
list_by_subscription	SELECT	subscriptionId	List OperatorApiConnection resources by subscription ID.
create	INSERT	operatorApiConnectionName, resourceGroupName, subscriptionId	Create an Operator API Connection.
delete	DELETE	operatorApiConnectionName, resourceGroupName, subscriptionId	Delete an Operator API Connection.
update	UPDATE	operatorApiConnectionName, resourceGroupName, subscriptionId	Update an Operator API Connection.

SELECT examples

List OperatorApiConnection resources by subscription ID.

vw_operator_api_connections

SELECT
account_type,
app_id,
app_secret,
camara_api_name,
configured_application,
gateway_id,
location,
operatorApiConnectionName,
operator_api_plan_id,
operator_name,
provisioning_state,
resourceGroupName,
saas_properties,
status,
subscriptionId,
tags
FROM azure.programmableconnectivity.vw_operator_api_connections
WHERE subscriptionId = '{{ subscriptionId }}';

operator_api_connections

SELECT
location,
properties,
tags
FROM azure.programmableconnectivity.operator_api_connections
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.programmableconnectivity.operator_api_connections (
operatorApiConnectionName,
resourceGroupName,
subscriptionId,
properties,
tags,
location
)
SELECT 
'{{ operatorApiConnectionName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: operatorApiPlanId
          value: string
        - name: saasProperties
          value:
            - name: saasSubscriptionId
              value: string
            - name: saasResourceId
              value: string
        - name: configuredApplication
          value:
            - name: name
              value: string
            - name: applicationDescription
              value: string
            - name: applicationType
              value: string
            - name: legalName
              value: string
            - name: organizationDescription
              value: string
            - name: taxNumber
              value: string
            - name: privacyContactEmailAddress
              value: string
        - name: appId
          value: string
        - name: gatewayId
          value: string
        - name: accountType
          value: []
        - name: appSecret
          value: string
        - name: operatorName
          value: string
        - name: camaraApiName
          value: string
        - name: provisioningState
          value: []
        - name: status
          value:
            - name: state
              value: string
            - name: reason
              value: string
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a operator_api_connections resource.

/*+ update */
UPDATE azure.programmableconnectivity.operator_api_connections
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
operatorApiConnectionName = '{{ operatorApiConnectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified operator_api_connections resource.

/*+ delete */
DELETE FROM azure.programmableconnectivity.operator_api_connections
WHERE operatorApiConnectionName = '{{ operatorApiConnectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';