Skip to content

Commit

Permalink
update template accordingly (#15419)
Browse files Browse the repository at this point in the history
  • Loading branch information
ArcturusZhang authored Sep 1, 2021
1 parent 5133956 commit 938095f
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions tools/generator/template/rpName/packageName/README.md.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,17 @@ For more information on authentication, please see the documentation for `aziden

## Connecting to Azure {{PackageTitle}}

Once you have a credential, create a connection to the desired ARM endpoint. The `armcore` module provides facilities for connecting with ARM endpoints including public and sovereign clouds as well as Azure Stack.
Once you have a credential, create a connection to the desired ARM endpoint. The `github.com/Azure/azure-sdk-for-go/sdk/azcore/arm` package provides facilities for connecting with ARM endpoints including public and sovereign clouds as well as Azure Stack.

```go
con := armcore.NewDefaultConnection(cred, nil)
con := arm.NewDefaultConnection(cred, nil)
```

For more information on ARM connections, please see the documentation for `armcore` at [pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/armcore](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/armcore).
For more information on ARM connections, please see the documentation for `azcore` at [pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore).

## Clients

Azure {{PackageTitle}} modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your `armcore.Connection`.
Azure {{PackageTitle}} modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your `arm.Connection`.

```go
client := {{packageName}}.{{NewClientMethod}}(con, "<subscription ID>")
Expand Down
2 changes: 1 addition & 1 deletion tools/generator/template/rpName/packageName/build.go.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
// Licensed under the MIT License. See License.txt in the project root for license information.

// This file enables 'go generate' to regenerate this specific SDK
//go:generate pwsh.exe ../../../eng/scripts/build.ps1 -skipBuild -format -tidy -generate {{packageName}}
//go:generate pwsh.exe ../../../eng/scripts/build.ps1 -skipBuild -cleanGenerated -format -tidy -generate {{packageName}}

package {{packageName}}

0 comments on commit 938095f

Please sign in to comment.