accesscontrol

package
v52.5.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Mar 18, 2021 License: Apache-2.0 Imports: 8 Imported by: 110

Documentation

Overview

Package accesscontrol implements the Azure ARM Accesscontrol service API version 2020-08-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.

type CheckAccessDecision 

type CheckAccessDecision struct {
	// AccessDecision - Access Decision.
	AccessDecision *string `json:"accessDecision,omitempty"`
	// ActionID - Action Id.
	ActionID       *string                `json:"actionId,omitempty"`
	RoleAssignment *RoleAssignmentDetails `json:"roleAssignment,omitempty"`
}

CheckAccessDecision check access response details

type CheckPrincipalAccessRequest 

type CheckPrincipalAccessRequest struct {
	// Subject - Subject details
	Subject *SubjectInfo `json:"subject,omitempty"`
	// Actions - List of actions.
	Actions *[]RequiredAction `json:"actions,omitempty"`
	// Scope - Scope at which the check access is done.
	Scope *string `json:"scope,omitempty"`
}

CheckPrincipalAccessRequest check access request details

type CheckPrincipalAccessResponse 

type CheckPrincipalAccessResponse struct {
	autorest.Response `json:"-"`
	// AccessDecisions - To check if the current user, group, or service principal has permission to read artifacts in the specified workspace.
	AccessDecisions *[]CheckAccessDecision `json:"AccessDecisions,omitempty"`
}

CheckPrincipalAccessResponse check access response details

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 ListString 

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

ListString ...

type ListSynapseRoleDefinition 

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

ListSynapseRoleDefinition ...

type RequiredAction 

type RequiredAction struct {
	// ID - Action Id.
	ID *string `json:"id,omitempty"`
	// IsDataAction - Is a data action or not.
	IsDataAction *bool `json:"isDataAction,omitempty"`
}

RequiredAction action Info

type RoleAssignmentDetails 

type RoleAssignmentDetails struct {
	autorest.Response `json:"-"`
	// ID - Role Assignment ID
	ID *string `json:"id,omitempty"`
	// RoleDefinitionID - Role ID of the Synapse Built-In Role
	RoleDefinitionID *uuid.UUID `json:"roleDefinitionId,omitempty"`
	// PrincipalID - Object ID of the AAD principal or security-group
	PrincipalID *uuid.UUID `json:"principalId,omitempty"`
	// Scope - Scope at the role assignment is created
	Scope *string `json:"scope,omitempty"`
	// PrincipalType - Type of the principal Id: User, Group or ServicePrincipal
	PrincipalType *string `json:"principalType,omitempty"`
}

RoleAssignmentDetails role Assignment response details

type RoleAssignmentDetailsList 

type RoleAssignmentDetailsList struct {
	autorest.Response `json:"-"`
	// Count - Number of role assignments
	Count *int32 `json:"count,omitempty"`
	// Value - A list of role assignments
	Value *[]RoleAssignmentDetails `json:"value,omitempty"`
}

RoleAssignmentDetailsList role Assignment response details

type RoleAssignmentRequest 

type RoleAssignmentRequest struct {
	// RoleID - Role ID of the Synapse Built-In Role
	RoleID *uuid.UUID `json:"roleId,omitempty"`
	// PrincipalID - Object ID of the AAD principal or security-group
	PrincipalID *uuid.UUID `json:"principalId,omitempty"`
	// Scope - Scope at which the role assignment is created
	Scope *string `json:"scope,omitempty"`
	// PrincipalType - Type of the principal Id: User, Group or ServicePrincipal
	PrincipalType *string `json:"principalType,omitempty"`
}

RoleAssignmentRequest role Assignment request details

type RoleAssignmentsClient 

type RoleAssignmentsClient struct {
	BaseClient
}

RoleAssignmentsClient is the client for the RoleAssignments methods of the Accesscontrol service.

func NewRoleAssignmentsClient 

func NewRoleAssignmentsClient(endpoint string) RoleAssignmentsClient

NewRoleAssignmentsClient creates an instance of the RoleAssignmentsClient client.

