[Core] Add service_name.json #3083

qwordy · 2021-03-02T03:47:06Z

Add a file service_name.json. It maintains service information of commands.

Twin PR, Azure/azure-cli#17159. Visit it for more details.

Example

  {
    "Command": "az databox",
    "Description": "Microsoft Azure Command-Line Tools DataBox Extension",
    "AzureServiceName": "Azure Databox",
    "ConversationalServiceName": "Databox",
    "URL": "https://docs.microsoft.com/azure/databox/"
  },

This checklist is used to make sure that common guidelines for a pull request are followed.

General Guidelines

Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
Have you run python scripts/ci/test_index.py -q locally?

For new extensions:

My extension description/summary conforms to the Extension Summary Guidelines.

About Extension Publish

There is a pipeline to automatically build, upload and publish extension wheels.
Once your PR is merged into master branch, a new PR will be created to update src/index.json automatically.
The precondition is to put your code inside this repo and upgrade the version in the PR but do not modify src/index.json.

yungezz · 2021-03-02T08:52:37Z

src/service_name.json

@@ -0,0 +1,422 @@
+[
+  {
+    "Command": "az ai-did-you-mean-this",


I believe this extension is deprecated already, could you pls double confirm?

yungezz · 2021-03-02T08:52:57Z

src/service_name.json

+    "URL": ""
+  },
+  {
+    "Command": "az ai-examples",


how to maintain this file? what's process when new extension is released?

Manual. We can add a linter rule to force it.
I added a new column "ExtensionName". It is required when "AzureCLIReferenceType" is Extension or "hasExtension" is 1. This column is used to check if all extensions have records.

fengzhou-msft · 2021-03-09T08:20:51Z

src/service_name.json

+    "AzureServiceName": "Azure CLI",
+    "ConversationalServiceName": "Azure CLI",
+    "ExtensionName": "alias",
+    "URL": "https://docs.microsoft.com/cli/azure/"


Where does this URL come from? The current one is a general CLI doc link.

We can set it reference of az alias

kairu-ms · 2021-03-10T03:54:22Z

src/service_name.json

+  {
+    "Command": "az timeseriesinsights",
+    "Description": "Microsoft Azure Command-Line Tools TimeSeriesInsightsClient Extension",
+    "AzureServiceName": "Azure Time Series Insights",
+    "ConversationalServiceName": "Time Series Insights",
+    "ExtensionName": "timeseriesinsights",
+    "URL": "https://docs.microsoft.com/azure/time-series-insights/"
+  },


This command group is deprecated. Now its name is "az tsi" which already included below.

Suggested change

{

"Command": "az timeseriesinsights",

"Description": "Microsoft Azure Command-Line Tools TimeSeriesInsightsClient Extension",

"AzureServiceName": "Azure Time Series Insights",

"ConversationalServiceName": "Time Series Insights",

"ExtensionName": "timeseriesinsights",

"URL": "https://docs.microsoft.com/azure/time-series-insights/"

},

kairu-ms · 2021-03-10T03:55:55Z

src/service_name.json

+    "Command": "az k8s-configuration",
+    "Description": "Manage Kubernetes configurations",
+    "AzureServiceName": "Azure Kubernetes",
+    "ConversationalServiceName": "Kubernetes Service",
+    "ExtensionName": "k8s-configuration",
+    "URL": "https://docs.microsoft.com/azure/aks/"
+  },
+  {
+    "Command": "az k8sconfiguration",
+    "Description": "Microsoft Azure Command-Line Tools K8sconfiguration Extension",
+    "AzureServiceName": "Azure Kubernetes Service",
+    "ConversationalServiceName": "Kubernetes Service",
+    "ExtensionName": "k8sconfiguration",
+    "URL": "https://docs.microsoft.com/azure/aks/"
+  },


I think k8s-configuration and k8sconfiguration are the same.

Unfortunately, they are two extension. Ugly naming.

k8s-configuration 1.0.0 Microsoft Azure Command-Line Tools K8s-configuration Extension False False False k8sconfiguration 0.2.4 Microsoft Azure Command-Line Tools K8sconfiguration Extension True False False

yungezz · 2021-03-10T04:18:04Z

src/service_name.json

+  {
+    "Command": "az confluent",
+    "Description": "Manage confluent resources.",
+    "AzureServiceName": "",


Have not found an appropriate value

dbradish-microsoft · 2021-03-10T18:37:08Z

src/service_name.json

+  },
+  {
+    "Command": "az alias",
+    "Description": "Support for command aliases",


@yungezz , @qwordy , @jiasli , @fengzhou-msft

Important: Shuang is already keeping a new JSON file which replaces TitleMapping.json and where this information would fit perfectly. Ideally, we'd like to avoid having engineering enter autogenerated content in multiple places. Can we please check with Alice Wang and Shuang Jiang on a consolidated place for this information?

Other thoughts:

I feel we should remove "Description" as it is a duplicate of the autogenerated content. There is no reason for making someone enter the same information in two different places, correct?

Isn't "extensionName" also a duplicate from what is found in the _help.py or commands.py files? Shuang is currently showing this information at the top of every autogenerated extension page and he doesn't use this new file.

URL is not necessary unless we want to a.) take responsibility for maintaining this link or b.) use it in our autogenerated content. I had it in SQL in order to find the Azure service home page for my reference (vs Googling it every time I needed it)

