# Functions
ARMRequestContextFromContext retrieves an ARMRequestContext from a given context.
FromARMRequest extracts proxy request headers from http.Request.
NewClientErrInvalidRequest creates a new ErrClientRP error with a given message and sets the code to CodeInvalid.
ParseOperationType parses OperationType from string.
ParsePathBase takes in a string and returns a string representing the base path of the string if it contains either "/planes/" or "/subscriptions/", otherwise it returns an empty string.
UnmarshalTimeString unmarshals a string representation of a time in RFC3339 format into a time.Time object.
UpdateSystemData updates the existing SystemData object with the new SystemData object, filling in any missing fields from the old object and backfilling the CreatedAt, CreatedBy, and CreatedByType fields if they are not present in the new object.
WithARMRequestContext adds the ARMRequestContext to the context and returns the new context.
# Constants
APIVersionParameterName is the query string parameter for the api version.
Used for CodeConflict error.
Used when a dependency to carry out current operation is missing.
Used for failed invalid spec api validation.
Used for internal/unclassified failures.
Used for generic validation errors.
Used for invalid api version parameter.
Used for CodeInvalidAuthenticationInfo.
Used for invalid plane type.
Used for invalid object properties.
Used for invalid request content.
Used for CodeInvalidResourceType.
Used for CodeNotFound error.
Used for CodeOperationCanceled.
Used for the cases when the precondition of a request fails.
DefaultQueryItemCount represents the default value for the number of records to be returned by the server.
DefaultRetryAfter is the default value in seconds for the Retry-After header.
DefaultRetryAfterDuration is the default value in time.Duration for the Retry-After header.
Deleted means the subscription has been deleted.
FeatureRegistered means the feature is registered to a certain subscription.
FeatureUnregistered means the feature is unregistered to a certain subscription.
LocationGlobal is the sentinel value for the location property in UCP.
MaxQueryItemCount represents the default value for the maximum number of records to be returned by the server.
MinQueryItemCount represents the default value for the minimum number of records to be returned by the server.
No description provided by the author
OperationDeleteImperative is used for non-idempotent DELETE operations.
No description provided by the author
OperationGetImperative is used for non-idempotent GET operations.
No description provided by the author
No description provided by the author
Predefined Operation methods.
No description provided by the author
OperationProxy is used for controllers that proxy the underlying request without classifying the type of operation.
No description provided by the author
OperationPutImperative is used for non-idempotent PUT operations.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Registered means the subscription is entitled to use the namespace.
No description provided by the author
SkipTokenParameterName is the query string parameter for the skip token which is used for pagination purposes.
No description provided by the author
Suspended means the subscription has been suspended from the system.
TopParameterName is an optional query parameter that defines the number of records requested by the client.
Unregistered means the subscription is not entitled to use the namespace.
Warned means the subscription has been warned.
# Variables
AcceptLanguageHeader is the standard http header used so that we don't have to pass in the http request.
ARMResourceSystemDataHeader is the http header to the provider on resource write and resource action calls in JSON format.
ClientApplicationIDHeader is the app Id of the client JWT making the request.
ClientObjectIDHeader is the object Id of the client JWT making the request.
ClientPrincipalIDHeader is the principal Id of the client JWT making the request.
ClientPrincipalNameHeader is the principal name / UPN of the client JWT making the request.
ClientRequestIDHeader is the http header identifying the request, in the form of a GUID with no decoration.
ClientReturnClientRequestIDHeader indicates if a client-request-id should be included in the response.
ClientTenantIDHeader is the tenant id of the client.
ContentTypeHeader is the standard http header Content-Type.
CorrelationRequestIDHeader is the http header identifying a set of related operations that the request belongs to, in the form of a GUID.
ErrInvalidModelConversion is the error when converting model is invalid.
ErrInvalidOperationType represents the error for invalid operation type string.
ErrTopQueryParamOutOfBounds represents the error of top query parameter being out of defined bounds.
No description provided by the author
HomeTenantIDHeader is the tenant id of the service principal backed by the identity.
HostHeader is the standard http header Host used to indicate the target host name.
HostingConfigContextKey is the context key for hosting configuration.
IfMatch HTTP request header makes a request conditional.
IfNoneMatch HTTP request header also makes a request conditional.
RefererHeader is the full URI that the client connected to (which will be different than the RP URI, since it will have the public hostname instead of the RP hostname).
TraceparentHeader is W3C trace parent header.
# Structs
ARMRequestContext represents the service context including proxy request header values.
AsyncOperationStatus represents an OperationStatus resource.
BaseResource represents common resource properties used for all resources.
No description provided by the author
ErrModelConversion represents an invalid property error.
ErrorAdditionalInfo represents arbitrary additional information as part of an error as defined by the ARM API.
ErrorDetails represents an error as defined by the ARM API.
ErrorResponse represents an error HTTP response as defined by the ARM API.
InternalMetadata represents internal DataModel specific metadata.
Operation represents the struct which contains properties of an operation.
OperationDisplayProperties represents the struct which contains the display properties of an operation.
OperationType represents the operation type which includes resource type name and its method.
PaginatedList represents the object for resource list pagination.
Subscriptions data model https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/subscription-lifecycle-api-reference.md Sample json data in ./testdata directory.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SystemData is the readonly metadata pertaining to creation and last modification of the resource.
TrackedResource represents the common tracked resource.
# Interfaces
TODO: Remove DataModelInterface when we migrate Controller to Operation base struct for controller DataModelInterface is the interface for version agnostic datamodel.
ResourceDataModel represents the datamodel with helper methods.
VersionedModelInterface is the interface for versioned models.
# Type aliases
ConvertToAPIModel is the function to convert data model to version model.
ConvertToDataModel is the function to convert to data model.
FeatureState represents the state of a feature for certain subscription.
OperationMethod is the ARM operation of resource.
ProvisioningState is the state of resource.
SubscriptionState represents the state of the subscription.