func (RoleAssignmentsClient) CheckPrincipalAccess 

func (client RoleAssignmentsClient) CheckPrincipalAccess(ctx context.Context, request CheckPrincipalAccessRequest) (result CheckPrincipalAccessResponse, err error)

CheckPrincipalAccess check if the given principalId has access to perform list of actions at a given scope. Parameters: request - details of scope, list of actions and principal.

func (RoleAssignmentsClient) CheckPrincipalAccessPreparer 

func (client RoleAssignmentsClient) CheckPrincipalAccessPreparer(ctx context.Context, request CheckPrincipalAccessRequest) (*http.Request, error)

CheckPrincipalAccessPreparer prepares the CheckPrincipalAccess request.

func (RoleAssignmentsClient) CheckPrincipalAccessResponder 

func (client RoleAssignmentsClient) CheckPrincipalAccessResponder(resp *http.Response) (result CheckPrincipalAccessResponse, err error)

CheckPrincipalAccessResponder handles the response to the CheckPrincipalAccess request. The method always closes the http.Response Body.

func (RoleAssignmentsClient) CheckPrincipalAccessSender 

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

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

func (RoleAssignmentsClient) CreateRoleAssignment 

func (client RoleAssignmentsClient) CreateRoleAssignment(ctx context.Context, request RoleAssignmentRequest, roleAssignmentID string) (result RoleAssignmentDetails, err error)

CreateRoleAssignment create role assignment. Parameters: request - details of role id, scope and object id. roleAssignmentID - the ID of the role assignment.

func (RoleAssignmentsClient) CreateRoleAssignmentPreparer 

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

CreateRoleAssignmentPreparer prepares the CreateRoleAssignment request.

func (RoleAssignmentsClient) CreateRoleAssignmentResponder 

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

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

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

DeleteRoleAssignmentByID delete role assignment by role assignment Id. Parameters: roleAssignmentID - the ID of the role assignment. scope - scope of the Synapse Built-in Role.

func (RoleAssignmentsClient) DeleteRoleAssignmentByIDPreparer 

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

DeleteRoleAssignmentByIDPreparer prepares the DeleteRoleAssignmentByID request.

func (RoleAssignmentsClient) DeleteRoleAssignmentByIDResponder 

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

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

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

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

GetRoleAssignmentByIDPreparer prepares the GetRoleAssignmentByID request.

func (RoleAssignmentsClient) GetRoleAssignmentByIDResponder 

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

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

func (client RoleAssignmentsClient) ListRoleAssignments(ctx context.Context, roleID string, principalID string, scope string, continuationToken string) (result RoleAssignmentDetailsList, err error)

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

func (RoleAssignmentsClient) ListRoleAssignmentsPreparer 

func (client RoleAssignmentsClient) ListRoleAssignmentsPreparer(ctx context.Context, roleID string, principalID string, scope string, continuationToken string) (*http.Request, error)

ListRoleAssignmentsPreparer prepares the ListRoleAssignments request.

func (RoleAssignmentsClient) ListRoleAssignmentsResponder 

func (client RoleAssignmentsClient) ListRoleAssignmentsResponder(resp *http.Response) (result RoleAssignmentDetailsList, err error)

ListRoleAssignmentsResponder handles the response to the ListRoleAssignments request. The method always closes the http.Response Body.

func (RoleAssignmentsClient) ListRoleAssignmentsSender 

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

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

type RoleDefinitionsClient 

type RoleDefinitionsClient struct {
	BaseClient
}

RoleDefinitionsClient is the client for the RoleDefinitions methods of the Accesscontrol service.

func NewRoleDefinitionsClient 

func NewRoleDefinitionsClient(endpoint string) RoleDefinitionsClient

NewRoleDefinitionsClient creates an instance of the RoleDefinitionsClient client.

func (RoleDefinitionsClient) GetRoleDefinitionByID 

func (client RoleDefinitionsClient) GetRoleDefinitionByID(ctx context.Context, roleDefinitionID string) (result SynapseRoleDefinition, err error)