I am glad to see "conversational service name" removed -- that was only for my Power BI internal reporting.

Replied in Azure/azure-cli#17159

src/service_name.json

qwordy · 2021-03-24T06:27:27Z

@dbradish-microsoft Can you revoke the "request change"? Thanks.

qwordy · 2021-03-24T06:27:34Z

/azp run

azure-pipelines · 2021-03-24T06:27:43Z

Azure Pipelines successfully started running 1 pipeline(s).

dbradish-microsoft · 2021-03-24T12:28:36Z

@qwordy , done.

qwordy · 2021-03-29T07:11:43Z

I moved content to these 2 PRs.
Azure/azure-cli#17428
#3186

…into servicename

She has approved

qwordy · 2021-04-01T02:49:31Z

Reopen this PR. The following two new PRs that contain linter and service_name.json are still in review. Reviewing Azure CLI Core code is always hard. As a result, I decide to split linter and service_name.json into separate PRs. Let's merge the service_name.json PR first.
Azure/azure-cli#17428
#3186

[Core] Add service_name.json

7424493

qwordy mentioned this pull request Mar 2, 2021

[Core] Add service_name.json Azure/azure-cli#17159

Merged

3 tasks

update

80aa644

yonzhan requested a review from jiasli March 2, 2021 04:52

yungezz reviewed Mar 2, 2021

View reviewed changes

update

7d4a4e7

qwordy requested a review from fengzhou-msft March 9, 2021 06:56

fengzhou-msft reviewed Mar 9, 2021

View reviewed changes

delete a column

12f9cc2

kairu-ms reviewed Mar 10, 2021

View reviewed changes

yungezz reviewed Mar 10, 2021

View reviewed changes

dbradish-microsoft previously requested changes Mar 10, 2021

View reviewed changes

yonzhan assigned qwordy Mar 10, 2021

qwordy commented Mar 11, 2021

View reviewed changes

src/service_name.json Outdated Show resolved Hide resolved

qwordy commented Mar 23, 2021

View reviewed changes

src/service_name.json Outdated Show resolved Hide resolved

dbradish-microsoft self-requested a review March 24, 2021 12:28

qwordy closed this Mar 29, 2021

qwordy reopened this Apr 1, 2021

qwordy added 2 commits April 1, 2021 10:38

Merge branch 'master' of https://github.com/Azure/azure-cli-extensions …

e05a333

…into servicename

Update service_name.json

fd74e38

qwordy force-pushed the servicename branch from 3c0ba36 to fd74e38 Compare April 1, 2021 03:21

fengzhou-msft approved these changes Apr 1, 2021

View reviewed changes

qwordy merged commit 3dd4217 into Azure:master Apr 1, 2021

[Core] Add service_name.json #3083

[Core] Add service_name.json #3083

Uh oh!

Conversation

qwordy commented Mar 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

General Guidelines

About Extension Publish

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dbradish-microsoft Mar 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

qwordy commented Mar 24, 2021

Uh oh!

qwordy commented Mar 24, 2021

Uh oh!

azure-pipelines bot commented Mar 24, 2021

Uh oh!

dbradish-microsoft commented Mar 24, 2021

Uh oh!

qwordy commented Mar 29, 2021

Uh oh!

qwordy commented Apr 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

qwordy commented Mar 2, 2021 •

edited

Loading

dbradish-microsoft Mar 10, 2021 •

edited

Loading

qwordy commented Apr 1, 2021 •

edited

Loading