changeanalysis

package
v54.2.1+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 17, 2021 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package changeanalysis implements the Azure ARM Changeanalysis service API version 2021-04-01.

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Changeanalysis
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type AzureEntityResource

type AzureEntityResource struct {
	// Etag - READ-ONLY; Resource Etag.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

AzureEntityResource the resource model definition for an Azure Resource Manager resource with an etag.

type BaseClient

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Changeanalysis.

func New

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type Change

type Change struct {
	Properties *ChangeProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Change the detected change.

func (Change) MarshalJSON

func (c Change) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Change.

type ChangeCategory

type ChangeCategory string

ChangeCategory enumerates the values for change category.

const (
	// System ...
	System ChangeCategory = "System"
	// User ...
	User ChangeCategory = "User"
)

func PossibleChangeCategoryValues

func PossibleChangeCategoryValues() []ChangeCategory

PossibleChangeCategoryValues returns an array of possible values for the ChangeCategory const type.

type ChangeList

type ChangeList struct {
	autorest.Response `json:"-"`
	// Value - The list of changes.
	Value *[]Change `json:"value,omitempty"`
	// NextLink - The URI that can be used to request the next page of changes.
	NextLink *string `json:"nextLink,omitempty"`
}

ChangeList the list of detected changes.

func (ChangeList) IsEmpty

func (cl ChangeList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ChangeListIterator

type ChangeListIterator struct {
	// contains filtered or unexported fields
}

ChangeListIterator provides access to a complete listing of Change values.

func NewChangeListIterator

func NewChangeListIterator(page ChangeListPage) ChangeListIterator

Creates a new instance of the ChangeListIterator type.

func (*ChangeListIterator) Next

func (iter *ChangeListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ChangeListIterator) NextWithContext

func (iter *ChangeListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ChangeListIterator) NotDone

func (iter ChangeListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ChangeListIterator) Response

func (iter ChangeListIterator) Response() ChangeList

Response returns the raw server response from the last page request.

func (ChangeListIterator) Value

func (iter ChangeListIterator) Value() Change

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ChangeListPage

type ChangeListPage struct {
	// contains filtered or unexported fields
}

ChangeListPage contains a page of Change values.

func NewChangeListPage

func NewChangeListPage(cur ChangeList, getNextPage func(context.Context, ChangeList) (ChangeList, error)) ChangeListPage

Creates a new instance of the ChangeListPage type.

func (*ChangeListPage) Next

func (page *ChangeListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ChangeListPage) NextWithContext

func (page *ChangeListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ChangeListPage) NotDone

func (page ChangeListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ChangeListPage) Response

func (page ChangeListPage) Response() ChangeList

Response returns the raw server response from the last page request.

func (ChangeListPage) Values

func (page ChangeListPage) Values() []Change

Values returns the slice of values for the current page or nil if there are no values.

type ChangeProperties

type ChangeProperties struct {
	// ResourceID - The resource id that the change is attached to.
	ResourceID *string `json:"resourceId,omitempty"`
	// TimeStamp - The time when the change is detected.
	TimeStamp *date.Time `json:"timeStamp,omitempty"`
	// InitiatedByList - The list of identities who might initiated the change.
	// The identity could be user name (email address) or the object ID of the Service Principal.
	InitiatedByList *[]string `json:"initiatedByList,omitempty"`
	// ChangeType - Possible values include: 'Add', 'Remove', 'Update'
	ChangeType ChangeType `json:"changeType,omitempty"`
	// PropertyChanges - The list of detailed changes at json property level.
	PropertyChanges *[]PropertyChange `json:"propertyChanges,omitempty"`
}

ChangeProperties the properties of a change.

type ChangeType

type ChangeType string

ChangeType enumerates the values for change type.

const (
	// Add ...
	Add ChangeType = "Add"
	// Remove ...
	Remove ChangeType = "Remove"
	// Update ...
	Update ChangeType = "Update"
)

func PossibleChangeTypeValues

func PossibleChangeTypeValues() []ChangeType

PossibleChangeTypeValues returns an array of possible values for the ChangeType const type.

type ChangesClient

type ChangesClient struct {
	BaseClient
}

ChangesClient is the client for the Changes methods of the Changeanalysis service.

func NewChangesClient

func NewChangesClient(subscriptionID string) ChangesClient

NewChangesClient creates an instance of the ChangesClient client.

func NewChangesClientWithBaseURI

func NewChangesClientWithBaseURI(baseURI string, subscriptionID string) ChangesClient

NewChangesClientWithBaseURI creates an instance of the ChangesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ChangesClient) ListChangesByResourceGroup

func (client ChangesClient) ListChangesByResourceGroup(ctx context.Context, resourceGroupName string, startTime date.Time, endTime date.Time, skipToken string) (result ChangeListPage, err error)

ListChangesByResourceGroup sends the list changes by resource group request. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. startTime - specifies the start time of the changes request. endTime - specifies the end time of the changes request. skipToken - a skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.

func (ChangesClient) ListChangesByResourceGroupComplete

func (client ChangesClient) ListChangesByResourceGroupComplete(ctx context.Context, resourceGroupName string, startTime date.Time, endTime date.Time, skipToken string) (result ChangeListIterator, err error)

ListChangesByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (ChangesClient) ListChangesByResourceGroupPreparer

func (client ChangesClient) ListChangesByResourceGroupPreparer(ctx context.Context, resourceGroupName string, startTime date.Time, endTime date.Time, skipToken string) (*http.Request, error)

ListChangesByResourceGroupPreparer prepares the ListChangesByResourceGroup request.

func (ChangesClient) ListChangesByResourceGroupResponder

func (client ChangesClient) ListChangesByResourceGroupResponder(resp *http.Response) (result ChangeList, err error)

ListChangesByResourceGroupResponder handles the response to the ListChangesByResourceGroup request. The method always closes the http.Response Body.

func (ChangesClient) ListChangesByResourceGroupSender

func (client ChangesClient) ListChangesByResourceGroupSender(req *http.Request) (*http.Response, error)

ListChangesByResourceGroupSender sends the ListChangesByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (ChangesClient) ListChangesBySubscription

func (client ChangesClient) ListChangesBySubscription(ctx context.Context, startTime date.Time, endTime date.Time, skipToken string) (result ChangeListPage, err error)

ListChangesBySubscription sends the list changes by subscription request. Parameters: startTime - specifies the start time of the changes request. endTime - specifies the end time of the changes request. skipToken - a skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.

func (ChangesClient) ListChangesBySubscriptionComplete

func (client ChangesClient) ListChangesBySubscriptionComplete(ctx context.Context, startTime date.Time, endTime date.Time, skipToken string) (result ChangeListIterator, err error)

ListChangesBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.

func (ChangesClient) ListChangesBySubscriptionPreparer

func (client ChangesClient) ListChangesBySubscriptionPreparer(ctx context.Context, startTime date.Time, endTime date.Time, skipToken string) (*http.Request, error)

ListChangesBySubscriptionPreparer prepares the ListChangesBySubscription request.

func (ChangesClient) ListChangesBySubscriptionResponder

func (client ChangesClient) ListChangesBySubscriptionResponder(resp *http.Response) (result ChangeList, err error)

ListChangesBySubscriptionResponder handles the response to the ListChangesBySubscription request. The method always closes the http.Response Body.

func (ChangesClient) ListChangesBySubscriptionSender

func (client ChangesClient) ListChangesBySubscriptionSender(req *http.Request) (*http.Response, error)

ListChangesBySubscriptionSender sends the ListChangesBySubscription request. The method will close the http.Response Body if it receives an error.

type ErrorAdditionalInfo

type ErrorAdditionalInfo struct {
	// Type - READ-ONLY; The additional info type.
	Type *string `json:"type,omitempty"`
	// Info - READ-ONLY; The additional info.
	Info interface{} `json:"info,omitempty"`
}

ErrorAdditionalInfo the resource management error additional info.

type ErrorDetail

type ErrorDetail struct {
	// Code - READ-ONLY; The error code.
	Code *string `json:"code,omitempty"`
	// Message - READ-ONLY; The error message.
	Message *string `json:"message,omitempty"`
	// Target - READ-ONLY; The error target.
	Target *string `json:"target,omitempty"`
	// Details - READ-ONLY; The error details.
	Details *[]ErrorDetail `json:"details,omitempty"`
	// AdditionalInfo - READ-ONLY; The error additional info.
	AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
}

ErrorDetail the error detail.

type ErrorResponse

type ErrorResponse struct {
	// Error - The error object.
	Error *ErrorDetail `json:"error,omitempty"`
}

ErrorResponse common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

type Level

type Level string

Level enumerates the values for level.

const (
	// Important ...
	Important Level = "Important"
	// Noisy ...
	Noisy Level = "Noisy"
	// Normal ...
	Normal Level = "Normal"
)

func PossibleLevelValues

func PossibleLevelValues() []Level

PossibleLevelValues returns an array of possible values for the Level const type.

type OperationsClient

type OperationsClient struct {
	BaseClient
}

OperationsClient is the client for the Operations methods of the Changeanalysis service.

func NewOperationsClient

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List

func (client OperationsClient) List(ctx context.Context, skipToken string) (result ResourceProviderOperationListPage, err error)

List sends the list request. Parameters: skipToken - a skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.

func (OperationsClient) ListComplete

func (client OperationsClient) ListComplete(ctx context.Context, skipToken string) (result ResourceProviderOperationListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer

func (client OperationsClient) ListPreparer(ctx context.Context, skipToken string) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder

func (client OperationsClient) ListResponder(resp *http.Response) (result ResourceProviderOperationList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type PropertyChange

type PropertyChange struct {
	// ChangeType - Possible values include: 'Add', 'Remove', 'Update'
	ChangeType ChangeType `json:"changeType,omitempty"`
	// ChangeCategory - The change category. Possible values include: 'User', 'System'
	ChangeCategory ChangeCategory `json:"changeCategory,omitempty"`
	// JSONPath - The json path of the changed property.
	JSONPath *string `json:"jsonPath,omitempty"`
	// DisplayName - The enhanced display name of the json path. E.g., the json path value[0].properties will be translated to something meaningful like slots["Staging"].properties.
	DisplayName *string `json:"displayName,omitempty"`
	// Level - Possible values include: 'Noisy', 'Normal', 'Important'
	Level Level `json:"level,omitempty"`
	// Description - The description of the changed property.
	Description *string `json:"description,omitempty"`
	// OldValue - The value of the property before the change.
	OldValue *string `json:"oldValue,omitempty"`
	// NewValue - The value of the property after the change.
	NewValue *string `json:"newValue,omitempty"`
	// IsDataMasked - The boolean indicating whether the oldValue and newValue are masked. The values are masked if it contains sensitive information that the user doesn't have access to.
	IsDataMasked *bool `json:"isDataMasked,omitempty"`
}

PropertyChange data of a property change.

type ProxyResource

type ProxyResource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

ProxyResource the resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

type Resource

type Resource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Resource common fields that are returned in the response for all Azure Resource Manager resources

type ResourceChangesClient

type ResourceChangesClient struct {
	BaseClient
}

ResourceChangesClient is the client for the ResourceChanges methods of the Changeanalysis service.

func NewResourceChangesClient

func NewResourceChangesClient(subscriptionID string) ResourceChangesClient

NewResourceChangesClient creates an instance of the ResourceChangesClient client.

func NewResourceChangesClientWithBaseURI

func NewResourceChangesClientWithBaseURI(baseURI string, subscriptionID string) ResourceChangesClient

NewResourceChangesClientWithBaseURI creates an instance of the ResourceChangesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ResourceChangesClient) List

func (client ResourceChangesClient) List(ctx context.Context, resourceID string, startTime date.Time, endTime date.Time, skipToken string) (result ChangeListPage, err error)

List sends the list request. Parameters: resourceID - the identifier of the resource. startTime - specifies the start time of the changes request. endTime - specifies the end time of the changes request. skipToken - a skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.

func (ResourceChangesClient) ListComplete

func (client ResourceChangesClient) ListComplete(ctx context.Context, resourceID string, startTime date.Time, endTime date.Time, skipToken string) (result ChangeListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (ResourceChangesClient) ListPreparer

func (client ResourceChangesClient) ListPreparer(ctx context.Context, resourceID string, startTime date.Time, endTime date.Time, skipToken string) (*http.Request, error)

ListPreparer prepares the List request.

func (ResourceChangesClient) ListResponder

func (client ResourceChangesClient) ListResponder(resp *http.Response) (result ChangeList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (ResourceChangesClient) ListSender

func (client ResourceChangesClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type ResourceProviderOperationDefinition

type ResourceProviderOperationDefinition struct {
	// Name - The resource provider operation name.
	Name    *string                           `json:"name,omitempty"`
	Display *ResourceProviderOperationDisplay `json:"display,omitempty"`
}

ResourceProviderOperationDefinition the resource provider operation definition.

type ResourceProviderOperationDisplay

type ResourceProviderOperationDisplay struct {
	// Provider - Name of the resource provider.
	Provider *string `json:"provider,omitempty"`
	// Resource - Name of the resource type.
	Resource *string `json:"resource,omitempty"`
	// Operation - Name of the resource provider operation.
	Operation *string `json:"operation,omitempty"`
	// Description - Description of the resource provider operation.
	Description *string `json:"description,omitempty"`
}

ResourceProviderOperationDisplay the resource provider operation details.

type ResourceProviderOperationList

type ResourceProviderOperationList struct {
	autorest.Response `json:"-"`
	// Value - Resource provider operations list.
	Value *[]ResourceProviderOperationDefinition `json:"value,omitempty"`
	// NextLink - The URI that can be used to request the next page for list of Azure operations.
	NextLink *string `json:"nextLink,omitempty"`
}

ResourceProviderOperationList the resource provider operation list.

func (ResourceProviderOperationList) IsEmpty

func (rpol ResourceProviderOperationList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ResourceProviderOperationListIterator

type ResourceProviderOperationListIterator struct {
	// contains filtered or unexported fields
}

ResourceProviderOperationListIterator provides access to a complete listing of ResourceProviderOperationDefinition values.

func NewResourceProviderOperationListIterator

func NewResourceProviderOperationListIterator(page ResourceProviderOperationListPage) ResourceProviderOperationListIterator

Creates a new instance of the ResourceProviderOperationListIterator type.

func (*ResourceProviderOperationListIterator) Next

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ResourceProviderOperationListIterator) NextWithContext

func (iter *ResourceProviderOperationListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ResourceProviderOperationListIterator) NotDone

NotDone returns true if the enumeration should be started or is not yet complete.

func (ResourceProviderOperationListIterator) Response

Response returns the raw server response from the last page request.

func (ResourceProviderOperationListIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ResourceProviderOperationListPage

type ResourceProviderOperationListPage struct {
	// contains filtered or unexported fields
}

ResourceProviderOperationListPage contains a page of ResourceProviderOperationDefinition values.

func NewResourceProviderOperationListPage

Creates a new instance of the ResourceProviderOperationListPage type.

func (*ResourceProviderOperationListPage) Next

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ResourceProviderOperationListPage) NextWithContext

func (page *ResourceProviderOperationListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ResourceProviderOperationListPage) NotDone

func (page ResourceProviderOperationListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ResourceProviderOperationListPage) Response

Response returns the raw server response from the last page request.

func (ResourceProviderOperationListPage) Values

Values returns the slice of values for the current page or nil if there are no values.

type TrackedResource

type TrackedResource struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

TrackedResource the resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL