locks

package
v0.0.0-...-1fbdb1f Latest Latest
Warning

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

 Go to latest Published: Oct 6, 2022 License: MIT Imports: 9 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 (
	// 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 AuthorizationOperationsClient 

type AuthorizationOperationsClient struct {
	BaseClient
}

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

func NewAuthorizationOperationsClient 

func NewAuthorizationOperationsClient(subscriptionID string) AuthorizationOperationsClient

NewAuthorizationOperationsClient creates an instance of the AuthorizationOperationsClient client.

func NewAuthorizationOperationsClientWithBaseURI 

func NewAuthorizationOperationsClientWithBaseURI(baseURI string, subscriptionID string) AuthorizationOperationsClient

NewAuthorizationOperationsClientWithBaseURI creates an instance of the AuthorizationOperationsClient 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 (AuthorizationOperationsClient) List 

func (client AuthorizationOperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)

List lists all of the available Microsoft.Authorization REST API operations.

func (AuthorizationOperationsClient) ListComplete 

func (client AuthorizationOperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)

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

func (AuthorizationOperationsClient) ListPreparer 

func (client AuthorizationOperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (AuthorizationOperationsClient) ListResponder 

func (client AuthorizationOperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)

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

func (AuthorizationOperationsClient) ListSender 

func (client AuthorizationOperationsClient) 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 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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

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 use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

ManagementLockListResult the list of 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(cur ManagementLockListResult, 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 resource ID of the lock.
	ID *string `json:"id,omitempty"`
	// Type - READ-ONLY; The resource type of the lock - Microsoft.Authorization/locks.
	Type *string `json:"type,omitempty"`
	// Name - READ-ONLY; The name of the lock.
	Name *string `json:"name,omitempty"`
}

ManagementLockObject the 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 ManagementLockOwner 

type ManagementLockOwner struct {
	// ApplicationID - The application ID of the lock owner.
	ApplicationID *string `json:"applicationId,omitempty"`
}

ManagementLockOwner lock owner properties.

type ManagementLockProperties 

type ManagementLockProperties struct {
	// Level - The level of the lock. Possible values are: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete means authorized users are able to read and modify the resources, but not delete. ReadOnly means authorized users can only read from a resource, but they can't modify or delete it. Possible values include: 'NotSpecified', 'CanNotDelete', 'ReadOnly'
	Level LockLevel `json:"level,omitempty"`
	// Notes - Notes about the lock. Maximum of 512 characters.
	Notes *string `json:"notes,omitempty"`
	// Owners - The owners of the lock.
	Owners *[]ManagementLockOwner `json:"owners,omitempty"`
}

ManagementLockProperties the lock properties.

type ManagementLocksClient 

type ManagementLocksClient struct {
	BaseClient
}

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ManagementLocksClient) CreateOrUpdateAtResourceGroupLevel 

func (client ManagementLocksClient) CreateOrUpdateAtResourceGroupLevel(ctx context.Context, 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. Parameters: resourceGroupName - the name of the resource group to lock. lockName - the lock name. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, \, ?, /, or any control characters. 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 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. Parameters: resourceGroupName - the name of the resource group containing the resource to lock. resourceProviderNamespace - the resource provider namespace of the resource to lock. parentResourcePath - the parent resource identity. resourceType - the resource type of the resource to lock. resourceName - the name of the resource to lock. lockName - the name of lock. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, \, ?, /, or any control characters. parameters - parameters for creating or updating a management lock.

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 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. Parameters: lockName - the name of lock. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, \, ?, /, or any control characters. 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) CreateOrUpdateByScope 

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

CreateOrUpdateByScope create or update a management lock by scope. Parameters: scope - the scope for the lock. When providing a scope for the assignment, use '/subscriptions/{subscriptionId}' for subscriptions, '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}' for resource groups, and '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePathIfPresent}/{resourceType}/{resourceName}' for resources. lockName - the name of lock. parameters - create or update management lock parameters.

func (ManagementLocksClient) CreateOrUpdateByScopePreparer 

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

CreateOrUpdateByScopePreparer prepares the CreateOrUpdateByScope request.

func (ManagementLocksClient) CreateOrUpdateByScopeResponder 

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

CreateOrUpdateByScopeResponder handles the response to the CreateOrUpdateByScope request. The method always closes the http.Response Body.

func (ManagementLocksClient) CreateOrUpdateByScopeSender 

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

CreateOrUpdateByScopeSender sends the CreateOrUpdateByScope 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 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. Parameters: resourceGroupName - the name of the resource group containing the lock. lockName - the name of lock to delete.

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 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. Parameters: resourceGroupName - the name of the resource group containing the resource with the lock to delete. resourceProviderNamespace - the resource provider namespace of the resource with the lock to delete. parentResourcePath - the parent resource identity. resourceType - the resource type of the resource with the lock to delete. resourceName - the name of the resource with the lock to delete. lockName - the name of the lock to delete.

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 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. Parameters: lockName - the name of lock to delete.

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) DeleteByScope 

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

