bicep icon indicating copy to clipboard operation
bicep copied to clipboard

We should be finding some resources by common terms/aliases (e.g. find serverfarms by typing in appserviceplan)

Open ucheNkadiCode opened this issue 2 years ago • 10 comments

There are two ways that we want to provide suggestions in order to achieve #6249. Ultimately this would include adding tags such as "k8s", "kubernetes", or "cluster" to the description metadata of specific resources and snippets. The first would be considered snippet suggestions

  • "res-aks-cluster" image

The second would be resource suggestions image

Again we would accomplish improving the searchability through tags.

Do you have any examples of resources or snippets that are named confusingly? What tags/searchable terms would you expect for res-ask-cluster? What tags would you expect for Microsoft.Web/sites@2018-11-01?

ucheNkadiCode avatar Mar 31 '22 20:03 ucheNkadiCode

RBAC

resource rbac 'Microsoft.Authorization/roleAssignments@2021-04-01-preview' = {
  name: guid(storageAccount.id, principalId, roleDefinitionId)
  scope: storageAccount
  properties: {
    principalId: principalId
    roleDefinitionId: roleDefinitionId
    principalType: principalType
    description: description
  }
}

BernieWhite avatar Mar 31 '22 21:03 BernieWhite

It would be wonderful if "serverFarms" was (searchable as) "appServicePlan" or "appService" or "asp"

Jaykul avatar Mar 31 '22 21:03 Jaykul

I would be great to have a similar snippet for cosmosDbAccounts instead of Microsoft.DocumentDB/Accounts

ChrisSidebotham avatar Mar 31 '22 21:03 ChrisSidebotham

What about snippets for the new public module resources? How would you pick when to use one versus the other? Should you let the community write snippet collections, instead of spending your time on it?

Jaykul avatar Mar 31 '22 21:03 Jaykul

I would like to see logAnalytics as a searchable term for Microsoft.OperationalInsights/workspaces

azMantas avatar Mar 31 '22 22:03 azMantas

What about snippets for the new public module resources? How would you pick when to use one versus the other? Should you let the community write snippet collections, instead of spending your time on it?

Wassup @Jaykul , thanks for your question. Community members are always welcome to contribute! We're just trying to take a look at a first pass of adding functionality to support easier searching through resources. @alex-frankel What do you think about "searchability" of public resources? This is a good question

ucheNkadiCode avatar Apr 01 '22 00:04 ucheNkadiCode

One thing we are planning to do for discovering public modules is to support completions for registry references.

This will show up when you type:

module foo '

At which point br/public should show up in the list. Selecting that alias would then show the full list of available modules, similar to this list: image

Do we think that goes far enough to help with discovery?

alex-frankel avatar Apr 04 '22 18:04 alex-frankel

@puicchan Need list of aliases to support, thanks.

StephenWeatherford avatar Feb 08 '24 18:02 StephenWeatherford

Snippet keywords

Snippet name Add keyword Notes
res-aks-cluster k8s,kubernetes Uche(above) image
image
image
image
image
image

Resource keywords

RP Add keyword/alias
microsoft.web/sites appservice, webapp, function
microsoft.web/serverfarms appserviceplan
microsoft.app containerapp
microsoft.cache redis
microsoft.ContainerService aks

StephenWeatherford avatar Feb 22 '24 23:02 StephenWeatherford

Microsoft.Web/sites: webapp Microsoft.Web/serverfarms: hosting plan

StephenWeatherford avatar Mar 01 '24 21:03 StephenWeatherford