Categorygithub.com/Azure/azure-sdk-for-go/sdk/azcore
modulepackage
1.17.0
Repository: https://github.com/azure/azure-sdk-for-go.git
Documentation: pkg.go.dev
Overview
Versions
2
Dependencies
8
Dependents
1.9k
Files
158 SLOC

# README

Azure Core Client Module for Go

PkgGoDev Build Status Code Coverage

The azcore module provides a set of common interfaces and types for Go SDK client modules. These modules follow the Azure SDK Design Guidelines for Go.

Getting started

This project uses Go modules for versioning and dependency management.

Typically, you will not need to explicitly install azcore as it will be installed as a client module dependency. To add the latest version to your go.mod file, execute the following command.

go get github.com/Azure/azure-sdk-for-go/sdk/azcore

General documentation and examples can be found on pkg.go.dev.

Contributing

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 [email protected] with any additional questions or comments.

# Packages

Package arm contains functionality specific to Azure Resource Manager clients.
Package cloud implements a configuration API for applications deployed to sovereign or private Azure clouds.
Package fake provides the building blocks for fake servers.
Package log provides functionality for configuring logging facilities.
Package messaging contains types used across messaging packages.
Package policy contains the definitions needed for configuring in-box pipeline policies and creating custom policies.
Package runtime contains various facilities for creating requests and handling responses.
Package streaming contains helpers for streaming IO operations and progress reporting.
Package to contains various type-conversion helper functions.
Package tracing contains the definitions needed to support distributed tracing.

# Functions

IsNullValue returns true if the field contains a null sentinel value.
NewClient creates a new Client instance with the provided values.
NewKeyCredential creates a new instance of [KeyCredential] with the specified values.
NewSASCredential creates a new instance of [SASCredential] with the specified values.
NullValue is used to send an explicit 'null' within a request.

# Constants

ETagAny is an ETag that represents everything, the value is "*".

# Structs

Client is a basic HTTP client.
MatchConditions specifies HTTP options for conditional requests.

# Type aliases

AccessToken represents an Azure service bearer access token with expiry information.
ClientOptions contains optional settings for a client's pipeline.
ETag is a property used for optimistic concurrency during updates ETag is a validator based on https://tools.ietf.org/html/rfc7232#section-2.3.2 An ETag can be empty ("").
KeyCredential contains an authentication key used to authenticate to an Azure service.
ResponseError is returned when a request is made to a service and the service returns a non-success HTTP status code.
SASCredential contains a shared access signature used to authenticate to an Azure service.
TokenCredential represents a credential capable of providing an OAuth token.