NOTE Please see a module's release notes for change details.
- In
Future.WaitForCompletionRef(), if the initial async response includes aRetry-Afterheader, sleep for the specified amount of time before starting to poll. - Added
APIManagementHostManagementSuffixfield in Azure environment map. - Added
SynapseEndpointSuffixandResourceIdentifiers/Synapsefield in Azure environment map.
- Added package comment to make
github.com/Azure/go-autorestimportable.
- Change
x-ms-authorization-auxiliaryheader value separator to comma.
- Added
azure.SetEnvironment()that will update the global environments map with the specified values.
- Fix race condition when refreshing token.
- Fixed some tests to work with Go 1.14.
- By default, the
DoRetryForStatusCodesfunctions will no longer infinitely retry a request when the response returns an HTTP status code of 429 (StatusTooManyRequests). To opt in to the old behavior setautorest.Count429AsRetrytofalse.
- Variable
autorest.Max429Delaycan be used to control the maximum delay between retries when a 429 is received with noRetry-Afterheader. The default is zero which means there is no cap.
- Added field
SendDecoratorsto theClienttype. This can be used to specify a custom chain of SendDecorators per client. - Added method
Client.Send()which includes logic for selecting the preferred chain of SendDecorators.
- Fixed connection leak when retrying requests.
- Enabled exponential back-off with a 2-minute cap when retrying on 429.
- Fixed some cases where errors were inadvertently dropped.
- Updated
autorest.AsStringSlice()to convert slice elements to their string representation.
- Updated external dependencies.
- Added support for shared key and shared access signature token authorization.
autorest.NewSharedKeyAuthorizer()and dependent types.autorest.NewSASTokenAuthorizer()and dependent types.
- Added
ServicePrincipalToken.SetCustomRefresh()so a custom refresh function can be invoked when a token has expired.
- Fixed
cli.AccessTokensPath()to respectAZURE_CONFIG_DIRwhen set. - Support parsing error messages in XML responses.
- Added the following functions to replace their versions that don't take a context.
adal.InitiateDeviceAuthWithContext()adal.CheckForUserCompletionWithContext()adal.WaitForUserCompletionWithContext()
- Added support for MSI authentication on Azure App Service and Azure Functions.
- Always retry a request even if the sender returns a non-nil error.
- Fixed
autorest.WithQueryParameters()so that it properly encodes multi-value query parameters.
The tracing package has been rewritten to provide a common interface for consumers to wire in the tracing package of their choice.
What this means is that by default no tracing provider will be compiled into your program and setting the AZURE_SDK_TRACING_ENABLED
environment variable will have no effect. To enable this previous behavior you must now add the following import to your source file.
import _ "github.com/Azure/go-autorest/tracing/opencensus"The APIs required by autorest-generated code have remained but some APIs have been removed and new ones added.
The following APIs and variables have been removed (the majority of them were moved to the opencensus package).
- tracing.Transport
- tracing.Enable()
- tracing.EnableWithAIForwarding()
- tracing.Disable()
The following APIs and types have been added
- tracing.Tracer
- tracing.Register()
To hook up a tracer simply call tracing.Register() passing in a type that satisfies the tracing.Tracer interface.
autorest.MultiTenantServicePrincipalTokenAuthorizerwill now properly add its auxiliary bearer tokens.
- Improvements to the fixes made in v12.4.1.
- Remove
overridestanza from Gopkg.toml andreplacedirective from go.mod as they don't apply when being consumed as a dependency. - Switched to latest version of
ocagentthat still depends on protobuf v1.2. - Add indirect dependencies to the
requiredclause with matchingconstraintstanzas so thatdepdependencies match go.sum.
- Remove
- Updated OpenCensus and OCAgent versions to versions that don't depend on v1.3+ of protobuf as it was breaking kubernetes.
- Pinned opencensus-proto to a version that's compatible with our versions of OpenCensus and OCAgent.
- Added
autorest.WithPrepareDecoratorsandautorest.GetPrepareDecoratorsfor adding and retrieving a custom chain of PrepareDecorators to the provided context.
- Support for multi-tenant via x-ms-authorization-auxiliary header has been added for client credentials with
secret scenario; this basically bundles multiple OAuthConfig and ServicePrincipalToken types into corresponding
MultiTenant* types along with a new authorizer that adds the primary and auxiliary token headers to the reqest.
The authenticaion helpers have been updated to support this scenario; if environment var AZURE_AUXILIARY_TENANT_IDS
is set with a semicolon delimited list of tenants the multi-tenant codepath will kick in to create the appropriate authorizer.
See
adal.NewMultiTenantOAuthConfig,adal.NewMultiTenantServicePrincipalTokenandautorest.NewMultiTenantServicePrincipalTokenAuthorizeralong with their supporting types and methods. - Added
autorest.WithSendDecoratorsandautorest.GetSendDecoratorsfor adding and retrieving a custom chain of SendDecorators to the provided context. - Added
autorest.DoRetryForStatusCodesWithCapandautorest.DelayForBackoffWithCapto enforce an upper bound on the duration between retries.
- Added
autorest.WithXML,autorest.AsMerge,autorest.WithBytespreparer decorators. - Added
autorest.ByUnmarshallingBytesresponse decorator. - Added
Response.IsHTTPStatusandResponse.HasHTTPStatushelper methods for inspecting HTTP status code inautorest.Responsetypes.
autorest.DelayWithRetryAfternow supports HTTP-Dates in theRetry-Afterheader and is not limited to just 429 status codes.
- Added
to.ByteSlicePtr(). - Added blob/queue storage resource ID to
azure.ResourceIdentifier.
In preparation for modules the following deprecated content has been removed.
- async.NewFuture()
- async.Future.Done()
- async.Future.WaitForCompletion()
- async.DoPollForAsynchronous()
- The
utilspackage - validation.NewErrorWithValidationError()
- The
versionpackage
- Add
ResourceIdentifiersfield toazure.Environmentcontaining resource IDs for public and sovereign clouds.
- Added
autorest.NewClientWithOptions()to support endpoints that require free renegotiation.
- Fix missing support for http(s) proxy when using the default sender.
- Added methods to obtain a ServicePrincipalToken on the various credential configuration types in the
authpackage.
- Fix ACR DNS endpoint for government clouds.
- Add Cosmos DB DNS endpoints.
- Update dependencies to resolve build breaks in OpenCensus.
- Added type
autorest.BasicAuthorizerto support Basic authentication.
- Fixed
GetTokenFromCLIdid not work with zsh.
- In
Client.sender()set the minimum TLS version on HTTP clients to 1.2.
- The
authpackage has been refactored so that the environment and file settings are now available. - The methods used in
auth.NewAuthorizerFromEnvironment()are now exported so that custom authorization chains can be created. - Added support for certificate authorization for file-based config.
- Added
adal.AddToUserAgent()so callers can append custom data to the user-agent header used for ADAL requests. - Exported
adal.UserAgent()for parity withautorest.Client.
- In
Future.WaitForCompletionRef()if the provided context has a deadline don't add the default deadline.
- For an LRO PUT operation the final GET URL was incorrectly set to the Location polling header in some cases.
- Added method
ServicePrincipalToken()toDeviceFlowConfigtype.
- Deprecate content in the
versionpackage. The functionality has been superseded by content in theautorestpackage.
- Fix environment variable name for enabling tracing from
AZURE_SDK_TRACING_ENABELDtoAZURE_SDK_TRACING_ENABLED. Note that for backward compatibility reasons, both will work until the next major version release of the package.
- If zero bytes are read from a polling response body don't attempt to unmarshal them.
- Removed race condition in
autorest.DoRetryForStatusCodes.
- Function
cli.ProfilePathnow respects environmentAZURE_CONFIG_DIRif available.
NOTE: Versions of Go prior to 1.10 have been removed from CI as they no longer work with golint.
- Method
MSIConfig.Authorizernow supports user-assigned identities. - The adal package now reports its own user-agent string.
- Added
tracingpackage that enables instrumentation of HTTP and API calls. Setting the env variableAZURE_SDK_TRACING_ENABLEDor callingtracing.Enablewill start instrumenting the code for metrics and traces. Additionally, setting the env variableOCAGENT_TRACE_EXPORTER_ENDPOINTor callingtracing.EnableWithAIForwardingwill start the instrumentation and connect to an App Insights Local Forwarder that is needs to be running. Note that if the AI Local Forwarder is not running tracking will still be enabled. By default, instrumentation is disabled. Once enabled, instrumentation can also be programatically disabled by callingDisable. - Added
DoneWithContextcall for checking LRO status.Donehas been deprecated.
- Don't use the initial request's context for LRO polling.
- Don't override the
refreshLockand thehttp.Clientwhen unmarshallingServicePrincipalTokenif it is already set.
- When creating a future always include the polling tracker even if there's a failure; this allows the underlying response to be obtained by the caller.
- Added
auth.NewAuthorizerFromCLIto create an authorizer configured from the Azure 2.0 CLI. - Added
adal.NewOAuthConfigWithAPIVersionto create an OAuthConfig with the specified API version.
- Added
x5cheader to client assertion for certificate Issuer+Subject Name authentication.
- To handle differences between ADFS and AAD the following fields have had their types changed from
stringtojson.Number- ExpiresIn
- ExpiresOn
- NotBefore
- Added
auth.NewAuthorizerFromFileWithResourceto create an authorizer from the config file with the specified resource. - Setting a client's
PollingDurationto zero will use the provided context to control a LRO's polling duration.
- In
DoRetryForStatusCodes, if a request's context is cancelled return the last response.
- If a polling operation returns a failure status code return the associated error.
- Initialize the polling URL and method for an LRO tracker on each iteration, favoring the Azure-AsyncOperation header.
- Use fmt.Fprint when printing request/response so that any escape sequences aren't treated as format specifiers.
- If an LRO API returns a
Failedprovisioning state in the initial response return an error at that point so the caller doesn't have to poll. - For failed LROs without an OData v4 error include the response body in the error's
AdditionalInfofield to aid in diagnosing the failure.
- Add initial support for request/response logging via setting environment variables.
Setting
AZURE_GO_SDK_LOG_LEVELtoLogInfowill log request/response without their bodies. To include the bodies set the log level toLogDebug. By default the logger writes to strerr, however it can also write to stdout or a file if specified inAZURE_GO_SDK_LOG_FILE. Note that if the specified file already exists it will be truncated. IMPORTANT: by default the logger will redact the Authorization and Ocp-Apim-Subscription-Key headers. Any other secrets will not be redacted.
- Added package version that contains version constants and user-agent data.
- Add the user-agent to token requests.
- Added support for additionalInfo in ServiceError type.
- Added field ServicePrincipalToken.MaxMSIRefreshAttempts to configure the maximun number of attempts to refresh an MSI token.
- If an LRO returns http.StatusOK on the initial response with no async headers return the response body from Future.GetResult().
- If there is no "final GET URL" return an error from Future.GetResult().
- In IMDS retry logic, if we don't receive a response don't retry.
- Renamed the retry function so it's clear it's meant for IMDS only.
- For error response bodies that aren't OData-v4 compliant stick the raw JSON in the ServiceError.Details field so the information isn't lost.
- Also add the raw HTTP response to the DetailedResponse.
- Removed superfluous wrapping of response error in azure.DoRetryWithRegistration().
- Validation for integers handles int and int64 types.
- Adding User information to authorization config as parsed from CLI cache.
- Added NewServicePrincipalTokenFromManualTokenSecret for creating a new SPT using a manual token and secret
- Added method ServicePrincipalToken.MarshalTokenJSON() to marshall the inner Token
- Most ServicePrincipalTokens can now be marshalled/unmarshall to/from JSON (ServicePrincipalCertificateSecret and ServicePrincipalMSISecret are not supported).
- Added method ServicePrincipalToken.SetRefreshCallbacks().
- Refreshing a refresh token obtained from a web app authorization code now works.
- The retry logic for MSI token requests now uses exponential backoff per the guidelines.
- IsTemporaryNetworkError() will return true for errors that don't implement the net.Error interface.
| Old Method | New Method |
|---|---|
| azure.NewFuture() | azure.NewFutureFromResponse() |
| Future.WaitForCompletion() | Future.WaitForCompletionRef() |
- Added azure.NewFutureFromResponse() for creating a Future from the initial response from an async operation.
- Added Future.GetResult() for making the final GET call to retrieve the result from an async operation.
- Some futures failed to return their results, this should now be fixed.
- Add nil-gaurd to token retry logic.
- Return a TokenRefreshError if the sender fails on the initial request.
- Don't retry on non-temporary network errors.
- Added NewAuthorizerFromEnvironmentWithResource() helper function.
- Added *WithContext() methods to ADAL token refresh operations.
- Fixed a bug on device authentication.
- Added retries to MSI token get request.
- Changed MSI token implementation. Now, the token endpoint is the IMDS endpoint.
DeviceFlowConfig.Authorizer()now prints the device code message when runninggo test.-vflag is required.
- Added NewPollingRequestWithContext() for use with polling asynchronous operations.
- Make retry logic use the request's context instead of the deprecated Cancel object.
- Added helper for parsing Azure Resource ID's.
- Added deprecation message to utils.GetEnvVarOrExit()
- Added EnvironmentFromURL method to load an Environment from a given URL. This function is particularly useful in the private and hybrid Cloud model, where one may define their own endpoints
- Added TokenAudience endpoint to Environment structure. This is useful in private and hybrid cloud models where TokenAudience endpoint can be different from ResourceManagerEndpoint
- Added endpoints for batch management.
- In Client.Do() invoke WithInspection() last so that it will inspect WithAuthorization().
- Fixed authorization methods to invoke p.Prepare() first, aligning them with the other preparers.
- Corrected comment for auth.NewAuthorizerFromFile() function.
- Updated version number to match current release.
- Expose the polling URL for futures.
- Add validation.NewErrorWithValidationError back to prevent breaking changes (it is deprecated).
- Added target and innererror fields to ServiceError to comply with OData v4 spec.
- The Done() method on futures will now return a ServiceError object when available (it used to return a partial value of such errors).
- Added helper methods for obtaining authorizers.
- Expose the polling URL for futures.
- Switched from glide to dep for dependency management.
- Fixed unmarshaling of ServiceError for JSON bodies that don't conform to the OData spec.
- Fixed a race condition in token refresh.
- The ServiceError.Details field type has been changed to match the OData v4 spec.
- Go v1.7 has been dropped from CI.
- API parameter validation failures will now return a unique error type validation.Error.
- The adal.Token type has been decomposed from adal.ServicePrincipalToken (this was necessary in order to fix the token refresh race).
- Fix the Service Bus suffix in Azure public env
- Add Service Bus Endpoint (AAD ResourceURI) for use in Azure Service Bus RBAC Preview
- Added EventGridKeyAuthorizer for key authorization with event grid topics.
- Fixed race condition when auto-refreshing service principal tokens.
- Added http.StatusNoContent (204) to the list of expected status codes for long-running operations.
- Updated runtime version info so it's current.
- Added type azure.AsyncOpIncompleteError to be returned from a future's Result() method when the operation has not completed.
- Use correct AAD and Graph endpoints for US Gov environment.
- Added support for application/octet-stream MIME types.
- Ensure Authorization header is added to request when polling for registration status.
- Added support for acquiring tokens via MSI with a user assigned identity.
- Don't remove encoding of existing URL Query parameters when calling autorest.WithQueryParameters.
- Set correct Content Type when using autorest.WithFormData.
- Check for nil *http.Response before dereferencing it.
- Don't count http.StatusTooManyRequests (429) against the retry cap.
- Use retry logic when SkipResourceProviderRegistration is set to true.
- Added support for username + password, API key, authoriazation code and cognitive services authentication.
- Added field SkipResourceProviderRegistration to clients to provide a way to skip auto-registration of RPs.
- Added utility function AsStringSlice() to convert its parameters to a string slice.
- When checking for authentication failures look at the error type not the status code as it could vary.
- Validate parameters when creating credentials.
- Don't retry requests if the returned status is a 401 (http.StatusUnauthorized) as it will never succeed.
- Update the AccessTokensPath() to read access tokens path through AZURE_ACCESS_TOKEN_FILE. If this environment variable is not set, it will fall back to use default path set by Azure CLI.
- Use case-insensitive string comparison for polling states.
- Added WaitForCompletion() to Future as a default polling implementation.
- Method Future.Done() shouldn't update polling status for unexpected HTTP status codes.
- DoRetryForStatusCodes will retry if sender.Do returns a non-nil error.
- Added PollingMethod() to Future so callers know what kind of polling mechanism is used.
- Added azure.ChangeToGet() which transforms an http.Request into a GET (to be used with LROs).
- Added support for custom Azure Stack endpoints.
- Added type azure.Future used to track the status of long-running operations.
- Preserve the original error in DoRetryWithRegistration when registration fails.
- Fixes a bug regarding the cookie jar on
autorest.Client.Sender.
- In cases where there is a non-empty error from the service, attempt to unmarshal it instead of uniformly calling it an "Unknown" error.
- Support for loading Azure CLI Authentication files.
- Automatically register your subscription with the Azure Resource Provider if it hadn't been previously.
- RetriableRequest can now tolerate a ReadSeekable body being read but not reset.
- Adding missing Apache Headers
IMPORTANT: This release was intially labeled incorrectly as
v8.4.0. From the time it was released, it should have been markedv9.0.0because it contains breaking changes to the MSI packages. We appologize for any inconvenience this causes.
Adding MSI Endpoint Support and CLI token rehydration.
Pick up bug fix in adal for MSI support.
Updates to Error string formats for clarity. Also, adding a copy of the http.Response to errors for an improved debugging experience.
- Add support for bearer authentication callbacks
- Support 429 response codes that include "Retry-After" header
- Support validation constraint "Pattern" for map keys
- Make RetriableRequest work with multiple versions of Go
Updates the RetriableRequest to take advantage of GetBody() added in Go 1.8.
Adds RetriableRequest type for more efficient handling of retrying HTTP requests.
ADAL refactored into its own package. Support for UNIX time.
- Version Testing now removed from production bits that are shipped with the library.
- Exposing new
RespondDecorator,ByDiscardingBody. This allows operations to acknowledge that they do not need either the entire or a trailing portion of accepts response body. In doing so, Go's http library can reuse HTTP connections more readily. - Adding
PrepareDecoratorto target custom BaseURLs. - Adding ACR suffix to public cloud environment.
- Updating Glide dependencies.
- Fixed the Active Directory endpoint for the China cloud.
- Removes UTF-8 BOM if present in response payload.
- Added telemetry.
- Fixing bug in calls to
DelayForBackoffthat caused doubling of delay duration.
- autorest/azure: added ASM and ARM VM DNS suffixes.
- fixed parsing of UTC times that are not RFC3339 conformant.
- autorest/validation: Reformat validation error for better error message.
- preparer: Added support for multipart formdata - WithMultiPartFormdata()
- preparer: Added support for sending file in request body - WithFile
- client: Added RetryDuration parameter.
- autorest/validation: new package for validation code for Azure Go SDK.
- Add trailing / to endpoint
- azure: add EnvironmentFromName
- Add retry logic for 408, 500, 502, 503 and 504 status codes.
- Change url path and query encoding logic.
- Fix DelayForBackoff for proper exponential delay.
- Add CookieJar in Client.
- Add check to start polling only when status is in [200,201,202].
- Refactoring for unchecked errors.
- azure/persist changes.
- Fix 'file in use' issue in renewing token in deviceflow.
- Store header RetryAfter for subsequent requests in polling.
- Add attribute details in service error.
- Better error messages for long running operation failures
- Corrected DoPollForAsynchronous to properly handle the initial response
- Corrected DoPollForAsynchronous to continue using the polling method first discovered
- Fixed empty JSON input error in ByUnmarshallingJSON
- Fixed polling support for GET calls
- Changed format name from TimeRfc1123 to TimeRFC1123
- Added ByCopying responder with supporting TeeReadCloser
- Rewrote Azure asynchronous handling
- Reverted to only unmarshalling JSON
- Corrected handling of RFC3339 time strings and added support for Rfc1123 time format
The json.Decoder does not catch bad data as thoroughly as json.Unmarshal. Since
encoding/json successfully deserializes all core types, and extended types normally provide
their custom JSON serialization handlers, the code has been reverted back to using
json.Unmarshal. The original change to use json.Decode was made to reduce duplicate
code; there is no loss of function, and there is a gain in accuracy, by reverting.
Additionally, Azure services indicate requests to be polled by multiple means. The existing code
only checked for one of those (that is, the presence of the Azure-AsyncOperation header).
The new code correctly covers all cases and aligns with the other Azure SDKs.
- Introduced
date.ByUnmarshallingJSONDateanddate.ByUnmarshallingJSONTimeto enable JSON encoded values.
- Completely reworked the handling of polled and asynchronous requests
- Removed unnecessary routines
- Reworked
mocks.Senderto replay a series ofhttp.Responseobjects - Added
PrepareDecoratorsfor primitive types (e.g., bool, int32)
Handling polled and asynchronous requests is no longer part of Client#Send. Instead new
SendDecorators implement different styles of polled behavior. Seeautorest.DoPollForStatusCodes
and azure.DoPollForAsynchronous for examples.
- Added new RespondDecorators unmarshalling primitive types
- Corrected application of inspection and authorization PrependDecorators
- Added support for Azure long-running operations.
- Added cancelation support to all decorators and functions that may delay.
- Breaking:
DelayForBackoffnow accepts a channel, which may be nil.
- Add support for OAuth Device Flow authorization.
- Add support for ServicePrincipalTokens that are backed by an existing token, rather than other secret material.
- Add helpers for persisting and restoring Tokens.
- Increased code coverage in the github.com/Azure/autorest/azure package
- Breaking:
NewErrorWithErrorno longer takesstatusCode int. - Breaking:
NewErrorWithStatusCodeis replaced withNewErrorWithResponse. - Breaking:
Client#Send()no longer takescodes ...intargument. - Add: XML unmarshaling support with
ByUnmarshallingXML() - Stopped vending dependencies locally and switched to Glide. Applications using this library should either use Glide or vendor dependencies locally some other way.
- Add:
azure.WithErrorUnlessStatusCode()decorator to handle Azure errors. - Fix: use
net/http.DefaultClientas base client. - Fix: Missing inspection for polling responses added.
- Add: CopyAndDecode helpers.
- Improved
./autorest/towith[]stringhelpers. - Removed golint suppressions in .travis.yml.
- Added
StatusCodetoErrorfor more easily obtaining the HTTP Reponse StatusCode (if any)
- Changed
to.StringMapPtrmethod signature to return a pointer - Changed
ServicePrincipalCertificateSecretandNewServicePrincipalTokenFromCertificateto support generic certificate and private keys
- Added Logging inspectors to trace http.Request / Response
- Added support for User-Agent header
- Changed WithHeader PrepareDecorator to use set vs. add
- Added JSON to error when unmarshalling fails
- Added Client#Send method
- Corrected case of "Azure" in package paths
- Added "to" helpers, Azure helpers, and improved ease-of-use
- Corrected golint issues
- Added CHANGELOG.md
- Added mechanism to retrieve a ServicePrincipalToken using a certificate-signed JWT
- Added an example of creating a certificate-based ServicePrincipal and retrieving an OAuth token using the certificate
- Introduce godeps and vendor dependencies introduced in v1.1.1