hybrid_connections_authorization_rules

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

Overview

Name	hybrid_connections_authorization_rules
Type	Resource
Id	azure.relay.hybrid_connections_authorization_rules

Fields

The following fields are returned by SELECT queries:

get

Hybrid connection authorization rule returned successfully.

Name	Datatype	Description
properties		Properties supplied to create or update AuthorizationRule
systemData	object	The system meta data relating to this resource.

list

Authorization rules successfully returned.

Name	Datatype	Description
properties		Properties supplied to create or update AuthorizationRule
systemData	object	The system meta data relating to this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, namespaceName, hybridConnectionName, authorizationRuleName, subscriptionId		Hybrid connection authorization rule for a hybrid connection by name.
list	select	resourceGroupName, namespaceName, hybridConnectionName, subscriptionId		Authorization rules for a hybrid connection.
create_or_update	insert	resourceGroupName, namespaceName, hybridConnectionName, authorizationRuleName, subscriptionId		Creates or updates an authorization rule for a hybrid connection.
delete	delete	resourceGroupName, namespaceName, hybridConnectionName, authorizationRuleName, subscriptionId		Deletes a hybrid connection authorization rule.

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
authorizationRuleName	string	The authorization rule name.
hybridConnectionName	string	The hybrid connection name.
namespaceName	string	The namespace name
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Hybrid connection authorization rule for a hybrid connection by name.

SELECT
properties,
systemData
FROM azure.relay.hybrid_connections_authorization_rules
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND hybridConnectionName = '{{ hybridConnectionName }}' -- required
AND authorizationRuleName = '{{ authorizationRuleName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Authorization rules for a hybrid connection.

SELECT
properties,
systemData
FROM azure.relay.hybrid_connections_authorization_rules
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND hybridConnectionName = '{{ hybridConnectionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates an authorization rule for a hybrid connection.

INSERT INTO azure.relay.hybrid_connections_authorization_rules (
data__properties,
resourceGroupName,
namespaceName,
hybridConnectionName,
authorizationRuleName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ namespaceName }}',
'{{ hybridConnectionName }}',
'{{ authorizationRuleName }}',
'{{ subscriptionId }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: hybrid_connections_authorization_rules
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the hybrid_connections_authorization_rules resource.
    - name: namespaceName
      value: string
      description: Required parameter for the hybrid_connections_authorization_rules resource.
    - name: hybridConnectionName
      value: string
      description: Required parameter for the hybrid_connections_authorization_rules resource.
    - name: authorizationRuleName
      value: string
      description: Required parameter for the hybrid_connections_authorization_rules resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the hybrid_connections_authorization_rules resource.
    - name: properties
      value: string
      description: |
        Properties supplied to create or update AuthorizationRule

DELETE examples

delete

Deletes a hybrid connection authorization rule.

DELETE FROM azure.relay.hybrid_connections_authorization_rules
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND namespaceName = '{{ namespaceName }}' --required
AND hybridConnectionName = '{{ hybridConnectionName }}' --required
AND authorizationRuleName = '{{ authorizationRuleName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;