azext_iot/central/command_map.py

# coding=utf-8
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------

"""
Load CLI commands
"""
from azure.cli.core.commands import CliCommandType

central_device_ops = CliCommandType(
    operations_tmpl="azext_iot.central.commands_device#{}"
)

central_device_templates_ops = CliCommandType(
    operations_tmpl="azext_iot.central.commands_device_template#{}"
)

central_device_groups_ops = CliCommandType(
    operations_tmpl="azext_iot.central.commands_device_group#{}"
)

central_roles_ops = CliCommandType(operations_tmpl="azext_iot.central.commands_role#{}")

central_file_uploads_ops = CliCommandType(
    operations_tmpl="azext_iot.central.commands_file_upload#{}"
)

central_orgs_ops = CliCommandType(
    operations_tmpl="azext_iot.central.commands_organization#{}"
)

central_jobs_ops = CliCommandType(operations_tmpl="azext_iot.central.commands_job#{}")

central_monitor_ops = CliCommandType(
    operations_tmpl="azext_iot.central.commands_monitor#{}"
)

central_user_ops = CliCommandType(operations_tmpl="azext_iot.central.commands_user#{}")

central_api_token_ops = CliCommandType(
    operations_tmpl="azext_iot.central.commands_api_token#{}"
)

central_query_ops = CliCommandType(
    operations_tmpl="azext_iot.central.commands_query#{}"
)

central_destination_ops = CliCommandType(
    operations_tmpl="azext_iot.central.commands_destination#{}"
)

central_export_ops = CliCommandType(
    operations_tmpl="azext_iot.central.commands_export#{}"
)

central_enrollment_groups_ops = CliCommandType(
    operations_tmpl="azext_iot.central.commands_enrollment_group#{}"
)

central_scheduled_jobs_ops = CliCommandType(
    operations_tmpl="azext_iot.central.commands_scheduled_job#{}"
)


