accesscontrol

package
v49.0.1+incompatible Latest Latest
Warning

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

Go to latest
Published: Dec 18, 2020 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package accesscontrol implements the Azure ARM Accesscontrol service API version 2020-02-01-preview.

Index

Constants

This section is empty.

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
	Endpoint string
}

BaseClient is the base client for Accesscontrol.

func New

func New(endpoint string) BaseClient

New creates an instance of the BaseClient client.

func NewWithoutDefaults

func NewWithoutDefaults(endpoint string) BaseClient

NewWithoutDefaults creates an instance of the BaseClient client.

func (BaseClient) CreateRoleAssignment

func (client BaseClient) CreateRoleAssignment(ctx context.Context, createRoleAssignmentOptions RoleAssignmentOptions) (result RoleAssignmentDetails, err error)

CreateRoleAssignment create role assignment. Parameters: createRoleAssignmentOptions - details of role id and object id.

func (BaseClient) CreateRoleAssignmentPreparer

func (client BaseClient) CreateRoleAssignmentPreparer(ctx context.Context, createRoleAssignmentOptions RoleAssignmentOptions) (*http.Request, error)

CreateRoleAssignmentPreparer prepares the CreateRoleAssignment request.

func (BaseClient) CreateRoleAssignmentResponder

func (client BaseClient) CreateRoleAssignmentResponder(resp *http.Response) (result RoleAssignmentDetails, err error)

CreateRoleAssignmentResponder handles the response to the CreateRoleAssignment request. The method always closes the http.Response Body.

func (BaseClient) CreateRoleAssignmentSender

func (client BaseClient) CreateRoleAssignmentSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) DeleteRoleAssignmentByID

func (client BaseClient) DeleteRoleAssignmentByID(ctx context.Context, roleAssignmentID string) (result autorest.Response, err error)

DeleteRoleAssignmentByID delete role assignment by role assignment Id. Parameters: roleAssignmentID - the ID of the role assignment.

func (BaseClient) DeleteRoleAssignmentByIDPreparer

func (client BaseClient) DeleteRoleAssignmentByIDPreparer(ctx context.Context, roleAssignmentID string) (*http.Request, error)

DeleteRoleAssignmentByIDPreparer prepares the DeleteRoleAssignmentByID request.

func (BaseClient) DeleteRoleAssignmentByIDResponder

func (client BaseClient) DeleteRoleAssignmentByIDResponder(resp *http.Response) (result autorest.Response, err error)

DeleteRoleAssignmentByIDResponder handles the response to the DeleteRoleAssignmentByID request. The method always closes the http.Response Body.

func (BaseClient) DeleteRoleAssignmentByIDSender

func (client BaseClient) DeleteRoleAssignmentByIDSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetCallerRoleAssignments

func (client BaseClient) GetCallerRoleAssignments(ctx context.Context) (result ListString, err error)

GetCallerRoleAssignments list role assignments of the caller.

func (BaseClient) GetCallerRoleAssignmentsPreparer

func (client BaseClient) GetCallerRoleAssignmentsPreparer(ctx context.Context) (*http.Request, error)

GetCallerRoleAssignmentsPreparer prepares the GetCallerRoleAssignments request.

func (BaseClient) GetCallerRoleAssignmentsResponder

func (client BaseClient) GetCallerRoleAssignmentsResponder(resp *http.Response) (result ListString, err error)

GetCallerRoleAssignmentsResponder handles the response to the GetCallerRoleAssignments request. The method always closes the http.Response Body.

func (BaseClient) GetCallerRoleAssignmentsSender

func (client BaseClient) GetCallerRoleAssignmentsSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetRoleAssignmentByID

func (client BaseClient) GetRoleAssignmentByID(ctx context.Context, roleAssignmentID string) (result RoleAssignmentDetails, err error)

GetRoleAssignmentByID get role assignment by role assignment Id. Parameters: roleAssignmentID - the ID of the role assignment.

func (BaseClient) GetRoleAssignmentByIDPreparer

func (client BaseClient) GetRoleAssignmentByIDPreparer(ctx context.Context, roleAssignmentID string) (*http.Request, error)

GetRoleAssignmentByIDPreparer prepares the GetRoleAssignmentByID request.

func (BaseClient) GetRoleAssignmentByIDResponder

func (client BaseClient) GetRoleAssignmentByIDResponder(resp *http.Response) (result RoleAssignmentDetails, err error)

GetRoleAssignmentByIDResponder handles the response to the GetRoleAssignmentByID request. The method always closes the http.Response Body.

func (BaseClient) GetRoleAssignmentByIDSender

func (client BaseClient) GetRoleAssignmentByIDSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetRoleAssignments

func (client BaseClient) GetRoleAssignments(ctx context.Context, roleID string, principalID string, continuationToken string) (result ListRoleAssignmentDetails, err error)

GetRoleAssignments list role assignments. Parameters: roleID - synapse Built-In Role Id. principalID - object ID of the AAD principal or security-group. continuationToken - continuation token.

func (BaseClient) GetRoleAssignmentsPreparer

func (client BaseClient) GetRoleAssignmentsPreparer(ctx context.Context, roleID string, principalID string, continuationToken string) (*http.Request, error)

GetRoleAssignmentsPreparer prepares the GetRoleAssignments request.

func (BaseClient) GetRoleAssignmentsResponder

func (client BaseClient) GetRoleAssignmentsResponder(resp *http.Response) (result ListRoleAssignmentDetails, err error)

GetRoleAssignmentsResponder handles the response to the GetRoleAssignments request. The method always closes the http.Response Body.

func (BaseClient) GetRoleAssignmentsSender

func (client BaseClient) GetRoleAssignmentsSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetRoleDefinitionByID

func (client BaseClient) GetRoleDefinitionByID(ctx context.Context, roleID string) (result SynapseRole, err error)

GetRoleDefinitionByID get role by role Id. Parameters: roleID - synapse Built-In Role Id.

func (BaseClient) GetRoleDefinitionByIDPreparer

func (client BaseClient) GetRoleDefinitionByIDPreparer(ctx context.Context, roleID string) (*http.Request, error)

GetRoleDefinitionByIDPreparer prepares the GetRoleDefinitionByID request.

func (BaseClient) GetRoleDefinitionByIDResponder

func (client BaseClient) GetRoleDefinitionByIDResponder(resp *http.Response) (result SynapseRole, err error)

GetRoleDefinitionByIDResponder handles the response to the GetRoleDefinitionByID request. The method always closes the http.Response Body.

func (BaseClient) GetRoleDefinitionByIDSender

func (client BaseClient) GetRoleDefinitionByIDSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetRoleDefinitions

func (client BaseClient) GetRoleDefinitions(ctx context.Context) (result RolesListResponsePage, err error)

GetRoleDefinitions list roles.

func (BaseClient) GetRoleDefinitionsComplete

func (client BaseClient) GetRoleDefinitionsComplete(ctx context.Context) (result RolesListResponseIterator, err error)

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

func (BaseClient) GetRoleDefinitionsPreparer

func (client BaseClient) GetRoleDefinitionsPreparer(ctx context.Context) (*http.Request, error)

GetRoleDefinitionsPreparer prepares the GetRoleDefinitions request.

func (BaseClient) GetRoleDefinitionsResponder

func (client BaseClient) GetRoleDefinitionsResponder(resp *http.Response) (result RolesListResponse, err error)

GetRoleDefinitionsResponder handles the response to the GetRoleDefinitions request. The method always closes the http.Response Body.

func (BaseClient) GetRoleDefinitionsSender

func (client BaseClient) GetRoleDefinitionsSender(req *http.Request) (*http.Response, error)

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

type ErrorContract

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

ErrorContract contains details when the response code indicates an error.

type ErrorDetail

type ErrorDetail struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
	Target  *string `json:"target,omitempty"`
}

ErrorDetail ...

type ErrorResponse

type ErrorResponse struct {
	Code    *string        `json:"code,omitempty"`
	Message *string        `json:"message,omitempty"`
	Target  *string        `json:"target,omitempty"`
	Details *[]ErrorDetail `json:"details,omitempty"`
}

ErrorResponse ...

type ListRoleAssignmentDetails

type ListRoleAssignmentDetails struct {
	autorest.Response `json:"-"`
	Value             *[]RoleAssignmentDetails `json:"value,omitempty"`
}

ListRoleAssignmentDetails ...

type ListString

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

ListString ...

type RoleAssignmentDetails

type RoleAssignmentDetails struct {
	autorest.Response `json:"-"`
	// ID - Role Assignment ID
	ID *string `json:"id,omitempty"`
	// RoleID - Role ID of the Synapse Built-In Role
	RoleID *string `json:"roleId,omitempty"`
	// PrincipalID - Object ID of the AAD principal or security-group
	PrincipalID *string `json:"principalId,omitempty"`
}

RoleAssignmentDetails role Assignment response details

type RoleAssignmentOptions

type RoleAssignmentOptions struct {
	// RoleID - Role ID of the Synapse Built-In Role
	RoleID *string `json:"roleId,omitempty"`
	// PrincipalID - Object ID of the AAD principal or security-group
	PrincipalID *string `json:"principalId,omitempty"`
}

RoleAssignmentOptions role Assignment request details

type RolesListResponse

type RolesListResponse struct {
	autorest.Response `json:"-"`
	// Value - List of Synapse roles.
	Value *[]SynapseRole `json:"value,omitempty"`
	// NextLink - The link to the next page of results, if any remaining results exist.
	NextLink *string `json:"nextLink,omitempty"`
}

RolesListResponse a list of Synapse roles available.

func (RolesListResponse) IsEmpty

func (rlr RolesListResponse) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type RolesListResponseIterator

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

RolesListResponseIterator provides access to a complete listing of SynapseRole values.

func NewRolesListResponseIterator

func NewRolesListResponseIterator(page RolesListResponsePage) RolesListResponseIterator

Creates a new instance of the RolesListResponseIterator type.

func (*RolesListResponseIterator) Next

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

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

func (iter RolesListResponseIterator) NotDone() bool

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

func (RolesListResponseIterator) Response

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

func (RolesListResponseIterator) Value

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

type RolesListResponsePage

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

RolesListResponsePage contains a page of SynapseRole values.

func NewRolesListResponsePage

func NewRolesListResponsePage(cur RolesListResponse, getNextPage func(context.Context, RolesListResponse) (RolesListResponse, error)) RolesListResponsePage

Creates a new instance of the RolesListResponsePage type.

func (*RolesListResponsePage) Next

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

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

func (page RolesListResponsePage) NotDone() bool

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

func (RolesListResponsePage) Response

func (page RolesListResponsePage) Response() RolesListResponse

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

func (RolesListResponsePage) Values

func (page RolesListResponsePage) Values() []SynapseRole

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

type SynapseRole

type SynapseRole struct {
	autorest.Response `json:"-"`
	// ID - Role ID
	ID *string `json:"id,omitempty"`
	// Name - Name of the Synapse role
	Name *string `json:"name,omitempty"`
	// IsBuiltIn - Is a built-in role or not
	IsBuiltIn *bool `json:"isBuiltIn,omitempty"`
}

SynapseRole synapse role details

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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