operator_api_connections

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

Overview

Name	operator_api_connections
Type	Resource
Id	azure.programmableconnectivity.operator_api_connections

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_resource_group

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_subscription

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

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

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
operatorApiConnectionName	string	Azure Programmable Connectivity (APC) Operator API Connection Name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get an Operator API Connection.

SELECT
location,
properties,
tags
FROM azure.programmableconnectivity.operator_api_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND operatorApiConnectionName = '{{ operatorApiConnectionName }}' -- required
;

list_by_resource_group

List OperatorApiConnection resources by resource group.

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

list_by_subscription

List OperatorApiConnection resources by subscription ID.

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

INSERT examples

create

Create an Operator API Connection.

INSERT INTO azure.programmableconnectivity.operator_api_connections (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
operatorApiConnectionName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ operatorApiConnectionName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: operator_api_connections
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the operator_api_connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the operator_api_connections resource.
    - name: operatorApiConnectionName
      value: string
      description: Required parameter for the operator_api_connections resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update an Operator API Connection.

UPDATE azure.programmableconnectivity.operator_api_connections
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND operatorApiConnectionName = '{{ operatorApiConnectionName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Delete an Operator API Connection.

DELETE FROM azure.programmableconnectivity.operator_api_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND operatorApiConnectionName = '{{ operatorApiConnectionName }}' --required
;