DeleteByScope delete a management lock by scope. Parameters: scope - the scope for the lock. lockName - the name of lock.

func (ManagementLocksClient) DeleteByScopePreparer 

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

DeleteByScopePreparer prepares the DeleteByScope request.

func (ManagementLocksClient) DeleteByScopeResponder 

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

DeleteByScopeResponder handles the response to the DeleteByScope request. The method always closes the http.Response Body.

func (ManagementLocksClient) DeleteByScopeSender 

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

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

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 name of the locked resource group. lockName - the name of the lock to get.

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) GetAtResourceLevel 

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

GetAtResourceLevel get the management lock of a resource or any level below resource. Parameters: resourceGroupName - the name of the resource group. resourceProviderNamespace - the namespace of the resource provider. parentResourcePath - an extra path parameter needed in some services, like SQL Databases. resourceType - the type of the resource. resourceName - the name of the resource. lockName - the name of lock.

func (ManagementLocksClient) GetAtResourceLevelPreparer 

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

GetAtResourceLevelPreparer prepares the GetAtResourceLevel request.

func (ManagementLocksClient) GetAtResourceLevelResponder 

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

GetAtResourceLevelResponder handles the response to the GetAtResourceLevel request. The method always closes the http.Response Body.

func (ManagementLocksClient) GetAtResourceLevelSender 

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

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

func (ManagementLocksClient) GetAtSubscriptionLevel 

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

GetAtSubscriptionLevel gets a management lock at the subscription level. Parameters: lockName - the name of the lock to get.

func (ManagementLocksClient) GetAtSubscriptionLevelPreparer 

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

GetAtSubscriptionLevelPreparer prepares the GetAtSubscriptionLevel request.

func (ManagementLocksClient) GetAtSubscriptionLevelResponder 

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

GetAtSubscriptionLevelResponder handles the response to the GetAtSubscriptionLevel request. The method always closes the http.Response Body.

func (ManagementLocksClient) GetAtSubscriptionLevelSender 

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

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

func (ManagementLocksClient) GetByScope 

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

GetByScope get a management lock by scope. Parameters: scope - the scope for the lock. lockName - the name of lock.

func (ManagementLocksClient) GetByScopePreparer 

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

GetByScopePreparer prepares the GetByScope request.

func (ManagementLocksClient) GetByScopeResponder 

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

GetByScopeResponder handles the response to the GetByScope request. The method always closes the http.Response Body.

func (ManagementLocksClient) GetByScopeSender 

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

GetByScopeSender sends the GetByScope 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 for a resource group. Parameters: resourceGroupName - the name of the resource group containing the locks to get. 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 for a resource or any level below resource. Parameters: resourceGroupName - the name of the resource group containing the locked resource. The name is case insensitive. resourceProviderNamespace - the namespace of the resource provider. parentResourcePath - the parent resource identity. resourceType - the resource type of the locked resource. resourceName - the name of the locked resource. 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 for 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.

func (ManagementLocksClient) ListByScope 

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

ListByScope gets all the management locks for a scope. Parameters: scope - the scope for the lock. When providing a scope for the assignment, use '/subscriptions/{subscriptionId}' for subscriptions, '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}' for resource groups, and '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePathIfPresent}/{resourceType}/{resourceName}' for resources. filter - the filter to apply on the operation.

func (ManagementLocksClient) ListByScopeComplete 

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

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

func (ManagementLocksClient) ListByScopePreparer 

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

ListByScopePreparer prepares the ListByScope request.

func (ManagementLocksClient) ListByScopeResponder 

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

ListByScopeResponder handles the response to the ListByScope request. The method always closes the http.Response Body.

func (ManagementLocksClient) ListByScopeSender 

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

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

type Operation 

type Operation struct {
	// Name - Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`
	// Display - The object that represents the operation.
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation microsoft.Authorization operation

type OperationDisplay 

type OperationDisplay struct {
	// Provider - Service provider: Microsoft.Authorization
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource on which the operation is performed: Profile, endpoint, etc.
	Resource *string `json:"resource,omitempty"`
	// Operation - Operation type: Read, write, delete, etc.
	Operation *string `json:"operation,omitempty"`
}

OperationDisplay the object that represents the operation.

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - List of Microsoft.Authorization operations.
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationListResult result of the request to list Microsoft.Authorization operations. It contains a list of operations and a URL link to get the next set of results.

func (OperationListResult) IsEmpty 

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator 

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator 

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next 

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

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

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response 

func (iter OperationListResultIterator) Response() OperationListResult

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

func (OperationListResultIterator) Value 

func (iter OperationListResultIterator) Value() Operation

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

type OperationListResultPage 

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage 

func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next 

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

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

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response 

func (page OperationListResultPage) Response() OperationListResult

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

func (OperationListResultPage) Values 

func (page OperationListResultPage) Values() []Operation

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

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.