aztemplate

README

Azure Template Package client library for Go

Azure Template Package client library for Go (aztemplate) matches necessary patterns that the development team has established to create a unified SDK written in the Go programming language. These libraries follow the Azure SDK Design Guidelines for Go.

The library allows client libraries to expose common functionality in a consistent fashion. Once you learn how to use these APIs in one client library, you will know how to use them in other client libraries.

Getting started

For a rich example of a well formatted readme, please check here. In addition, this is an example readme that should be emulated. Note that the top-level sections in this template align with that of the template.

Key concepts

Bullet point list of your library's main concepts.

Examples

Examples of some of the key concepts for your library.

Troubleshooting

Running into issues? This section should contain details as to what to do there.

Next steps

More sample code should go here, along with links out to the appropriate example tests.

Contributing

For details on contributing to this repository, see the contributing guide.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Additional Helpful Links for Contributors

Many people all over the world have helped make this project better. You'll want to check out:

• What are some good first issues for new contributors to the repo?
• How to build and test your change
• How you can make a change happen!
• Frequently Asked Questions (FAQ) and Conceptual Topics in the detailed Azure SDK for Go wiki.

Reporting security issues and security bugs

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) secure@microsoft.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.

License

Azure SDK for Go is licensed under the MIT license.

Documentation

Index

• type Client
  • func NewClient(cred azcore.TokenCredential, options *ClientOptions) (*Client, error)
  • func (c *Client) BeginLongRunningOperation(ctx context.Context, options *ClientBeginLongRunningOperationOptions) (*runtime.Poller[ClientLongRunningOperationResponse], error)
  • func (c *Client) NewListValuesPager(options *ClientListValuesOptions) *runtime.Pager[ClientListValuesResponse]
  • func (c *Client) SomeServiceAction(ctx context.Context, options *SomeServiceActionOptions) (ClientSomeServiceActionResponse, error)
• type ClientBeginLongRunningOperationOptions
• type ClientListValuesOptions
• type ClientListValuesResponse
• type ClientLongRunningOperationResponse
• type ClientOptions
• type ClientSomeServiceActionResponse
• type SomeServiceActionOptions

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is the client to interact with. Don't use this type directly, use NewClient() instead.

func NewClient

func NewClient(cred azcore.TokenCredential, options *ClientOptions) (*Client, error)

NewClient returns a pointer to a Client

func (*Client) BeginLongRunningOperation

func (c *Client) BeginLongRunningOperation(ctx context.Context, options *ClientBeginLongRunningOperationOptions) (*runtime.Poller[ClientLongRunningOperationResponse], error)

BeginLongRunningOperation is a long-running operation that can take several seconds to complete.

func (*Client) NewListValuesPager

func (c *Client) NewListValuesPager(options *ClientListValuesOptions) *runtime.Pager[ClientListValuesResponse]

NewListValuesPager creates a pager to iterate over pages of results.

func (*Client) SomeServiceAction

func (c *Client) SomeServiceAction(ctx context.Context, options *SomeServiceActionOptions) (ClientSomeServiceActionResponse, error)

SomeServiceAction does some service action

type ClientBeginLongRunningOperationOptions

type ClientBeginLongRunningOperationOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ClientBeginLongRunningOperationOptions contains the optional values for the Client.BeginLongRunningOperation method.

type ClientListValuesOptions

type ClientListValuesOptions struct {
	// PerPage is the optional number of items to return per page.
	PerPage *int32
}

ClientListValuesOptions contains the optional values for the Client.NewListValuesPager method.

type ClientListValuesResponse

type ClientListValuesResponse struct {
	// Next might be a URL to fetch the next page or a continuation token.
	Next *string

	// Values contains the contents of the page.
	Values []*string
}

ClientListValuesResponse contains the response from method Client.ListValues.

type ClientLongRunningOperationResponse

type ClientLongRunningOperationResponse struct {
	Value *string
}

ClientLongRunningOperationResponse contains the response from method Client.LongRunningOperation.

type ClientOptions

type ClientOptions struct {
	azcore.ClientOptions
}

ClientOptions contains optional parameters for NewClient

type ClientSomeServiceActionResponse

type ClientSomeServiceActionResponse struct {
	Value *string
}

ClientSomeServiceActionResponse contains the response from method Client.SomeServiceAction.

type SomeServiceActionOptions

type SomeServiceActionOptions struct {
	// OptionalValue is some optional value to be sent to the service.  nil means nothing is sent.
	OptionalValue *string
}

SomeServiceActionOptions contains the optional values for the Client.SomeServiceAction method.