## Command Guideline

Please support them in `az network` command group for private link scenario. It's
easy to support such scenario in Azure CLI.
There are two things you need to do.
- Register your service into generic implementation
- Add test case for new command

#### Register the service into `az ntwork private-endpoint-connection`

You need provide the service's namespace, type, api-version and
whether the service supports list private endpoint connection operation or not in
to this [file](https://github.com/Azure/azure-
cli/blob/49c0e1adc873581311406a11b04715af732cf4f8/src/azure-
cli/azure/cli/command_modules/network/private_link_resource_and_endpoint_connection
s/custom.py#L14-L23).

```python
def register_providers():
_register_one_provider('Microsoft.Storage/storageAccounts', '2019-06-01',
False)
_register_one_provider('Microsoft.Keyvault/vaults', '2019-09-01', False)
_register_one_provider('Microsoft.ContainerRegistry/registries', '2019-12-01-
preview', True)
_register_one_provider('microsoft.insights/privateLinkScopes', '2019-10-17-
preview', True)
_register_one_provider('Microsoft.DBforMySQL/servers', '2018-06-01', False,
'2017-12-01-preview')
_register_one_provider('Microsoft.DBforMariaDB/servers', '2018-06-01', False)
_register_one_provider('Microsoft.DBforPostgreSQL/servers', '2018-06-01',
False, '2017-12-01-preview')
_register_one_provider('Microsoft.DocumentDB/databaseAccounts', '2019-08-01-
preview', False, '2020-03-01')
_register_one_provider('Microsoft.Devices/IotHubs', '2020-03-01', True)
```

#### Add test case for your new service

Add enough test cases for your new service into this [file]
(https://github.com/Azure/azure-cli/blob/dev/src/azure-
cli/azure/cli/command_modules/network/tests/latest/test_private_endpoint_commands.p
y). You can find enough test examples in this file.
- Integration test is mandatory. It should contain the following steps at least.
- Create a resource such as storage account or key vault.
- List all private link resources for the created resource.
- Create a private endpoint for the resource.
- Approve the private endpoint connection.
- Reject the private endpoint connection.
- Show the private endpoint connection.
- Delete the private endpoint connection.

## Deprecated

The following documentations are deprecated.

#### Private Endpoint Connection

- The parent resource should expose a single command group called `private-
endpoint-connection` with four commands: `approve`, `reject`, `delete`, `show`.
- If `approve`, `reject` and `delete` commands are long running operations, please
also provide `... private-endpoint-connection wait` command and support `--no-wait`
in `approve` and `reject` commands.
- The `... private-endpoint-connection approve` command should look similar to the
following, depending on which features are supported by the service.
```
Arguments
--description : Comments for the approval.
--id : The ID of the private endpoint connection
associated with the Key
Vault(Storage Account). If specified --vault-
name and --name/-n, this should be omitted.
--name -n : The name of the private endpoint connection
associated with the Key
Vault(Storage Account). Required if --id is
not specified.
--resource-group -g : Proceed only if Key Vault(Storage Account)
belongs to the specified resource group.
--vault-name(--account-name) : Name of the Key Vault(Storage Account).
Required if --id is not specified.
```
- The `... private-endpoint-connection reject` command should look similar to the
following, depending on which features are supported by the service.
```
Arguments
--description : Comments for the rejection.
--id : The ID of the private endpoint connection
associated with the Key
Vault(Storage Account). If specified --vault-
name and --name/-n, this should be omitted.
--name -n : The name of the private endpoint connection
associated with the Key
Vault(Storage Account). Required if --id is
not specified.
--resource-group -g : Proceed only if Key Vault(Storage Account)
belongs to the specified resource group.
--vault-name(--account-name) : Name of the Key Vault(Storage Account).
Required if --id is not specified.
```
- The `... private-endpoint-connection show/delete` command should look similar to
the following, depending on which features are supported by the service.
```
Arguments
--id : The ID of the private endpoint connection
associated with the Key
Vault(Storage Account). If specified --vault-
name and --name/-n, this should be omitted.
--name -n : The name of the private endpoint connection
associated with the Key
Vault(Storage Account). Required if --id is
not specified.
--resource-group -g : Proceed only if Key Vault(Storage Account)
belongs to the specified resource group.
--vault-name(--account-name) : Name of the Key Vault(Storage Account).
Required if --id is not specified.
```

#### Private Link Resource

- The parent resource should expose a single command group called `private-link-
resource` with one commands: `list`.
- The `... private-link-resource list` command should look similar to the
following, depending on which features are supported by the service.

```
Arguments
--vault-name(--account-name) [Required] : Name of the Key Vault(Storage
Account).
--resource-group -g : Proceed only if Key Vault belongs to the specified
resource group.
```
- The output of `... private-link-resource list` should be a array instead of a
dictionary.

## Command Authoring

Storage and keyvault modules both are good examples. Feel free to use them as
reference.

*Storage*: [PR Link](https://github.com/Azure/azure-cli/pull/12383)

*Keyvault*: [Command Module](https://github.com/Azure/azure-cli/tree/dev/src/azure-

cli/azure/cli/command_modules/keyvault)

#### Parameters
We provide a build-in function `parse_proxy_resource_id` to parse private endpoint
connection id. It can be used to support the `--id` argument.
```
from azure.cli.core.util import parse_proxy_resource_id
pe_resource_id = "/subscriptions/0000/resourceGroups/clirg/" \
"providers/Microsoft.Network/privateEndpoints/clipe/" \
"privateLinkServiceConnections/peconnection"
result = parse_proxy_resource_id(pe_resource_id)
namespace.resource_group = result['resource_group']
namespace.endpoint = result['name']
namespace.name = result['child_name_1']
```
The best practice to support extra `--id` is to add extra argument in `_param.py`.
Then you can use the `parse_proxy_resource_id` to parse the `--id` and delete this
extra argument from the namespace. Storage's PR is a good example.
```
with self.argument_context('storage account private-endpoint-connection
{}'.format(item), resource_type=ResourceType.MGMT_STORAGE) as c:
c.extra('connection_id', options_list=['--id'], help='help='The ID of the
private endpoint connection associated with the Storage Account.')
```
```
from azure.cli.core.util import parse_proxy_resource_id
result = parse_proxy_resource_id(namespace.connection_id)
namespace.resource_group = result['resource_group']
namespace.endpoint = result['name']
namespace.name = result['child_name_1']
del namespace.connection_id
```
#### Transform
In order to transform the output of the `list` command, we provide a transform
function `gen_dict_to_list_transform`. The key's value depends on each service's
response.
```
from azure.cli.core.commands.transform import gen_dict_to_list_transform
g.command('list', transform=gen_dict_to_list_transform(key='values')) # defalut
key is `value`
```

#### Test
- Integration test is mandatory. It should contain the following steps at least.
- Create a resource such as storage account or key vault.
- List all private link resources for the created resource.
- Create a private endpoint for the resource.
- Approve the private endpoint connection.
- Reject the private endpoint connection.
- Show the private endpoint connection.
- Delete the private endpoint connection.