locks

package
v35.1.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Nov 1, 2019 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package locks implements the Azure ARM Locks service API version 2015-01-01.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Locks
	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 BaseClient 

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

BaseClient is the base client for Locks.

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.

type LockLevel 

type LockLevel string

LockLevel enumerates the values for lock level. 

const (
	// CanNotDelete ...
	CanNotDelete LockLevel = "CanNotDelete"
	// NotSpecified ...
	NotSpecified LockLevel = "NotSpecified"
	// ReadOnly ...
	ReadOnly LockLevel = "ReadOnly"
)

func PossibleLockLevelValues 

func PossibleLockLevelValues() []LockLevel

PossibleLockLevelValues returns an array of possible values for the LockLevel const type.

type ManagementLockListResult 

type ManagementLockListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of locks.
	Value *[]ManagementLockObject `json:"value,omitempty"`
	// NextLink - The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

ManagementLockListResult list of management locks.

func (ManagementLockListResult) IsEmpty 

func (mllr ManagementLockListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ManagementLockListResultIterator 

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

ManagementLockListResultIterator provides access to a complete listing of ManagementLockObject values.

func NewManagementLockListResultIterator 

func NewManagementLockListResultIterator(page ManagementLockListResultPage) ManagementLockListResultIterator

Creates a new instance of the ManagementLockListResultIterator type.

func (*ManagementLockListResultIterator) Next 

func (iter *ManagementLockListResultIterator) 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 (*ManagementLockListResultIterator) NextWithContext 

func (iter *ManagementLockListResultIterator) 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 (ManagementLockListResultIterator) NotDone 

func (iter ManagementLockListResultIterator) NotDone() bool

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

func (ManagementLockListResultIterator) Response 

func (iter ManagementLockListResultIterator) Response() ManagementLockListResult

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

func (ManagementLockListResultIterator) Value 

func (iter ManagementLockListResultIterator) Value() ManagementLockObject

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

type ManagementLockListResultPage 

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

ManagementLockListResultPage contains a page of ManagementLockObject values.

func NewManagementLockListResultPage 

func NewManagementLockListResultPage(getNextPage func(context.Context, ManagementLockListResult) (ManagementLockListResult, error)) ManagementLockListResultPage

Creates a new instance of the ManagementLockListResultPage type.

func (*ManagementLockListResultPage) Next 

func (page *ManagementLockListResultPage) 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 (*ManagementLockListResultPage) NextWithContext 

func (page *ManagementLockListResultPage) 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 (ManagementLockListResultPage) NotDone 

func (page ManagementLockListResultPage) NotDone() bool

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

func (ManagementLockListResultPage) Response 

func (page ManagementLockListResultPage) Response() ManagementLockListResult

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

func (ManagementLockListResultPage) Values 

func (page ManagementLockListResultPage) Values() []ManagementLockObject

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

type ManagementLockObject 

type ManagementLockObject struct {
	autorest.Response `json:"-"`
	// ManagementLockProperties - The properties of the lock.
	*ManagementLockProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The Id of the lock.
	ID *string `json:"id,omitempty"`
	// Type - READ-ONLY; The type of the lock.
	Type *string `json:"type,omitempty"`
	// Name - The name of the lock.
	Name *string `json:"name,omitempty"`
}

ManagementLockObject management lock information.

func (ManagementLockObject) MarshalJSON 

func (mlo ManagementLockObject) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ManagementLockObject.

func (*ManagementLockObject) UnmarshalJSON 

func (mlo *ManagementLockObject) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ManagementLockObject struct.

type ManagementLockProperties 

type ManagementLockProperties struct {
	// Level - The lock level of the management lock. Possible values include: 'NotSpecified', 'CanNotDelete', 'ReadOnly'
	Level LockLevel `json:"level,omitempty"`
	// Notes - The notes of the management lock.
	Notes *string `json:"notes,omitempty"`
}

ManagementLockProperties the management lock properties.

type ManagementLocksClient 

type ManagementLocksClient struct {
	BaseClient
}

ManagementLocksClient is the client for the ManagementLocks methods of the Locks service.

func NewManagementLocksClient 

func NewManagementLocksClient(subscriptionID string) ManagementLocksClient

NewManagementLocksClient creates an instance of the ManagementLocksClient client.

func NewManagementLocksClientWithBaseURI 

func NewManagementLocksClientWithBaseURI(baseURI string, subscriptionID string) ManagementLocksClient

NewManagementLocksClientWithBaseURI creates an instance of the ManagementLocksClient client.

func (ManagementLocksClient) CreateOrUpdateAtResourceGroupLevel 

func (client ManagementLocksClient) CreateOrUpdateAtResourceGroupLevel(ctx context.Context, resourceGroupName string, lockName string, parameters ManagementLockObject) (result ManagementLockObject, err error)

CreateOrUpdateAtResourceGroupLevel create or update a management lock at the resource group level. Parameters: resourceGroupName - the resource group name. lockName - the lock name. parameters - the management lock parameters.

func (ManagementLocksClient) CreateOrUpdateAtResourceGroupLevelPreparer 

func (client ManagementLocksClient) CreateOrUpdateAtResourceGroupLevelPreparer(ctx context.Context, resourceGroupName string, lockName string, parameters ManagementLockObject) (*http.Request, error)

CreateOrUpdateAtResourceGroupLevelPreparer prepares the CreateOrUpdateAtResourceGroupLevel request.

func (ManagementLocksClient) CreateOrUpdateAtResourceGroupLevelResponder 

func (client ManagementLocksClient) CreateOrUpdateAtResourceGroupLevelResponder(resp *http.Response) (result ManagementLockObject, err error)

CreateOrUpdateAtResourceGroupLevelResponder handles the response to the CreateOrUpdateAtResourceGroupLevel request. The method always closes the http.Response Body.

func (ManagementLocksClient) CreateOrUpdateAtResourceGroupLevelSender 

func (client ManagementLocksClient) CreateOrUpdateAtResourceGroupLevelSender(req *http.Request) (*http.Response, error)

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

func (ManagementLocksClient) CreateOrUpdateAtResourceLevel 

func (client ManagementLocksClient) CreateOrUpdateAtResourceLevel(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, lockName string, parameters ManagementLockObject) (result ManagementLockObject, err error)

CreateOrUpdateAtResourceLevel create or update a management lock at the resource level or any level below resource. Parameters: resourceGroupName - the name of the resource group. resourceProviderNamespace - resource identity. parentResourcePath - resource identity. resourceType - resource identity. resourceName - resource identity. lockName - the name of lock. parameters - create or update management lock parameters.

func (ManagementLocksClient) CreateOrUpdateAtResourceLevelPreparer 

func (client ManagementLocksClient) CreateOrUpdateAtResourceLevelPreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, lockName string, parameters ManagementLockObject) (*http.Request, error)

