locks

package
v7.0.0-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Nov 29, 2016 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

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

Azure resources can be locked to prevent other users in your organization from deleting or modifying resources.

Index

Constants

View Source 
const (
	// APIVersion is the version of the Locks
	APIVersion = "2016-09-01"

	// 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 LockLevel 

type LockLevel string

LockLevel enumerates the values for lock level. 

const (
	// CanNotDelete specifies the can not delete state for lock level.
	CanNotDelete LockLevel = "CanNotDelete"
	// NotSpecified specifies the not specified state for lock level.
	NotSpecified LockLevel = "NotSpecified"
	// ReadOnly specifies the read only state for lock level.
	ReadOnly LockLevel = "ReadOnly"
)

type ManagementClient 

type ManagementClient struct {
	autorest.Client
	BaseURI        string
	APIVersion     string
	SubscriptionID string
}

ManagementClient is the base client for Locks.

func New 

func New(subscriptionID string) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

type ManagementLockListResult 

type ManagementLockListResult struct {
	autorest.Response `json:"-"`
	Value             *[]ManagementLockObject `json:"value,omitempty"`
	NextLink          *string                 `json:"nextLink,omitempty"`
}

ManagementLockListResult is the list of locks.

func (ManagementLockListResult) ManagementLockListResultPreparer 

func (client ManagementLockListResult) ManagementLockListResultPreparer() (*http.Request, error)

ManagementLockListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type ManagementLockObject 

type ManagementLockObject struct {
	autorest.Response         `json:"-"`
	*ManagementLockProperties `json:"properties,omitempty"`
	ID                        *string `json:"id,omitempty"`
	Type                      *string `json:"type,omitempty"`
	Name                      *string `json:"name,omitempty"`
}

ManagementLockObject is the lock information.

type ManagementLockOwner 

type ManagementLockOwner struct {
	ApplicationID *string `json:"applicationId,omitempty"`
}

ManagementLockOwner is lock owner properties.

type ManagementLockProperties 

type ManagementLockProperties struct {
	Level  LockLevel              `json:"level,omitempty"`
	Notes  *string                `json:"notes,omitempty"`
	Owners *[]ManagementLockOwner `json:"owners,omitempty"`
}

ManagementLockProperties is the lock properties.

type ManagementLocksClient 

type ManagementLocksClient struct {
	ManagementClient
}

ManagementLocksClient is the azure resources can be locked to prevent other users in your organization from deleting or modifying resources.

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(resourceGroupName string, lockName string, parameters ManagementLockObject) (result ManagementLockObject, err error)

CreateOrUpdateAtResourceGroupLevel when you apply a lock at a parent scope, all child resources inherit the same lock. To create management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.

resourceGroupName is the name of the resource group to lock. lockName is the lock name. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, \, ?, /, or any control characters. parameters is the management lock parameters.

func (ManagementLocksClient) CreateOrUpdateAtResourceGroupLevelPreparer 

func (client ManagementLocksClient) CreateOrUpdateAtResourceGroupLevelPreparer(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(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, lockName string, parameters ManagementLockObject) (result ManagementLockObject, err error)

CreateOrUpdateAtResourceLevel when you apply a lock at a parent scope, all child resources inherit the same lock. To create management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.

resourceGroupName is the name of the resource group containing the resource to lock. resourceProviderNamespace is the resource provider namespace of the resource to lock. parentResourcePath is the parent resource identity. resourceType is the resource type of the resource to lock. resourceName is the name of the resource to lock. lockName is the name of lock. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, \, ?, /, or any control characters. parameters is parameters for creating or updating a management lock.

func (ManagementLocksClient) CreateOrUpdateAtResourceLevelPreparer 

func (client ManagementLocksClient) CreateOrUpdateAtResourceLevelPreparer(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(lockName string, parameters ManagementLockObject) (result ManagementLockObject, err error)

CreateOrUpdateAtSubscriptionLevel when you apply a lock at a parent scope, all child resources inherit the same lock. To create management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.

lockName is the name of lock. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, \, ?, /, or any control characters. parameters is the management lock parameters.

func (ManagementLocksClient) CreateOrUpdateAtSubscriptionLevelPreparer 

func (client ManagementLocksClient) CreateOrUpdateAtSubscriptionLevelPreparer(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(resourceGroupName string, lockName string) (result autorest.Response, err error)

DeleteAtResourceGroupLevel to delete management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.

resourceGroupName is the name of the resource group containing the lock. lockName is the name of lock to delete.

func (ManagementLocksClient) DeleteAtResourceGroupLevelPreparer 

func (client ManagementLocksClient) DeleteAtResourceGroupLevelPreparer(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(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, lockName string) (result autorest.Response, err error)

DeleteAtResourceLevel to delete management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.

resourceGroupName is the name of the resource group containing the resource with the lock to delete. resourceProviderNamespace is the resource provider namespace of the resource with the lock to delete. parentResourcePath is the parent resource identity. resourceType is the resource type of the resource with the lock to delete. resourceName is the name of the resource with the lock to delete. lockName is the name of the lock to delete.

func (ManagementLocksClient) DeleteAtResourceLevelPreparer 

func (client ManagementLocksClient) DeleteAtResourceLevelPreparer(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(lockName string) (result autorest.Response, err error)

DeleteAtSubscriptionLevel to delete management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.

lockName is the name of lock to delete.

func (ManagementLocksClient) DeleteAtSubscriptionLevelPreparer 

func (client ManagementLocksClient) DeleteAtSubscriptionLevelPreparer(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(lockName string) (result ManagementLockObject, err error)

Get gets a management lock at the subscription level.

lockName is the name of the lock to get.

func (ManagementLocksClient) GetAtResourceGroupLevel 

func (client ManagementLocksClient) GetAtResourceGroupLevel(resourceGroupName string, lockName string) (result ManagementLockObject, err error)

GetAtResourceGroupLevel gets a management lock at the resource group level.

resourceGroupName is the name of the locked resource group. lockName is the name of the lock to get.

func (ManagementLocksClient) GetAtResourceGroupLevelPreparer 

func (client ManagementLocksClient) GetAtResourceGroupLevelPreparer(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(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(resourceGroupName string, filter string) (result ManagementLockListResult, err error)

ListAtResourceGroupLevel gets all the management locks for a resource group.

resourceGroupName is the name of the resource group containing the locks to get. filter is the filter to apply on the operation.

func (ManagementLocksClient) ListAtResourceGroupLevelNextResults 

func (client ManagementLocksClient) ListAtResourceGroupLevelNextResults(lastResults ManagementLockListResult) (result ManagementLockListResult, err error)

ListAtResourceGroupLevelNextResults retrieves the next set of results, if any.

func (ManagementLocksClient) ListAtResourceGroupLevelPreparer 

func (client ManagementLocksClient) ListAtResourceGroupLevelPreparer(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(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string) (result ManagementLockListResult, err error)

ListAtResourceLevel gets all the management locks for a resource or any level below resource.

resourceGroupName is the name of the resource group containing the locked resource. The name is case insensitive. resourceProviderNamespace is the namespace of the resource provider. parentResourcePath is the parent resource identity. resourceType is the resource type of the locked resource. resourceName is the name of the locked resource. filter is the filter to apply on the operation.

func (ManagementLocksClient) ListAtResourceLevelNextResults 

func (client ManagementLocksClient) ListAtResourceLevelNextResults(lastResults ManagementLockListResult) (result ManagementLockListResult, err error)

ListAtResourceLevelNextResults retrieves the next set of results, if any.

func (ManagementLocksClient) ListAtResourceLevelPreparer 

func (client ManagementLocksClient) ListAtResourceLevelPreparer(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(filter string) (result ManagementLockListResult, err error)

ListAtSubscriptionLevel gets all the management locks for a subscription.

filter is the filter to apply on the operation.

func (ManagementLocksClient) ListAtSubscriptionLevelNextResults 

func (client ManagementLocksClient) ListAtSubscriptionLevelNextResults(lastResults ManagementLockListResult) (result ManagementLockListResult, err error)

ListAtSubscriptionLevelNextResults retrieves the next set of results, if any.

func (ManagementLocksClient) ListAtSubscriptionLevelPreparer 

func (client ManagementLocksClient) ListAtSubscriptionLevelPreparer(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

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.