package
11.9.0+incompatible
Repository: https://github.com/scott-the-programmer/go-autorest.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author

# Functions

DoPollForAsynchronous returns a SendDecorator that polls if the http.Response is for an Azure long-running operation.
DoRetryWithRegistration tries to register the resource provider in case it is unregistered.
EnvironmentFromFile loads an Environment from a configuration file available on disk.
EnvironmentFromName returns an Environment based on the common name specified.
EnvironmentFromURL loads an Environment from a URL This function is particularly useful in the Hybrid Cloud model, where one may define their own endpoints.
ExtractClientID extracts the client identifier from the x-ms-client-request-id header set on the http.Request sent to the service (and returned in the http.Response).
ExtractRequestID extracts the Azure server generated request identifier from the x-ms-request-id header.
IsAzureError returns true if the passed error is an Azure Service error; false otherwise.
NewAsyncOpIncompleteError creates a new AsyncOpIncompleteError with the specified parameters.
NewErrorWithError creates a new Error conforming object from the passed packageType, method, statusCode of the given resp (UndefinedStatusCode if resp is nil), message, and original error.
NewFuture returns a new Future object initialized with the specified request.
NewFutureFromResponse returns a new Future object initialized with the initial response from an asynchronous operation.
ParseResourceID parses a resource ID into a ResourceDetails struct.
WithClientID returns a PrepareDecorator that adds an HTTP extension header of x-ms-client-request-id whose value is passed, undecorated UUID (e.g., "0F39878C-5F76-4DB8-A25D-61D2C193C3CA").
WithErrorUnlessStatusCode returns a RespondDecorator that emits an azure.RequestError by reading the response body unless the response HTTP status code is among the set passed.
WithReturnClientID returns a PrepareDecorator that adds an HTTP extension header of x-ms-return-client-request-id whose boolean value indicates if the value of the x-ms-client-request-id header should be included in the http.Response.
WithReturningClientID returns a PrepareDecorator that adds an HTTP extension header of x-ms-client-request-id whose value is the passed, undecorated UUID (e.g., "0F39878C-5F76-4DB8-A25D-61D2C193C3CA").

# Constants

EnvironmentActiveDirectoryEndpoint ...
EnvironmentBatchManagementEndpoint ...
EnvironmentContainerRegistryDNSSuffix ...
EnvironmentFilepathName captures the name of the environment variable containing the path to the file to be used while populating the Azure Environment.
EnvironmentGalleryEndpoint ...
EnvironmentGraphEndpoint ...
EnvironmentKeyVaultDNSSuffix ...
EnvironmentKeyVaultEndpoint ...
EnvironmentManagementPortalURL ..
EnvironmentName ...
EnvironmentPublishSettingsURL ...
EnvironmentResourceManagerEndpoint ...
EnvironmentResourceManagerVMDNSSuffix ...
EnvironmentServiceBusEndpoint ...
EnvironmentServiceBusEndpointSuffix ...
EnvironmentServiceManagementEndpoint ...
EnvironmentServiceManagementVMDNSSuffix ...
EnvironmentSQLDatabaseDNSSuffix ...
EnvironmentStorageEndpointSuffix ...
EnvironmentTokenAudience ...
EnvironmentTrafficManagerDNSSuffix ...
HeaderClientID is the Azure extension header to set a user-specified request ID.
HeaderRequestID is the Azure extension header of the service generated request ID returned in the response.
HeaderReturnClientID is the Azure extension header to set if the user-specified request ID should be included in the response.
NotAvailable is used for endpoints and resource IDs that are not available for a given cloud.
PollingAsyncOperation indicates the polling method uses the Azure-AsyncOperation header.
PollingLocation indicates the polling method uses the Location header.
PollingRequestURI indicates the polling method uses the original request URI.
PollingUnknown indicates an unknown polling method and is the default value.

# Variables

ChinaCloud is the cloud environment operated in China.
GermanCloud is the cloud environment operated in Germany.
PublicCloud is the default public Azure cloud environment.
USGovernmentCloud is the cloud environment for the US Government.

# Structs

AsyncOpIncompleteError is the type that's returned from a future that has not completed.
Environment represents a set of endpoints for each of Azure's Clouds.
Future provides a mechanism to access the status and results of an asynchronous request.
OverrideProperty represents property name and value that clients can override.
RequestError describes an error response returned by Azure service.
Resource contains details about an Azure resource.
ResourceIdentifier contains a set of Azure resource IDs.
ServiceError encapsulates the error response from an Azure service.

# Type aliases

EnvironmentProperty represent property names that clients can override.
PollingMethodType defines a type used for enumerating polling mechanisms.