CreateOrUpdateAtResourceLevelPreparer prepares the CreateOrUpdateAtResourceLevel request.

func (ManagementLocksClient) CreateOrUpdateAtResourceLevelResponder 

func (client ManagementLocksClient) CreateOrUpdateAtResourceLevelResponder(resp *http.Response) (result ManagementLockObject, err error)

CreateOrUpdateAtResourceLevelResponder handles the response to the CreateOrUpdateAtResourceLevel request. The method always closes the http.Response Body.

func (ManagementLocksClient) CreateOrUpdateAtResourceLevelSender 

func (client ManagementLocksClient) CreateOrUpdateAtResourceLevelSender(req *http.Request) (*http.Response, error)

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

func (ManagementLocksClient) CreateOrUpdateAtSubscriptionLevel 

func (client ManagementLocksClient) CreateOrUpdateAtSubscriptionLevel(ctx context.Context, lockName string, parameters ManagementLockObject) (result ManagementLockObject, err error)

CreateOrUpdateAtSubscriptionLevel create or update a management lock at the subscription level. Parameters: lockName - the name of lock. parameters - the management lock parameters.

func (ManagementLocksClient) CreateOrUpdateAtSubscriptionLevelPreparer 

func (client ManagementLocksClient) CreateOrUpdateAtSubscriptionLevelPreparer(ctx context.Context, lockName string, parameters ManagementLockObject) (*http.Request, error)

CreateOrUpdateAtSubscriptionLevelPreparer prepares the CreateOrUpdateAtSubscriptionLevel request.

func (ManagementLocksClient) CreateOrUpdateAtSubscriptionLevelResponder 

func (client ManagementLocksClient) CreateOrUpdateAtSubscriptionLevelResponder(resp *http.Response) (result ManagementLockObject, err error)

CreateOrUpdateAtSubscriptionLevelResponder handles the response to the CreateOrUpdateAtSubscriptionLevel request. The method always closes the http.Response Body.

func (ManagementLocksClient) CreateOrUpdateAtSubscriptionLevelSender 

func (client ManagementLocksClient) CreateOrUpdateAtSubscriptionLevelSender(req *http.Request) (*http.Response, error)

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

func (ManagementLocksClient) DeleteAtResourceGroupLevel 

func (client ManagementLocksClient) DeleteAtResourceGroupLevel(ctx context.Context, resourceGroupName string, lockName string) (result autorest.Response, err error)

DeleteAtResourceGroupLevel deletes the management lock of a resource group. Parameters: resourceGroupName - the resource group name. lockName - the name of lock.

