Skip to content

Commit e73af1f

Browse files
committed
update args and summary
1 parent 80f8fea commit e73af1f

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

src/sftp/azext_sftp/_help.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
helps['sftp'] = """
1111
type: group
12-
short-summary: Commands to connect to Azure Storage Accounts via SFTP
12+
short-summary: Generate SSH certificates and access Azure Storage blob data via SFTP
1313
long-summary: |
1414
These commands allow you to generate certificates and connect to Azure Storage Accounts using SFTP.
1515
@@ -46,16 +46,16 @@
4646
The certificate can be used with 'az sftp connect' or with standard SFTP clients.
4747
examples:
4848
- name: Generate a certificate using an existing public key
49-
text: az sftp cert --public-key-file ~/.ssh/id_rsa.pub --file ~/my_cert.pub
49+
text: az sftp cert --public-key-file ~/.ssh/id_rsa.pub --output-file ~/my_cert.pub
5050
- name: Generate a certificate and create a new key pair in the same directory
51-
text: az sftp cert --file ~/my_cert.pub
51+
text: az sftp cert --output-file ~/my_cert.pub
5252
- name: Generate a certificate with custom SSH client folder
53-
text: az sftp cert --file ~/my_cert.pub --ssh-client-folder "C:\\Program Files\\OpenSSH"
53+
text: az sftp cert --output-file ~/my_cert.pub --ssh-client-folder "C:\\Program Files\\OpenSSH"
5454
"""
5555

5656
helps['sftp connect'] = """
5757
type: command
58-
short-summary: Connect to Azure Storage Account via SFTP
58+
short-summary: Access Azure Storage blob data via SFTP
5959
long-summary: |
6060
Establish an SFTP connection to an Azure Storage Account.
6161

src/sftp/azext_sftp/_params.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
def load_arguments(self, _):
99

1010
with self.argument_context('sftp cert') as c:
11-
c.argument('cert_path', options_list=['--file', '-f'],
11+
c.argument('cert_path', options_list=['--output-file', '-o'],
1212
help='The file path to write the SSH cert to, defaults to public key path with -aadcert.pub appended')
1313
c.argument('public_key_file', options_list=['--public-key-file', '-p'],
1414
help='The RSA public key file path. If not provided, '
15-
'generated key pair is stored in the same directory as --file.')
15+
'generated key pair is stored in the same directory as --output-file.')
1616
c.argument('ssh_client_folder', options_list=['--ssh-client-folder'],
1717
help='Folder path that contains ssh executables (ssh-keygen, ssh). '
1818
'Default to ssh executables in your PATH or C:\\Windows\\System32\\OpenSSH on Windows.')

src/sftp/azext_sftp/custom.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ def sftp_cert(cmd, cert_path=None, public_key_file=None, ssh_client_folder=None)
2424
logger.debug("Starting SFTP certificate generation")
2525

2626
if not cert_path and not public_key_file:
27-
raise azclierror.RequiredArgumentMissingError("--file or --public-key-file must be provided.")
27+
raise azclierror.RequiredArgumentMissingError("--output-file or --public-key-file must be provided.")
2828

2929
if cert_path:
3030
cert_path = os.path.expanduser(cert_path)

src/sftp/azext_sftp/tests/latest/test_custom.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -713,7 +713,7 @@ def test_sftp_cert_error_cases(self):
713713
"""Test sftp cert error handling with invalid argument combinations."""
714714
# Test cases: (cert_path, public_key_file, setup_mocks, expected_exception, expected_message, description)
715715
test_cases = [
716-
(None, None, {}, azclierror.RequiredArgumentMissingError, "--file or --public-key-file must be provided", "no_arguments"),
716+
(None, None, {}, azclierror.RequiredArgumentMissingError, "--output-file or --public-key-file must be provided", "no_arguments"),
717717
("/bad/cert.pub", None, {"expanduser_return": "/bad/cert.pub", "isdir_return": False}, azclierror.InvalidArgumentValueError, "folder doesn't exist", "invalid_directory"),
718718
]
719719

src/sftp/setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
setup(
4545
name='sftp',
4646
version=VERSION,
47-
description='Secure connections to Azure Storage via SFTP with SSH certificates.',
47+
description='Secure access to Azure Storage blob data via SFTP with SSH certificates.',
4848
author='Microsoft Corporation',
4949
author_email='azpycli@microsoft.com',
5050
# TODO: change to your extension source code repo if the code will not be put in azure-cli-extensions repo

0 commit comments

Comments
 (0)