authorization

package
v56.1.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Aug 5, 2021 License: MIT Imports: 9 Imported by: 672

Documentation

Overview

Package authorization implements the Azure ARM Authorization service API version 2015-07-01.

Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role definitions and role assignments. A role definition describes the set of actions that can be performed on resources. A role assignment grants access to Azure Active Directory users.

Index

Constants

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

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 ClassicAdministrator 

type ClassicAdministrator struct {
	// ID - The ID of the administrator.
	ID *string `json:"id,omitempty"`
	// Name - The name of the administrator.
	Name *string `json:"name,omitempty"`
	// Type - The type of the administrator.
	Type *string `json:"type,omitempty"`
	// ClassicAdministratorProperties - Properties for the classic administrator.
	*ClassicAdministratorProperties `json:"properties,omitempty"`
}

ClassicAdministrator classic Administrators

func (ClassicAdministrator) MarshalJSON 

func (ca ClassicAdministrator) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ClassicAdministrator.

func (*ClassicAdministrator) UnmarshalJSON 

func (ca *ClassicAdministrator) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ClassicAdministrator struct.

type ClassicAdministratorListResult 

type ClassicAdministratorListResult struct {
	autorest.Response `json:"-"`
	// Value - An array of administrators.
	Value *[]ClassicAdministrator `json:"value,omitempty"`
	// NextLink - The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

ClassicAdministratorListResult classicAdministrator list result information.

func (ClassicAdministratorListResult) IsEmpty 

func (calr ClassicAdministratorListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ClassicAdministratorListResultIterator 

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

ClassicAdministratorListResultIterator provides access to a complete listing of ClassicAdministrator values.

func NewClassicAdministratorListResultIterator 

func NewClassicAdministratorListResultIterator(page ClassicAdministratorListResultPage) ClassicAdministratorListResultIterator

Creates a new instance of the ClassicAdministratorListResultIterator type.

func (*ClassicAdministratorListResultIterator) Next 

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

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

func (iter ClassicAdministratorListResultIterator) NotDone() bool

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

func (ClassicAdministratorListResultIterator) Response 

func (iter ClassicAdministratorListResultIterator) Response() ClassicAdministratorListResult

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

func (ClassicAdministratorListResultIterator) Value 

func (iter ClassicAdministratorListResultIterator) Value() ClassicAdministrator

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

type ClassicAdministratorListResultPage 

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

ClassicAdministratorListResultPage contains a page of ClassicAdministrator values.

func NewClassicAdministratorListResultPage 

func NewClassicAdministratorListResultPage(cur ClassicAdministratorListResult, getNextPage func(context.Context, ClassicAdministratorListResult) (ClassicAdministratorListResult, error)) ClassicAdministratorListResultPage

Creates a new instance of the ClassicAdministratorListResultPage type.

func (*ClassicAdministratorListResultPage) Next 

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

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

func (page ClassicAdministratorListResultPage) NotDone() bool

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

func (ClassicAdministratorListResultPage) Response 

func (page ClassicAdministratorListResultPage) Response() ClassicAdministratorListResult

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

func (ClassicAdministratorListResultPage) Values 

func (page ClassicAdministratorListResultPage) Values() []ClassicAdministrator

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

type ClassicAdministratorProperties 

type ClassicAdministratorProperties struct {
	// EmailAddress - The email address of the administrator.
	EmailAddress *string `json:"emailAddress,omitempty"`
	// Role - The role of the administrator.
	Role *string `json:"role,omitempty"`
}

ClassicAdministratorProperties classic Administrator properties.

type ClassicAdministratorsClient 

type ClassicAdministratorsClient struct {
	BaseClient
}

ClassicAdministratorsClient is the role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role definitions and role assignments. A role definition describes the set of actions that can be performed on resources. A role assignment grants access to Azure Active Directory users.

func NewClassicAdministratorsClient 

func NewClassicAdministratorsClient(subscriptionID string) ClassicAdministratorsClient

NewClassicAdministratorsClient creates an instance of the ClassicAdministratorsClient client.

func NewClassicAdministratorsClientWithBaseURI 

func NewClassicAdministratorsClientWithBaseURI(baseURI string, subscriptionID string) ClassicAdministratorsClient

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

func (client ClassicAdministratorsClient) List(ctx context.Context) (result ClassicAdministratorListResultPage, err error)

List gets service administrator, account administrator, and co-administrators for the subscription.

func (ClassicAdministratorsClient) ListComplete 

func (client ClassicAdministratorsClient) ListComplete(ctx context.Context) (result ClassicAdministratorListResultIterator, err error)

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

func (ClassicAdministratorsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (ClassicAdministratorsClient) ListResponder 

func (client ClassicAdministratorsClient) ListResponder(resp *http.Response) (result ClassicAdministratorListResult, err error)

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

func (ClassicAdministratorsClient) ListSender 

func (client ClassicAdministratorsClient) 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 GlobalAdministratorClient 

type GlobalAdministratorClient struct {
	BaseClient
}

GlobalAdministratorClient is the role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role definitions and role assignments. A role definition describes the set of actions that can be performed on resources. A role assignment grants access to Azure Active Directory users.

func NewGlobalAdministratorClient 

func NewGlobalAdministratorClient(subscriptionID string) GlobalAdministratorClient

NewGlobalAdministratorClient creates an instance of the GlobalAdministratorClient client.

func NewGlobalAdministratorClientWithBaseURI 

func NewGlobalAdministratorClientWithBaseURI(baseURI string, subscriptionID string) GlobalAdministratorClient

NewGlobalAdministratorClientWithBaseURI creates an instance of the GlobalAdministratorClient 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 (GlobalAdministratorClient) ElevateAccess 

func (client GlobalAdministratorClient) ElevateAccess(ctx context.Context) (result autorest.Response, err error)

ElevateAccess elevates access for a Global Administrator.

func (GlobalAdministratorClient) ElevateAccessPreparer 

func (client GlobalAdministratorClient) ElevateAccessPreparer(ctx context.Context) (*http.Request, error)

ElevateAccessPreparer prepares the ElevateAccess request.

func (GlobalAdministratorClient) ElevateAccessResponder 

func (client GlobalAdministratorClient) ElevateAccessResponder(resp *http.Response) (result autorest.Response, err error)

ElevateAccessResponder handles the response to the ElevateAccess request. The method always closes the http.Response Body.

func (GlobalAdministratorClient) ElevateAccessSender 

func (client GlobalAdministratorClient) ElevateAccessSender(req *http.Request) (*http.Response, error)

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

type Permission 

type Permission struct {
	// Actions - Allowed actions.
	Actions *[]string `json:"actions,omitempty"`
	// NotActions - Denied actions.
	NotActions *[]string `json:"notActions,omitempty"`
}

Permission role definition permissions.

type PermissionGetResult 

type PermissionGetResult struct {
	autorest.Response `json:"-"`
	// Value - An array of permissions.
	Value *[]Permission `json:"value,omitempty"`
	// NextLink - The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

PermissionGetResult permissions information.

func (PermissionGetResult) IsEmpty 

func (pgr PermissionGetResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PermissionGetResultIterator 

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

PermissionGetResultIterator provides access to a complete listing of Permission values.

func NewPermissionGetResultIterator 

func NewPermissionGetResultIterator(page PermissionGetResultPage) PermissionGetResultIterator

Creates a new instance of the PermissionGetResultIterator type.

func (*PermissionGetResultIterator) Next 

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

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

func (iter PermissionGetResultIterator) NotDone() bool

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

func (PermissionGetResultIterator) Response 

func (iter PermissionGetResultIterator) Response() PermissionGetResult

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

func (PermissionGetResultIterator) Value 

func (iter PermissionGetResultIterator) Value() Permission

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

type PermissionGetResultPage 

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

PermissionGetResultPage contains a page of Permission values.

func NewPermissionGetResultPage 

func NewPermissionGetResultPage(cur PermissionGetResult, getNextPage func(context.Context, PermissionGetResult) (PermissionGetResult, error)) PermissionGetResultPage

Creates a new instance of the PermissionGetResultPage type.

func (*PermissionGetResultPage) Next 

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

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

func (page PermissionGetResultPage) NotDone() bool

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

func (PermissionGetResultPage) Response 

func (page PermissionGetResultPage) Response() PermissionGetResult

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

func (PermissionGetResultPage) Values 

func (page PermissionGetResultPage) Values() []Permission

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

type PermissionsClient 

type PermissionsClient struct {
	BaseClient
}

PermissionsClient is the role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role definitions and role assignments. A role definition describes the set of actions that can be performed on resources. A role assignment grants access to Azure Active Directory users.

func NewPermissionsClient 

func NewPermissionsClient(subscriptionID string) PermissionsClient

NewPermissionsClient creates an instance of the PermissionsClient client.

func NewPermissionsClientWithBaseURI 

func NewPermissionsClientWithBaseURI(baseURI string, subscriptionID string) PermissionsClient

NewPermissionsClientWithBaseURI creates an instance of the PermissionsClient 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 (PermissionsClient) ListForResource 

func (client PermissionsClient) ListForResource(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string) (result PermissionGetResultPage, err error)

ListForResource gets all permissions the caller has for a resource. Parameters: resourceGroupName - the name of the resource group containing the resource. The name is case insensitive. resourceProviderNamespace - the namespace of the resource provider. parentResourcePath - the parent resource identity. resourceType - the resource type of the resource. resourceName - the name of the resource to get the permissions for.

func (PermissionsClient) ListForResourceComplete 

func (client PermissionsClient) ListForResourceComplete(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string) (result PermissionGetResultIterator, err error)

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

func (PermissionsClient) ListForResourceGroup 

func (client PermissionsClient) ListForResourceGroup(ctx context.Context, resourceGroupName string) (result PermissionGetResultPage, err error)

ListForResourceGroup gets all permissions the caller has for a resource group. Parameters: resourceGroupName - the name of the resource group to get the permissions for. The name is case insensitive.

func (PermissionsClient) ListForResourceGroupComplete 

func (client PermissionsClient) ListForResourceGroupComplete(ctx context.Context, resourceGroupName string) (result PermissionGetResultIterator, err error)

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

func (PermissionsClient) ListForResourceGroupPreparer 

func (client PermissionsClient) ListForResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListForResourceGroupPreparer prepares the ListForResourceGroup request.

func (PermissionsClient) ListForResourceGroupResponder 

func (client PermissionsClient) ListForResourceGroupResponder(resp *http.Response) (result PermissionGetResult, err error)

ListForResourceGroupResponder handles the response to the ListForResourceGroup request. The method always closes the http.Response Body.

func (PermissionsClient) ListForResourceGroupSender 

func (client PermissionsClient) ListForResourceGroupSender(req *http.Request) (*http.Response, error)

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

func (PermissionsClient) ListForResourcePreparer 

func (client PermissionsClient) ListForResourcePreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string) (*http.Request, error)

ListForResourcePreparer prepares the ListForResource request.

func (PermissionsClient) ListForResourceResponder 

func (client PermissionsClient) ListForResourceResponder(resp *http.Response) (result PermissionGetResult, err error)

ListForResourceResponder handles the response to the ListForResource request. The method always closes the http.Response Body.

func (PermissionsClient) ListForResourceSender 

func (client PermissionsClient) ListForResourceSender(req *http.Request) (*http.Response, error)

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

type ProviderOperation 

type ProviderOperation struct {
	// Name - The operation name.
	Name *string `json:"name,omitempty"`
	// DisplayName - The operation display name.
	DisplayName *string `json:"displayName,omitempty"`
	// Description - The operation description.
	Description *string `json:"description,omitempty"`
	// Origin - The operation origin.
	Origin *string `json:"origin,omitempty"`
	// Properties - The operation properties.
	Properties interface{} `json:"properties,omitempty"`
}

ProviderOperation operation

type ProviderOperationsMetadata 

type ProviderOperationsMetadata struct {
	autorest.Response `json:"-"`
	// ID - The provider id.
	ID *string `json:"id,omitempty"`
	// Name - The provider name.
	Name *string `json:"name,omitempty"`
	// Type - The provider type.
	Type *string `json:"type,omitempty"`
	// DisplayName - The provider display name.
	DisplayName *string `json:"displayName,omitempty"`
	// ResourceTypes - The provider resource types
	ResourceTypes *[]ResourceType `json:"resourceTypes,omitempty"`
	// Operations - The provider operations.
	Operations *[]ProviderOperation `json:"operations,omitempty"`
}

ProviderOperationsMetadata provider Operations metadata

type ProviderOperationsMetadataClient 

type ProviderOperationsMetadataClient struct {
	BaseClient
}

ProviderOperationsMetadataClient is the role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role definitions and role assignments. A role definition describes the set of actions that can be performed on resources. A role assignment grants access to Azure Active Directory users.

func NewProviderOperationsMetadataClient 

func NewProviderOperationsMetadataClient(subscriptionID string) ProviderOperationsMetadataClient

NewProviderOperationsMetadataClient creates an instance of the ProviderOperationsMetadataClient client.

func NewProviderOperationsMetadataClientWithBaseURI 

func NewProviderOperationsMetadataClientWithBaseURI(baseURI string, subscriptionID string) ProviderOperationsMetadataClient

NewProviderOperationsMetadataClientWithBaseURI creates an instance of the ProviderOperationsMetadataClient 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 (ProviderOperationsMetadataClient) Get 

func (client ProviderOperationsMetadataClient) Get(ctx context.Context, resourceProviderNamespace string, APIVersion string, expand string) (result ProviderOperationsMetadata, err error)

Get gets provider operations metadata for the specified resource provider. Parameters: resourceProviderNamespace - the namespace of the resource provider. APIVersion - the API version to use for the operation. expand - specifies whether to expand the values.

func (ProviderOperationsMetadataClient) GetPreparer 

func (client ProviderOperationsMetadataClient) GetPreparer(ctx context.Context, resourceProviderNamespace string, APIVersion string, expand string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ProviderOperationsMetadataClient) GetResponder 

func (client ProviderOperationsMetadataClient) GetResponder(resp *http.Response) (result ProviderOperationsMetadata, err error)

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

func (ProviderOperationsMetadataClient) GetSender 

func (client ProviderOperationsMetadataClient) 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 (ProviderOperationsMetadataClient) List 

func (client ProviderOperationsMetadataClient) List(ctx context.Context, APIVersion string, expand string) (result ProviderOperationsMetadataListResultPage, err error)

List gets provider operations metadata for all resource providers. Parameters: APIVersion - the API version to use for this operation. expand - specifies whether to expand the values.

func (ProviderOperationsMetadataClient) ListComplete 

func (client ProviderOperationsMetadataClient) ListComplete(ctx context.Context, APIVersion string, expand string) (result ProviderOperationsMetadataListResultIterator, err error)

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

func (ProviderOperationsMetadataClient) ListPreparer 

func (client ProviderOperationsMetadataClient) ListPreparer(ctx context.Context, APIVersion string, expand string) (*http.Request, error)

ListPreparer prepares the List request.

func (ProviderOperationsMetadataClient) ListResponder 

func (client ProviderOperationsMetadataClient) ListResponder(resp *http.Response) (result ProviderOperationsMetadataListResult, err error)

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

func (ProviderOperationsMetadataClient) ListSender 

func (client ProviderOperationsMetadataClient) 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 ProviderOperationsMetadataListResult 

type ProviderOperationsMetadataListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of providers.
	Value *[]ProviderOperationsMetadata `json:"value,omitempty"`
	// NextLink - The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

ProviderOperationsMetadataListResult provider operations metadata list

func (ProviderOperationsMetadataListResult) IsEmpty 

func (pomlr ProviderOperationsMetadataListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ProviderOperationsMetadataListResultIterator 

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

ProviderOperationsMetadataListResultIterator provides access to a complete listing of ProviderOperationsMetadata values.

func NewProviderOperationsMetadataListResultIterator 

func NewProviderOperationsMetadataListResultIterator(page ProviderOperationsMetadataListResultPage) ProviderOperationsMetadataListResultIterator

Creates a new instance of the ProviderOperationsMetadataListResultIterator type.

func (*ProviderOperationsMetadataListResultIterator) Next 

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

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

func (iter ProviderOperationsMetadataListResultIterator) NotDone() bool

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

func (ProviderOperationsMetadataListResultIterator) Response 

func (iter ProviderOperationsMetadataListResultIterator) Response() ProviderOperationsMetadataListResult

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

func (ProviderOperationsMetadataListResultIterator) Value 

func (iter ProviderOperationsMetadataListResultIterator) Value() ProviderOperationsMetadata

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

type ProviderOperationsMetadataListResultPage 

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

ProviderOperationsMetadataListResultPage contains a page of ProviderOperationsMetadata values.

func NewProviderOperationsMetadataListResultPage 

func NewProviderOperationsMetadataListResultPage(cur ProviderOperationsMetadataListResult, getNextPage func(context.Context, ProviderOperationsMetadataListResult) (ProviderOperationsMetadataListResult, error)) ProviderOperationsMetadataListResultPage

Creates a new instance of the ProviderOperationsMetadataListResultPage type.

func (*ProviderOperationsMetadataListResultPage) Next 

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

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

func (page ProviderOperationsMetadataListResultPage) NotDone() bool

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

func (ProviderOperationsMetadataListResultPage) Response 

func (page ProviderOperationsMetadataListResultPage) Response() ProviderOperationsMetadataListResult

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

func (ProviderOperationsMetadataListResultPage) Values 

func (page ProviderOperationsMetadataListResultPage) Values() []ProviderOperationsMetadata

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

type ResourceType 

type ResourceType struct {
	// Name - The resource type name.
	Name *string `json:"name,omitempty"`
	// DisplayName - The resource type display name.
	DisplayName *string `json:"displayName,omitempty"`
	// Operations - The resource type operations.
	Operations *[]ProviderOperation `json:"operations,omitempty"`
}

ResourceType resource Type

type RoleAssignment 

type RoleAssignment struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The role assignment ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The role assignment name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The role assignment type.
	Type *string `json:"type,omitempty"`
	// Properties - Role assignment properties.
	Properties *RoleAssignmentPropertiesWithScope `json:"properties,omitempty"`
}

RoleAssignment role Assignments

func (RoleAssignment) MarshalJSON 

func (ra RoleAssignment) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RoleAssignment.

type RoleAssignmentCreateParameters 

type RoleAssignmentCreateParameters struct {
	// Properties - Role assignment properties.
	Properties *RoleAssignmentProperties `json:"properties,omitempty"`
}

RoleAssignmentCreateParameters role assignment create parameters.

type RoleAssignmentFilter 

type RoleAssignmentFilter struct {
	// PrincipalID - Returns role assignment of the specific principal.
	PrincipalID *string `json:"principalId,omitempty"`
}

RoleAssignmentFilter role Assignments filter

type RoleAssignmentListResult 

type RoleAssignmentListResult struct {
	autorest.Response `json:"-"`
	// Value - Role assignment list.
	Value *[]RoleAssignment `json:"value,omitempty"`
	// NextLink - The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

RoleAssignmentListResult role assignment list operation result.

func (RoleAssignmentListResult) IsEmpty 

func (ralr RoleAssignmentListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type RoleAssignmentListResultIterator 

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

RoleAssignmentListResultIterator provides access to a complete listing of RoleAssignment values.

func NewRoleAssignmentListResultIterator 

func NewRoleAssignmentListResultIterator(page RoleAssignmentListResultPage) RoleAssignmentListResultIterator

Creates a new instance of the RoleAssignmentListResultIterator type.

func (*RoleAssignmentListResultIterator) Next 

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

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

func (iter RoleAssignmentListResultIterator) NotDone() bool

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

func (RoleAssignmentListResultIterator) Response 

func (iter RoleAssignmentListResultIterator) Response() RoleAssignmentListResult

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

func (RoleAssignmentListResultIterator) Value 

func (iter RoleAssignmentListResultIterator) Value() RoleAssignment

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

type RoleAssignmentListResultPage 

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

RoleAssignmentListResultPage contains a page of RoleAssignment values.

func NewRoleAssignmentListResultPage 

func NewRoleAssignmentListResultPage(cur RoleAssignmentListResult, getNextPage func(context.Context, RoleAssignmentListResult) (RoleAssignmentListResult, error)) RoleAssignmentListResultPage

Creates a new instance of the RoleAssignmentListResultPage type.

func (*RoleAssignmentListResultPage) Next 

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

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

func (page RoleAssignmentListResultPage) NotDone() bool

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

func (RoleAssignmentListResultPage) Response 

func (page RoleAssignmentListResultPage) Response() RoleAssignmentListResult

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

func (RoleAssignmentListResultPage) Values 

func (page RoleAssignmentListResultPage) Values() []RoleAssignment

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

type RoleAssignmentProperties 

type RoleAssignmentProperties struct {
	// RoleDefinitionID - The role definition ID used in the role assignment.
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`
	// PrincipalID - The principal ID assigned to the role. This maps to the ID inside the Active Directory. It can point to a user, service principal, or security group.
	PrincipalID *string `json:"principalId,omitempty"`
}

RoleAssignmentProperties role assignment properties.

type RoleAssignmentPropertiesWithScope 

type RoleAssignmentPropertiesWithScope struct {
	// Scope - The role assignment scope.
	Scope *string `json:"scope,omitempty"`
	// RoleDefinitionID - The role definition ID.
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`
	// PrincipalID - The principal ID.
	PrincipalID *string `json:"principalId,omitempty"`
}

RoleAssignmentPropertiesWithScope role assignment properties with scope.

type RoleAssignmentsClient 

type RoleAssignmentsClient struct {
	BaseClient
}

RoleAssignmentsClient is the role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role definitions and role assignments. A role definition describes the set of actions that can be performed on resources. A role assignment grants access to Azure Active Directory users.

func NewRoleAssignmentsClient 

func NewRoleAssignmentsClient(subscriptionID string) RoleAssignmentsClient

NewRoleAssignmentsClient creates an instance of the RoleAssignmentsClient client.

func NewRoleAssignmentsClientWithBaseURI 

func NewRoleAssignmentsClientWithBaseURI(baseURI string, subscriptionID string) RoleAssignmentsClient

NewRoleAssignmentsClientWithBaseURI creates an instance of the RoleAssignmentsClient 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 (RoleAssignmentsClient) Create 

func (client RoleAssignmentsClient) Create(ctx context.Context, scope string, roleAssignmentName string, parameters RoleAssignmentCreateParameters) (result RoleAssignment, err error)

Create creates a role assignment. Parameters: scope - the scope of the role assignment to create. The scope can be any REST resource instance. For example, use '/subscriptions/{subscription-id}/' for a subscription, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource. roleAssignmentName - the name of the role assignment to create. It can be any valid GUID. parameters - parameters for the role assignment.

func (RoleAssignmentsClient) CreateByID 

func (client RoleAssignmentsClient) CreateByID(ctx context.Context, roleAssignmentID string, parameters RoleAssignmentCreateParameters) (result RoleAssignment, err error)

CreateByID creates a role assignment by ID. Parameters: roleAssignmentID - the fully qualified ID of the role assignment, including the scope, resource name and resource type. Use the format, /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Example: /subscriptions/{subId}/resourcegroups/{rgname}//providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. parameters - parameters for the role assignment.

func (RoleAssignmentsClient) CreateByIDPreparer 

func (client RoleAssignmentsClient) CreateByIDPreparer(ctx context.Context, roleAssignmentID string, parameters RoleAssignmentCreateParameters) (*http.Request, error)

CreateByIDPreparer prepares the CreateByID request.

func (RoleAssignmentsClient) CreateByIDResponder 

func (client RoleAssignmentsClient) CreateByIDResponder(resp *http.Response) (result RoleAssignment, err error)

CreateByIDResponder handles the response to the CreateByID request. The method always closes the http.Response Body.

func (RoleAssignmentsClient) CreateByIDSender 

func (client RoleAssignmentsClient) CreateByIDSender(req *http.Request) (*http.Response, error)

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

func (RoleAssignmentsClient) CreatePreparer 

func (client RoleAssignmentsClient) CreatePreparer(ctx context.Context, scope string, roleAssignmentName string, parameters RoleAssignmentCreateParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (RoleAssignmentsClient) CreateResponder 

func (client RoleAssignmentsClient) CreateResponder(resp *http.Response) (result RoleAssignment, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (RoleAssignmentsClient) CreateSender 

func (client RoleAssignmentsClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (RoleAssignmentsClient) Delete 

func (client RoleAssignmentsClient) Delete(ctx context.Context, scope string, roleAssignmentName string) (result RoleAssignment, err error)

Delete deletes a role assignment. Parameters: scope - the scope of the role assignment to delete. roleAssignmentName - the name of the role assignment to delete.

func (RoleAssignmentsClient) DeleteByID 

func (client RoleAssignmentsClient) DeleteByID(ctx context.Context, roleAssignmentID string) (result RoleAssignment, err error)

DeleteByID deletes a role assignment. Parameters: roleAssignmentID - the fully qualified ID of the role assignment, including the scope, resource name and resource type. Use the format, /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Example: /subscriptions/{subId}/resourcegroups/{rgname}//providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}.

func (RoleAssignmentsClient) DeleteByIDPreparer 

func (client RoleAssignmentsClient) DeleteByIDPreparer(ctx context.Context, roleAssignmentID string) (*http.Request, error)

DeleteByIDPreparer prepares the DeleteByID request.

func (RoleAssignmentsClient) DeleteByIDResponder 

func (client RoleAssignmentsClient) DeleteByIDResponder(resp *http.Response) (result RoleAssignment, err error)

DeleteByIDResponder handles the response to the DeleteByID request. The method always closes the http.Response Body.

func (RoleAssignmentsClient) DeleteByIDSender 

func (client RoleAssignmentsClient) DeleteByIDSender(req *http.Request) (*http.Response, error)

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

func (RoleAssignmentsClient) DeletePreparer 

func (client RoleAssignmentsClient) DeletePreparer(ctx context.Context, scope string, roleAssignmentName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (RoleAssignmentsClient) DeleteResponder 

func (client RoleAssignmentsClient) DeleteResponder(resp *http.Response) (result RoleAssignment, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (RoleAssignmentsClient) DeleteSender 

func (client RoleAssignmentsClient) DeleteSender(req *http.Request) (*http.Response, error)

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

func (RoleAssignmentsClient) Get 

func (client RoleAssignmentsClient) Get(ctx context.Context, scope string, roleAssignmentName string) (result RoleAssignment, err error)

Get get the specified role assignment. Parameters: scope - the scope of the role assignment. roleAssignmentName - the name of the role assignment to get.

func (RoleAssignmentsClient) GetByID 

func (client RoleAssignmentsClient) GetByID(ctx context.Context, roleAssignmentID string) (result RoleAssignment, err error)

GetByID gets a role assignment by ID. Parameters: roleAssignmentID - the fully qualified ID of the role assignment, including the scope, resource name and resource type. Use the format, /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Example: /subscriptions/{subId}/resourcegroups/{rgname}//providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}.

func (RoleAssignmentsClient) GetByIDPreparer 

func (client RoleAssignmentsClient) GetByIDPreparer(ctx context.Context, roleAssignmentID string) (*http.Request, error)

GetByIDPreparer prepares the GetByID request.

func (RoleAssignmentsClient) GetByIDResponder 

func (client RoleAssignmentsClient) GetByIDResponder(resp *http.Response) (result RoleAssignment, err error)

GetByIDResponder handles the response to the GetByID request. The method always closes the http.Response Body.

func (RoleAssignmentsClient) GetByIDSender 

func (client RoleAssignmentsClient) GetByIDSender(req *http.Request) (*http.Response, error)

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

func (RoleAssignmentsClient) GetPreparer 

func (client RoleAssignmentsClient) GetPreparer(ctx context.Context, scope string, roleAssignmentName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (RoleAssignmentsClient) GetResponder 

func (client RoleAssignmentsClient) GetResponder(resp *http.Response) (result RoleAssignment, err error)

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

func (RoleAssignmentsClient) GetSender 

func (client RoleAssignmentsClient) 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 (RoleAssignmentsClient) List 

func (client RoleAssignmentsClient) List(ctx context.Context, filter string) (result RoleAssignmentListResultPage, err error)

List gets all role assignments for the subscription. Parameters: filter - the filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal.

func (RoleAssignmentsClient) ListComplete 

func (client RoleAssignmentsClient) ListComplete(ctx context.Context, filter string) (result RoleAssignmentListResultIterator, err error)

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

func (RoleAssignmentsClient) ListForResource 

func (client RoleAssignmentsClient) ListForResource(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string) (result RoleAssignmentListResultPage, err error)

ListForResource gets role assignments for a resource. Parameters: resourceGroupName - the name of the resource group. resourceProviderNamespace - the namespace of the resource provider. parentResourcePath - the parent resource identity. resourceType - the resource type of the resource. resourceName - the name of the resource to get role assignments for. filter - the filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal.

func (RoleAssignmentsClient) ListForResourceComplete 

func (client RoleAssignmentsClient) ListForResourceComplete(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string) (result RoleAssignmentListResultIterator, err error)

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

func (RoleAssignmentsClient) ListForResourceGroup 

func (client RoleAssignmentsClient) ListForResourceGroup(ctx context.Context, resourceGroupName string, filter string) (result RoleAssignmentListResultPage, err error)

ListForResourceGroup gets role assignments for a resource group. Parameters: resourceGroupName - the name of the resource group. filter - the filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal.

func (RoleAssignmentsClient) ListForResourceGroupComplete 

func (client RoleAssignmentsClient) ListForResourceGroupComplete(ctx context.Context, resourceGroupName string, filter string) (result RoleAssignmentListResultIterator, err error)

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

func (RoleAssignmentsClient) ListForResourceGroupPreparer 

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

ListForResourceGroupPreparer prepares the ListForResourceGroup request.

func (RoleAssignmentsClient) ListForResourceGroupResponder 

func (client RoleAssignmentsClient) ListForResourceGroupResponder(resp *http.Response) (result RoleAssignmentListResult, err error)

ListForResourceGroupResponder handles the response to the ListForResourceGroup request. The method always closes the http.Response Body.

func (RoleAssignmentsClient) ListForResourceGroupSender 

func (client RoleAssignmentsClient) ListForResourceGroupSender(req *http.Request) (*http.Response, error)

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

func (RoleAssignmentsClient) ListForResourcePreparer 

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

ListForResourcePreparer prepares the ListForResource request.

func (RoleAssignmentsClient) ListForResourceResponder 

func (client RoleAssignmentsClient) ListForResourceResponder(resp *http.Response) (result RoleAssignmentListResult, err error)

ListForResourceResponder handles the response to the ListForResource request. The method always closes the http.Response Body.

func (RoleAssignmentsClient) ListForResourceSender 

func (client RoleAssignmentsClient) ListForResourceSender(req *http.Request) (*http.Response, error)

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

func (RoleAssignmentsClient) ListForScope 

func (client RoleAssignmentsClient) ListForScope(ctx context.Context, scope string, filter string) (result RoleAssignmentListResultPage, err error)

ListForScope gets role assignments for a scope. Parameters: scope - the scope of the role assignments. filter - the filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal.

func (RoleAssignmentsClient) ListForScopeComplete 

func (client RoleAssignmentsClient) ListForScopeComplete(ctx context.Context, scope string, filter string) (result RoleAssignmentListResultIterator, err error)

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

func (RoleAssignmentsClient) ListForScopePreparer 

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

ListForScopePreparer prepares the ListForScope request.

func (RoleAssignmentsClient) ListForScopeResponder 

func (client RoleAssignmentsClient) ListForScopeResponder(resp *http.Response) (result RoleAssignmentListResult, err error)

ListForScopeResponder handles the response to the ListForScope request. The method always closes the http.Response Body.

func (RoleAssignmentsClient) ListForScopeSender 

func (client RoleAssignmentsClient) ListForScopeSender(req *http.Request) (*http.Response, error)

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

func (RoleAssignmentsClient) ListPreparer 

func (client RoleAssignmentsClient) ListPreparer(ctx context.Context, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (RoleAssignmentsClient) ListResponder 

func (client RoleAssignmentsClient) ListResponder(resp *http.Response) (result RoleAssignmentListResult, err error)

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

func (RoleAssignmentsClient) ListSender 

func (client RoleAssignmentsClient) 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 RoleDefinition 

type RoleDefinition struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The role definition ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The role definition name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The role definition type.
	Type *string `json:"type,omitempty"`
	// RoleDefinitionProperties - Role definition properties.
	*RoleDefinitionProperties `json:"properties,omitempty"`
}

RoleDefinition role definition.

func (RoleDefinition) MarshalJSON 

func (rd RoleDefinition) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RoleDefinition.

func (*RoleDefinition) UnmarshalJSON 

func (rd *RoleDefinition) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RoleDefinition struct.

type RoleDefinitionFilter 

type RoleDefinitionFilter struct {
	// RoleName - Returns role definition with the specific name.
	RoleName *string `json:"roleName,omitempty"`
}

RoleDefinitionFilter role Definitions filter

type RoleDefinitionListResult 

type RoleDefinitionListResult struct {
	autorest.Response `json:"-"`
	// Value - Role definition list.
	Value *[]RoleDefinition `json:"value,omitempty"`
	// NextLink - The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

RoleDefinitionListResult role definition list operation result.

func (RoleDefinitionListResult) IsEmpty 

func (rdlr RoleDefinitionListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type RoleDefinitionListResultIterator 

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

RoleDefinitionListResultIterator provides access to a complete listing of RoleDefinition values.

func NewRoleDefinitionListResultIterator 

func NewRoleDefinitionListResultIterator(page RoleDefinitionListResultPage) RoleDefinitionListResultIterator

Creates a new instance of the RoleDefinitionListResultIterator type.

func (*RoleDefinitionListResultIterator) Next 

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

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

func (iter RoleDefinitionListResultIterator) NotDone() bool

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

func (RoleDefinitionListResultIterator) Response 

func (iter RoleDefinitionListResultIterator) Response() RoleDefinitionListResult

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

func (RoleDefinitionListResultIterator) Value 

func (iter RoleDefinitionListResultIterator) Value() RoleDefinition

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

type RoleDefinitionListResultPage 

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

RoleDefinitionListResultPage contains a page of RoleDefinition values.

func NewRoleDefinitionListResultPage 

func NewRoleDefinitionListResultPage(cur RoleDefinitionListResult, getNextPage func(context.Context, RoleDefinitionListResult) (RoleDefinitionListResult, error)) RoleDefinitionListResultPage

Creates a new instance of the RoleDefinitionListResultPage type.

func (*RoleDefinitionListResultPage) Next 

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

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

func (page RoleDefinitionListResultPage) NotDone() bool

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

func (RoleDefinitionListResultPage) Response 

func (page RoleDefinitionListResultPage) Response() RoleDefinitionListResult

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

func (RoleDefinitionListResultPage) Values 

func (page RoleDefinitionListResultPage) Values() []RoleDefinition

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

type RoleDefinitionProperties 

type RoleDefinitionProperties struct {
	// RoleName - The role name.
	RoleName *string `json:"roleName,omitempty"`
	// Description - The role definition description.
	Description *string `json:"description,omitempty"`
	// RoleType - The role type.
	RoleType *string `json:"type,omitempty"`
	// Permissions - Role definition permissions.
	Permissions *[]Permission `json:"permissions,omitempty"`
	// AssignableScopes - Role definition assignable scopes.
	AssignableScopes *[]string `json:"assignableScopes,omitempty"`
}

RoleDefinitionProperties role definition properties.

type RoleDefinitionsClient 

type RoleDefinitionsClient struct {
	BaseClient
}

RoleDefinitionsClient is the role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role definitions and role assignments. A role definition describes the set of actions that can be performed on resources. A role assignment grants access to Azure Active Directory users.

func NewRoleDefinitionsClient 

func NewRoleDefinitionsClient(subscriptionID string) RoleDefinitionsClient

NewRoleDefinitionsClient creates an instance of the RoleDefinitionsClient client.

func NewRoleDefinitionsClientWithBaseURI 

func NewRoleDefinitionsClientWithBaseURI(baseURI string, subscriptionID string) RoleDefinitionsClient

NewRoleDefinitionsClientWithBaseURI creates an instance of the RoleDefinitionsClient 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 (RoleDefinitionsClient) CreateOrUpdate 

func (client RoleDefinitionsClient) CreateOrUpdate(ctx context.Context, scope string, roleDefinitionID string, roleDefinition RoleDefinition) (result RoleDefinition, err error)

CreateOrUpdate creates or updates a role definition. Parameters: scope - the scope of the role definition. roleDefinitionID - the ID of the role definition. roleDefinition - the values for the role definition.

func (RoleDefinitionsClient) CreateOrUpdatePreparer 

func (client RoleDefinitionsClient) CreateOrUpdatePreparer(ctx context.Context, scope string, roleDefinitionID string, roleDefinition RoleDefinition) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (RoleDefinitionsClient) CreateOrUpdateResponder 

func (client RoleDefinitionsClient) CreateOrUpdateResponder(resp *http.Response) (result RoleDefinition, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (RoleDefinitionsClient) CreateOrUpdateSender 

func (client RoleDefinitionsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

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

func (RoleDefinitionsClient) Delete 

func (client RoleDefinitionsClient) Delete(ctx context.Context, scope string, roleDefinitionID string) (result RoleDefinition, err error)

Delete deletes a role definition. Parameters: scope - the scope of the role definition. roleDefinitionID - the ID of the role definition to delete.

func (RoleDefinitionsClient) DeletePreparer 

func (client RoleDefinitionsClient) DeletePreparer(ctx context.Context, scope string, roleDefinitionID string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (RoleDefinitionsClient) DeleteResponder 

func (client RoleDefinitionsClient) DeleteResponder(resp *http.Response) (result RoleDefinition, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (RoleDefinitionsClient) DeleteSender 

func (client RoleDefinitionsClient) DeleteSender(req *http.Request) (*http.Response, error)

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

func (RoleDefinitionsClient) Get 

func (client RoleDefinitionsClient) Get(ctx context.Context, scope string, roleDefinitionID string) (result RoleDefinition, err error)

Get get role definition by name (GUID). Parameters: scope - the scope of the role definition. roleDefinitionID - the ID of the role definition.

func (RoleDefinitionsClient) GetByID 

func (client RoleDefinitionsClient) GetByID(ctx context.Context, roleDefinitionID string) (result RoleDefinition, err error)

GetByID gets a role definition by ID. Parameters: roleDefinitionID - the fully qualified role definition ID. Use the format, /subscriptions/{guid}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for subscription level role definitions, or /providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for tenant level role definitions.

func (RoleDefinitionsClient) GetByIDPreparer 

func (client RoleDefinitionsClient) GetByIDPreparer(ctx context.Context, roleDefinitionID string) (*http.Request, error)

GetByIDPreparer prepares the GetByID request.

func (RoleDefinitionsClient) GetByIDResponder 

func (client RoleDefinitionsClient) GetByIDResponder(resp *http.Response) (result RoleDefinition, err error)

GetByIDResponder handles the response to the GetByID request. The method always closes the http.Response Body.

func (RoleDefinitionsClient) GetByIDSender 

func (client RoleDefinitionsClient) GetByIDSender(req *http.Request) (*http.Response, error)

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

func (RoleDefinitionsClient) GetPreparer 

func (client RoleDefinitionsClient) GetPreparer(ctx context.Context, scope string, roleDefinitionID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (RoleDefinitionsClient) GetResponder 

func (client RoleDefinitionsClient) GetResponder(resp *http.Response) (result RoleDefinition, err error)

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

func (RoleDefinitionsClient) GetSender 

func (client RoleDefinitionsClient) 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 (RoleDefinitionsClient) List 

func (client RoleDefinitionsClient) List(ctx context.Context, scope string, filter string) (result RoleDefinitionListResultPage, err error)

List get all role definitions that are applicable at scope and above. Parameters: scope - the scope of the role definition. filter - the filter to apply on the operation. Use atScopeAndBelow filter to search below the given scope as well.

func (RoleDefinitionsClient) ListComplete 

func (client RoleDefinitionsClient) ListComplete(ctx context.Context, scope string, filter string) (result RoleDefinitionListResultIterator, err error)

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

func (RoleDefinitionsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (RoleDefinitionsClient) ListResponder 

func (client RoleDefinitionsClient) ListResponder(resp *http.Response) (result RoleDefinitionListResult, err error)

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

func (RoleDefinitionsClient) ListSender 

func (client RoleDefinitionsClient) 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.

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.