# Dev note - think of this as the "router" and all self.command_group as the controllers
def load_central_commands(self, _):
    """
    Load CLI commands
    """

    with self.command_group("iot central", command_type=central_query_ops) as cmd_group:
        cmd_group.command("query", "query_run", is_preview=True)

    with self.command_group(
        "iot central export destination",
        command_type=central_destination_ops,
        is_preview=True,
    ) as cmd_group:
        cmd_group.command("list", "list_destinations")
        cmd_group.show_command("show", "get_destination")
        cmd_group.command("delete", "delete_destination")
        cmd_group.command("create", "add_destination")
        cmd_group.command("update", "update_destination")

    with self.command_group(
        "iot central export", command_type=central_export_ops, is_preview=True
    ) as cmd_group:
        cmd_group.command("list", "list_exports")
        cmd_group.show_command("show", "get_export")
        cmd_group.command("delete", "delete_export")
        cmd_group.command("create", "add_export")
        cmd_group.command("update", "update_export")

    with self.command_group(
        "iot central diagnostics", command_type=central_monitor_ops, is_preview=True
    ) as cmd_group:
        cmd_group.command("monitor-events", "monitor_events")
        cmd_group.command(
            "validate-messages",
            "validate_messages",
        )
        cmd_group.command(
            "monitor-properties",
            "monitor_properties",
        )
        cmd_group.command(
            "validate-properties",
            "validate_properties",
        )

    with self.command_group(
        "iot central diagnostics", command_type=central_device_ops, is_preview=True
    ) as cmd_group:
        cmd_group.command(
            "registration-summary",
            "registration_summary",
        )

    with self.command_group(
        "iot central user",
        command_type=central_user_ops,
    ) as cmd_group:
        cmd_group.command("create", "add_user")
        cmd_group.command("update", "update_user")
        cmd_group.command("list", "list_users")
        cmd_group.show_command("show", "get_user")
        cmd_group.command("delete", "delete_user")

    with self.command_group(
        "iot central api-token",
        command_type=central_api_token_ops,
    ) as cmd_group:
        cmd_group.command("create", "add_api_token")
        cmd_group.command("list", "list_api_tokens")
        cmd_group.show_command("show", "get_api_token")
        cmd_group.command("delete", "delete_api_token")

    with self.command_group(
        "iot central device",
        command_type=central_device_ops,
    ) as cmd_group:
        cmd_group.command("list", "list_devices")
        cmd_group.show_command("show", "get_device")
        cmd_group.command("create", "create_device")
        cmd_group.command("update", "update_device")
        cmd_group.command("delete", "delete_device")
        cmd_group.command("registration-info", "registration_info")
        cmd_group.command("show-credentials", "get_credentials")
        cmd_group.command("compute-device-key", "compute_device_key")
        cmd_group.command("manual-failover", "run_manual_failover")
        cmd_group.command("manual-failback", "run_manual_failback")
        cmd_group.command("list-components", "list_components")
        cmd_group.command("list-modules", "list_modules")

    with self.command_group(
        "iot central device telemetry",
        command_type=central_device_ops,
    ) as cmd_group:
        cmd_group.show_command("show", "get_telemetry_value")

    with self.command_group(
        "iot central device attestation",
        command_type=central_device_ops,
    ) as cmd_group:
        cmd_group.show_command("show", "get_attestation")
        cmd_group.command("create", "create_attestation")
        cmd_group.command("delete", "delete_attestation")
        cmd_group.command("update", "update_attestation")

    with self.command_group(
        "iot central device twin",
        command_type=central_device_ops,
    ) as cmd_group:
        cmd_group.show_command("show", "get_properties")
        cmd_group.command("update", "update_properties")
        cmd_group.command("replace", "replace_properties")

    with self.command_group(
        "iot central device c2d-message",
        command_type=central_device_ops,
    ) as cmd_group:
        cmd_group.command("purge", "purge_c2d_messages")

    with self.command_group(
        "iot central device command",
        command_type=central_device_ops,
    ) as cmd_group:
        cmd_group.command("run", "run_command")
        cmd_group.command("history", "get_command_history")

    with self.command_group(
        "iot central device-template",
        command_type=central_device_templates_ops,
    ) as cmd_group:
        cmd_group.command("list", "list_device_templates")
        cmd_group.show_command("show", "get_device_template")
        cmd_group.command("create", "create_device_template")
        cmd_group.command("update", "update_device_template")
        cmd_group.command("delete", "delete_device_template")

    with self.command_group(
        "iot central device-group",
        command_type=central_device_groups_ops,
    ) as cmd_group:
        cmd_group.command("list", "list_device_groups")
        cmd_group.show_command("show", "get_device_group")
        cmd_group.command("create", "create_device_group")
        cmd_group.command("update", "update_device_group")
        cmd_group.command("delete", "delete_device_group")

    with self.command_group(
        "iot central role", command_type=central_roles_ops,
    ) as cmd_group:
        cmd_group.show_command("show", "get_role")
        cmd_group.command("list", "list_roles")

    with self.command_group(
        "iot central file-upload-config",
        command_type=central_file_uploads_ops,
    ) as cmd_group:
        cmd_group.show_command("show", "get_fileupload")
        cmd_group.show_command("delete", "delete_fileupload")
        cmd_group.show_command("create", "create_fileupload")
        cmd_group.show_command("update", "update_fileupload")

    with self.command_group(
        "iot central organization", command_type=central_orgs_ops,
    ) as cmd_group:
        cmd_group.show_command("show", "get_org")
        cmd_group.command("list", "list_orgs")
        cmd_group.command("create", "create_org")
        cmd_group.command("delete", "delete_org")
        cmd_group.command("update", "update_org")

    with self.command_group(
        "iot central job", command_type=central_jobs_ops,
    ) as cmd_group:
        cmd_group.show_command("show", "get_job")
        cmd_group.command("list", "list_jobs")
        cmd_group.command("create", "create_job")
        cmd_group.command("stop", "stop_job")
        cmd_group.command("resume", "resume_job")
        cmd_group.command("get-devices", "get_job_devices")
        cmd_group.command("rerun", "rerun_job")

    with self.command_group(
        "iot central enrollment-group", command_type=central_enrollment_groups_ops,
    ) as cmd_group:
        cmd_group.show_command("show", "get_enrollment_group")
        cmd_group.command("list", "list_enrollment_groups")
        cmd_group.command("create", "create_enrollment_group")
        cmd_group.command("delete", "delete_enrollment_group")
        cmd_group.command("update", "update_enrollment_group")
        cmd_group.command("verify-certificate", "verify_x509")
        cmd_group.command("generate-verification-code", "generate_verification_code")

    with self.command_group(
        "iot central scheduled-job", command_type=central_scheduled_jobs_ops,
    ) as cmd_group:
        cmd_group.show_command("show", "get_scheduled_job")
        cmd_group.command("list", "list_scheduled_jobs")
        cmd_group.command("create", "create_scheduled_job")
        cmd_group.command("delete", "delete_scheduled_job")
        cmd_group.command("update", "update_scheduled_job")
        cmd_group.command("list-runs", "list_runs")

    with self.command_group(
        "iot central device edge children", command_type=central_device_ops
    ) as cmd_group:
        cmd_group.command("list", "list_children")
        cmd_group.command("add", "add_children", is_preview=True)
        cmd_group.command("remove", "remove_children", is_preview=True)

    with self.command_group(
        "iot central device edge module",
        command_type=central_device_ops,
        is_preview=True,
    ) as cmd_group:
        cmd_group.command("list", "list_device_modules")
        cmd_group.show_command("show", "get_device_module")
        cmd_group.command("restart", "restart_device_module")

    with self.command_group(
        "iot central device edge manifest",
        command_type=central_device_ops,
        is_preview=True,
    ) as cmd_group:
        cmd_group.show_command("show", "get_edge_manifest")