func (ManagementLocksClient) DeleteAtResourceGroupLevelPreparer 

func (client ManagementLocksClient) DeleteAtResourceGroupLevelPreparer(ctx context.Context, resourceGroupName string, lockName string) (*http.Request, error)

DeleteAtResourceGroupLevelPreparer prepares the DeleteAtResourceGroupLevel request.

func (ManagementLocksClient) DeleteAtResourceGroupLevelResponder 

func (client ManagementLocksClient) DeleteAtResourceGroupLevelResponder(resp *http.Response) (result autorest.Response, err error)

DeleteAtResourceGroupLevelResponder handles the response to the DeleteAtResourceGroupLevel request. The method always closes the http.Response Body.

func (ManagementLocksClient) DeleteAtResourceGroupLevelSender 

func (client ManagementLocksClient) DeleteAtResourceGroupLevelSender(req *http.Request) (*http.Response, error)

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

func (ManagementLocksClient) DeleteAtResourceLevel 

func (client ManagementLocksClient) DeleteAtResourceLevel(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, lockName string) (result autorest.Response, err error)

DeleteAtResourceLevel deletes the management lock of a resource or any level below resource. Parameters: resourceGroupName - the name of the resource group. resourceProviderNamespace - resource identity. parentResourcePath - resource identity. resourceType - resource identity. resourceName - resource identity. lockName - the name of lock.

func (ManagementLocksClient) DeleteAtResourceLevelPreparer 

func (client ManagementLocksClient) DeleteAtResourceLevelPreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, lockName string) (*http.Request, error)

DeleteAtResourceLevelPreparer prepares the DeleteAtResourceLevel request.

func (ManagementLocksClient) DeleteAtResourceLevelResponder 

func (client ManagementLocksClient) DeleteAtResourceLevelResponder(resp *http.Response) (result autorest.Response, err error)

DeleteAtResourceLevelResponder handles the response to the DeleteAtResourceLevel request. The method always closes the http.Response Body.

func (ManagementLocksClient) DeleteAtResourceLevelSender 

func (client ManagementLocksClient) DeleteAtResourceLevelSender(req *http.Request) (*http.Response, error)

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

func (ManagementLocksClient) DeleteAtSubscriptionLevel 

func (client ManagementLocksClient) DeleteAtSubscriptionLevel(ctx context.Context, lockName string) (result autorest.Response, err error)

DeleteAtSubscriptionLevel deletes the management lock of a subscription. Parameters: lockName - the name of lock.

func (ManagementLocksClient) DeleteAtSubscriptionLevelPreparer 

func (client ManagementLocksClient) DeleteAtSubscriptionLevelPreparer(ctx context.Context, lockName string) (*http.Request, error)

DeleteAtSubscriptionLevelPreparer prepares the DeleteAtSubscriptionLevel request.

func (ManagementLocksClient) DeleteAtSubscriptionLevelResponder 

func (client ManagementLocksClient) DeleteAtSubscriptionLevelResponder(resp *http.Response) (result autorest.Response, err error)

DeleteAtSubscriptionLevelResponder handles the response to the DeleteAtSubscriptionLevel request. The method always closes the http.Response Body.

func (ManagementLocksClient) DeleteAtSubscriptionLevelSender 

func (client ManagementLocksClient) DeleteAtSubscriptionLevelSender(req *http.Request) (*http.Response, error)

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

func (ManagementLocksClient) Get 

func (client ManagementLocksClient) Get(ctx context.Context, lockName string) (result ManagementLockObject, err error)

Get gets the management lock of a scope. Parameters: lockName - name of the management lock.

func (ManagementLocksClient) GetAtResourceGroupLevel 

func (client ManagementLocksClient) GetAtResourceGroupLevel(ctx context.Context, resourceGroupName string, lockName string) (result ManagementLockObject, err error)

GetAtResourceGroupLevel gets a management lock at the resource group level. Parameters: resourceGroupName - the resource group name. lockName - the lock name.

func (ManagementLocksClient) GetAtResourceGroupLevelPreparer 

func (client ManagementLocksClient) GetAtResourceGroupLevelPreparer(ctx context.Context, resourceGroupName string, lockName string) (*http.Request, error)

GetAtResourceGroupLevelPreparer prepares the GetAtResourceGroupLevel request.

func (ManagementLocksClient) GetAtResourceGroupLevelResponder 

func (client ManagementLocksClient) GetAtResourceGroupLevelResponder(resp *http.Response) (result ManagementLockObject, err error)

GetAtResourceGroupLevelResponder handles the response to the GetAtResourceGroupLevel request. The method always closes the http.Response Body.

func (ManagementLocksClient) GetAtResourceGroupLevelSender 

