DESCRIBE NETWORK RULE

Describes the properties specified for a network rule.

DESCRIBE can be abbreviated to DESC.

See also:

DROP NETWORK RULE , ALTER NETWORK RULE , CREATE NETWORK RULE , SHOW NETWORK RULES

Syntax

DESC[RIBE] NETWORK RULE <name>
Copy

Parameters

name

Specifies the identifier for the network rule you want to describe.

If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are case-sensitive.

Output

The command output provides network rule properties and metadata in the following columns:

Column

Description

created_on

Date and time when the network rule was created.

name

Name of the network rule.

database_name

Database that contains the schema in which the network rule was created.

schema_name

Schema in which the network rule was created.

owner

Role that has the OWNERSHIP privilege on the network rule.

comment

Descriptive text associated with the network rule.

type

Value of the network rule’s TYPE property.

mode

Value of the network rule’s MODE property.

value_list

Network identifiers defined in the VALUE_LIST property of the network rule.

Access Control Requirements

A role used to execute this SQL command must have the following privileges at a minimum:

Privilege

Object

Notes

OWNERSHIP

Network Rule

OWNERSHIP is a special privilege on an object that is automatically granted to the role that created the object, but can also be transferred using the GRANT OWNERSHIP command to a different role by the owning role (or any role with the MANAGE GRANTS privilege).

For instructions on creating a custom role with a specified set of privileges, see Creating Custom Roles.

For general information about roles and privilege grants for performing SQL actions on securable objects, see Overview of Access Control.

Usage Notes

  • To post-process the output of this command, you can use the RESULT_SCAN function, which treats the output as a table that can be queried.

Example

Describe a network rule named myrule:

DESC NETWORK RULE myrule;
Copy