GetRoleDefinitionByID get role definition by role definition Id. Parameters: roleDefinitionID - synapse Built-In Role Definition Id.

func (RoleDefinitionsClient) GetRoleDefinitionByIDPreparer 

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

GetRoleDefinitionByIDPreparer prepares the GetRoleDefinitionByID request.

func (RoleDefinitionsClient) GetRoleDefinitionByIDResponder 

func (client RoleDefinitionsClient) GetRoleDefinitionByIDResponder(resp *http.Response) (result SynapseRoleDefinition, err error)

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

func (RoleDefinitionsClient) GetRoleDefinitionByIDSender 

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

func (client RoleDefinitionsClient) ListRoleDefinitions(ctx context.Context, isBuiltIn *bool, scope string) (result ListSynapseRoleDefinition, err error)

ListRoleDefinitions list role definitions. Parameters: isBuiltIn - is a Synapse Built-In Role or not. scope - scope of the Synapse Built-in Role.

func (RoleDefinitionsClient) ListRoleDefinitionsPreparer 

func (client RoleDefinitionsClient) ListRoleDefinitionsPreparer(ctx context.Context, isBuiltIn *bool, scope string) (*http.Request, error)

ListRoleDefinitionsPreparer prepares the ListRoleDefinitions request.

func (RoleDefinitionsClient) ListRoleDefinitionsResponder 

func (client RoleDefinitionsClient) ListRoleDefinitionsResponder(resp *http.Response) (result ListSynapseRoleDefinition, err error)

ListRoleDefinitionsResponder handles the response to the ListRoleDefinitions request. The method always closes the http.Response Body.

func (RoleDefinitionsClient) ListRoleDefinitionsSender 

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

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

func (RoleDefinitionsClient) ListScopes 

func (client RoleDefinitionsClient) ListScopes(ctx context.Context) (result ListString, err error)

ListScopes list rbac scopes.

func (RoleDefinitionsClient) ListScopesPreparer 

func (client RoleDefinitionsClient) ListScopesPreparer(ctx context.Context) (*http.Request, error)

ListScopesPreparer prepares the ListScopes request.

func (RoleDefinitionsClient) ListScopesResponder 

func (client RoleDefinitionsClient) ListScopesResponder(resp *http.Response) (result ListString, err error)

ListScopesResponder handles the response to the ListScopes request. The method always closes the http.Response Body.

func (RoleDefinitionsClient) ListScopesSender 

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

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

type SubjectInfo 

type SubjectInfo struct {
	// PrincipalID - Principal Id
	PrincipalID *uuid.UUID `json:"principalId,omitempty"`
	// GroupIds - List of group Ids that the principalId is part of.
	GroupIds *[]uuid.UUID `json:"groupIds,omitempty"`
}

SubjectInfo subject details

type SynapseRbacPermission 

type SynapseRbacPermission struct {
	// Actions - List of actions
	Actions *[]string `json:"actions,omitempty"`
	// NotActions - List of Not actions
	NotActions *[]string `json:"notActions,omitempty"`
	// DataActions - List of data actions
	DataActions *[]string `json:"dataActions,omitempty"`
	// NotDataActions - List of Not data actions
	NotDataActions *[]string `json:"notDataActions,omitempty"`
}

SynapseRbacPermission synapse role definition details

type SynapseRoleDefinition 

type SynapseRoleDefinition struct {
	autorest.Response `json:"-"`
	// ID - Role Definition ID
	ID *uuid.UUID `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"`
	// Description - Description for the Synapse role
	Description *string `json:"description,omitempty"`
	// Permissions - Permissions for the Synapse role
	Permissions *[]SynapseRbacPermission `json:"permissions,omitempty"`
	// Scopes - Allowed scopes for the Synapse role
	Scopes *[]string `json:"scopes,omitempty"`
	// AvailabilityStatus - Availability of the Synapse role
	AvailabilityStatus *string `json:"availabilityStatus,omitempty"`
}

SynapseRoleDefinition synapse role definition details

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.