func (client ManagementLocksClient) GetAtResourceGroupLevelSender(req *http.Request) (*http.Response, error)

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

func (ManagementLocksClient) GetPreparer 

func (client ManagementLocksClient) GetPreparer(ctx context.Context, lockName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ManagementLocksClient) GetResponder 

func (client ManagementLocksClient) GetResponder(resp *http.Response) (result ManagementLockObject, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ManagementLocksClient) GetSender 

func (client ManagementLocksClient) GetSender(req *http.Request) (*http.Response, error)

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

func (ManagementLocksClient) ListAtResourceGroupLevel 

func (client ManagementLocksClient) ListAtResourceGroupLevel(ctx context.Context, resourceGroupName string, filter string) (result ManagementLockListResultPage, err error)

ListAtResourceGroupLevel gets all the management locks of a resource group. Parameters: resourceGroupName - resource group name. filter - the filter to apply on the operation.

func (ManagementLocksClient) ListAtResourceGroupLevelComplete 

func (client ManagementLocksClient) ListAtResourceGroupLevelComplete(ctx context.Context, resourceGroupName string, filter string) (result ManagementLockListResultIterator, err error)

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

func (ManagementLocksClient) ListAtResourceGroupLevelPreparer 

func (client ManagementLocksClient) ListAtResourceGroupLevelPreparer(ctx context.Context, resourceGroupName string, filter string) (*http.Request, error)

ListAtResourceGroupLevelPreparer prepares the ListAtResourceGroupLevel request.

func (ManagementLocksClient) ListAtResourceGroupLevelResponder 

func (client ManagementLocksClient) ListAtResourceGroupLevelResponder(resp *http.Response) (result ManagementLockListResult, err error)

ListAtResourceGroupLevelResponder handles the response to the ListAtResourceGroupLevel request. The method always closes the http.Response Body.

func (ManagementLocksClient) ListAtResourceGroupLevelSender 

func (client ManagementLocksClient) ListAtResourceGroupLevelSender(req *http.Request) (*http.Response, error)

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

func (ManagementLocksClient) ListAtResourceLevel 

func (client ManagementLocksClient) ListAtResourceLevel(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string) (result ManagementLockListResultPage, err error)

ListAtResourceLevel gets all the management locks of a resource or any level below resource. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. resourceProviderNamespace - resource identity. parentResourcePath - resource identity. resourceType - resource identity. resourceName - resource identity. filter - the filter to apply on the operation.

func (ManagementLocksClient) ListAtResourceLevelComplete 

func (client ManagementLocksClient) ListAtResourceLevelComplete(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string) (result ManagementLockListResultIterator, err error)

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

func (ManagementLocksClient) ListAtResourceLevelPreparer 

func (client ManagementLocksClient) ListAtResourceLevelPreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string) (*http.Request, error)

ListAtResourceLevelPreparer prepares the ListAtResourceLevel request.

func (ManagementLocksClient) ListAtResourceLevelResponder 

func (client ManagementLocksClient) ListAtResourceLevelResponder(resp *http.Response) (result ManagementLockListResult, err error)

ListAtResourceLevelResponder handles the response to the ListAtResourceLevel request. The method always closes the http.Response Body.

func (ManagementLocksClient) ListAtResourceLevelSender 

func (client ManagementLocksClient) ListAtResourceLevelSender(req *http.Request) (*http.Response, error)

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

func (ManagementLocksClient) ListAtSubscriptionLevel 

func (client ManagementLocksClient) ListAtSubscriptionLevel(ctx context.Context, filter string) (result ManagementLockListResultPage, err error)

ListAtSubscriptionLevel gets all the management locks of a subscription. Parameters: filter - the filter to apply on the operation.

func (ManagementLocksClient) ListAtSubscriptionLevelComplete 

func (client ManagementLocksClient) ListAtSubscriptionLevelComplete(ctx context.Context, filter string) (result ManagementLockListResultIterator, err error)

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

func (ManagementLocksClient) ListAtSubscriptionLevelPreparer 

func (client ManagementLocksClient) ListAtSubscriptionLevelPreparer(ctx context.Context, filter string) (*http.Request, error)

ListAtSubscriptionLevelPreparer prepares the ListAtSubscriptionLevel request.

func (ManagementLocksClient) ListAtSubscriptionLevelResponder 

func (client ManagementLocksClient) ListAtSubscriptionLevelResponder(resp *http.Response) (result ManagementLockListResult, err error)

ListAtSubscriptionLevelResponder handles the response to the ListAtSubscriptionLevel request. The method always closes the http.Response Body.

func (ManagementLocksClient) ListAtSubscriptionLevelSender 

func (client ManagementLocksClient) ListAtSubscriptionLevelSender(req *http.Request) (*http.Response, error)

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

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.