outbound_rule

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

Overview

Name	outbound_rule
Type	Resource
Id	azure.cognitive_services.outbound_rule

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.
category	string	Category of a managed network Outbound Rule of a cognitive services account. Known values are: "Required", "Recommended", "UserDefined", and "Dependency". (Required, Recommended, UserDefined, Dependency)
errorInformation	string	Error information about an outbound rule of a cognitive services account if RuleStatus is failed.
parentRuleNames	array	:vartype parent_rule_names: list[str]
status	string	Type of a managed network Outbound Rule of a cognitive services account. Known values are: "Inactive", "Active", "Provisioning", "Deleting", and "Failed". (Inactive, Active, Provisioning, Deleting, Failed)
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

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.
category	string	Category of a managed network Outbound Rule of a cognitive services account. Known values are: "Required", "Recommended", "UserDefined", and "Dependency". (Required, Recommended, UserDefined, Dependency)
errorInformation	string	Error information about an outbound rule of a cognitive services account if RuleStatus is failed.
parentRuleNames	array	:vartype parent_rule_names: list[str]
status	string	Type of a managed network Outbound Rule of a cognitive services account. Known values are: "Inactive", "Active", "Provisioning", "Deleting", and "Failed". (Inactive, Active, Provisioning, Deleting, Failed)
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, account_name, managed_network_name, rule_name, subscription_id		The GET API for retrieving a single outbound rule of the managed network associated with the cognitive services account. The GET API for retrieving a single outbound rule of the managed network associated with the cognitive services account.
list	select	resource_group_name, account_name, managed_network_name, subscription_id		The GET API for retrieving the list of outbound rules of the managed network associated with the cognitive services account. The GET API for retrieving the list of outbound rules of the managed network associated with the cognitive services account.
create_or_update	insert	resource_group_name, account_name, managed_network_name, rule_name, subscription_id, properties		The PUT API for creating or updating a single outbound rule of the managed network associated with the cognitive services account. The PUT API for creating or updating a single outbound rule of the managed network associated with the cognitive services account.
create_or_update	replace	resource_group_name, account_name, managed_network_name, rule_name, subscription_id, properties		The PUT API for creating or updating a single outbound rule of the managed network associated with the cognitive services account. The PUT API for creating or updating a single outbound rule of the managed network associated with the cognitive services account.
delete	delete	resource_group_name, account_name, managed_network_name, rule_name, subscription_id		The DELETE API for deleting a single outbound rule of the managed network associated with the cognitive services account. The DELETE API for deleting a single outbound rule of the managed network associated with the cognitive services account.

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
account_name	string	The name of Cognitive Services account. Required.
managed_network_name	string	Name of the managedNetwork associated with the cognitive services account. Only 'default' is supported. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
rule_name	string	Name of the cognitive services account managed network outbound rule. Required.
subscription_id	string

SELECT examples

get

The GET API for retrieving a single outbound rule of the managed network associated with the cognitive services account. The GET API for retrieving a single outbound rule of the managed network associated with the cognitive services account.

SELECT
id,
name,
category,
errorInformation,
parentRuleNames,
status,
systemData,
type
FROM azure.cognitive_services.outbound_rule
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND managed_network_name = '{{ managed_network_name }}' -- required
AND rule_name = '{{ rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

The GET API for retrieving the list of outbound rules of the managed network associated with the cognitive services account. The GET API for retrieving the list of outbound rules of the managed network associated with the cognitive services account.

SELECT
id,
name,
category,
errorInformation,
parentRuleNames,
status,
systemData,
type
FROM azure.cognitive_services.outbound_rule
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND managed_network_name = '{{ managed_network_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

The PUT API for creating or updating a single outbound rule of the managed network associated with the cognitive services account. The PUT API for creating or updating a single outbound rule of the managed network associated with the cognitive services account.

INSERT INTO azure.cognitive_services.outbound_rule (
properties,
resource_group_name,
account_name,
managed_network_name,
rule_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ managed_network_name }}',
'{{ rule_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: outbound_rule
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the outbound_rule resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the outbound_rule resource.
  - name: managed_network_name
    value: "{{ managed_network_name }}"
    description: Required parameter for the outbound_rule resource.
  - name: rule_name
    value: "{{ rule_name }}"
    description: Required parameter for the outbound_rule resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the outbound_rule resource.
  - name: properties
    description: |
      Outbound Rule for the managed network of a cognitive services account. Required.
    value:
      category: "{{ category }}"
      status: "{{ status }}"
      type: "{{ type }}"
      errorInformation: "{{ errorInformation }}"
      parentRuleNames:
        - "{{ parentRuleNames }}"

REPLACE examples

create_or_update

The PUT API for creating or updating a single outbound rule of the managed network associated with the cognitive services account. The PUT API for creating or updating a single outbound rule of the managed network associated with the cognitive services account.

REPLACE azure.cognitive_services.outbound_rule
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND managed_network_name = '{{ managed_network_name }}' --required
AND rule_name = '{{ rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

The DELETE API for deleting a single outbound rule of the managed network associated with the cognitive services account. The DELETE API for deleting a single outbound rule of the managed network associated with the cognitive services account.

DELETE FROM azure.cognitive_services.outbound_rule
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND managed_network_name = '{{ managed_network_name }}' --required
AND rule_name = '{{ rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;