1# Azure Synapse Artifacts Module for Go
2
3[![PkgGoDev](https://pkg.go.dev/badge/github.com/Azure/azure-sdk-for-go/sdk/synapse/azartifacts)](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/synapse/azartifacts)
4
5The `azartifacts` module provides operations for working with Azure synapse.
6
7[Source code](https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/synapse/azartifacts)
8
9# Getting started
10
11## Prerequisites
12
13- an [Azure subscription](https://azure.microsoft.com/free/)
14- Go 1.13 or above
15
16## Install the package
17
18This project uses [Go modules](https://github.com/golang/go/wiki/Modules) for versioning and dependency management.
19
20Install the Azure Synapse Artifacts module:
21
22```sh
23go get github.com/Azure/azure-sdk-for-go/sdk/synapse/azartifacts
24```
25
26## Authorization
27
28When creating a client, you will need to provide a credential for authenticating with Azure Synapse.  The `azidentity` module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.
29
30```go
31cred, err := azidentity.NewDefaultAzureCredential(nil)
32```
33
34For more information on authentication, please see the documentation for `azidentity` at [pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity).
35
36## Connecting to Azure Synapse
37
38Once you have a credential, create a connection to the desired Synapse endpoint URL.
39
40```go
41con := azartifacts.NewConnection("<endpoint>", cred, nil)
42```
43
44## Clients
45
46Azure Synapse artifacts modules consist of one or more clients.  A client groups a set of related APIs, providing access to its functionality for the associated endpoint.  Create one or more clients to access the APIs you require using your `azartifacts.Connection`.
47
48```go
49client := azartifacts.NewNotebookClient(con)
50```
51
52## Provide Feedback
53
54If you encounter bugs or have suggestions, please
55[open an issue](https://github.com/Azure/azure-sdk-for-go/issues) and assign the `Synapse` label.
56
57# Contributing
58
59This project welcomes contributions and suggestions. Most contributions require
60you to agree to a Contributor License Agreement (CLA) declaring that you have
61the right to, and actually do, grant us the rights to use your contribution.
62For details, visit [https://cla.microsoft.com](https://cla.microsoft.com).
63
64When you submit a pull request, a CLA-bot will automatically determine whether
65you need to provide a CLA and decorate the PR appropriately (e.g., label,
66comment). Simply follow the instructions provided by the bot. You will only
67need to do this once across all repos using our CLA.
68
69This project has adopted the
70[Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
71For more information, see the
72[Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
73or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any
74additional questions or comments.
75