func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
BaseClient is the base client for Accesscontrol.
type BaseClient struct {
autorest.Client
Endpoint string
}
func New(endpoint string) BaseClient
New creates an instance of the BaseClient client.
func NewWithoutDefaults(endpoint string) BaseClient
NewWithoutDefaults creates an instance of the BaseClient client.
CheckAccessDecision check access response details
type CheckAccessDecision struct {
// AccessDecision - Access Decision.
AccessDecision *string `json:"accessDecision,omitempty"`
// ActionID - Action Id.
ActionID *string `json:"actionId,omitempty"`
RoleAssignment *RoleAssignmentDetails `json:"roleAssignment,omitempty"`
}
CheckPrincipalAccessRequest check access request details
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"`
}
CheckPrincipalAccessResponse check access response details
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"`
}
ErrorContract contains details when the response code indicates an error.
type ErrorContract struct {
// Error - The error details.
Error *ErrorResponse `json:"error,omitempty"`
}
ErrorDetail ...
type ErrorDetail struct {
Code *string `json:"code,omitempty"`
Message *string `json:"message,omitempty"`
Target *string `json:"target,omitempty"`
}
ErrorResponse ...
type ErrorResponse struct {
Code *string `json:"code,omitempty"`
Message *string `json:"message,omitempty"`
Target *string `json:"target,omitempty"`
Details *[]ErrorDetail `json:"details,omitempty"`
}
ListString ...
type ListString struct {
autorest.Response `json:"-"`
Value *[]string `json:"value,omitempty"`
}
ListSynapseRoleDefinition ...
type ListSynapseRoleDefinition struct {
autorest.Response `json:"-"`
Value *[]SynapseRoleDefinition `json:"value,omitempty"`
}
RequiredAction action Info
type RequiredAction struct {
// ID - Action Id.
ID *string `json:"id,omitempty"`
// IsDataAction - Is a data action or not.
IsDataAction *bool `json:"isDataAction,omitempty"`
}
RoleAssignmentDetails role Assignment response details
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"`
}
RoleAssignmentDetailsList role Assignment response details
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"`
}
RoleAssignmentRequest role Assignment request details
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"`
}
RoleAssignmentsClient is the client for the RoleAssignments methods of the Accesscontrol service.
type RoleAssignmentsClient struct {
BaseClient
}
func NewRoleAssignmentsClient(endpoint string) RoleAssignmentsClient
NewRoleAssignmentsClient creates an instance of the RoleAssignmentsClient client.
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 (client RoleAssignmentsClient) CheckPrincipalAccessPreparer(ctx context.Context, request CheckPrincipalAccessRequest) (*http.Request, error)
CheckPrincipalAccessPreparer prepares the CheckPrincipalAccess request.
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 (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 (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 (client RoleAssignmentsClient) CreateRoleAssignmentPreparer(ctx context.Context, request RoleAssignmentRequest, roleAssignmentID string) (*http.Request, error)
CreateRoleAssignmentPreparer prepares the CreateRoleAssignment request.
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 (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 (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 (client RoleAssignmentsClient) DeleteRoleAssignmentByIDPreparer(ctx context.Context, roleAssignmentID string, scope string) (*http.Request, error)
DeleteRoleAssignmentByIDPreparer prepares the DeleteRoleAssignmentByID request.
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 (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 (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 (client RoleAssignmentsClient) GetRoleAssignmentByIDPreparer(ctx context.Context, roleAssignmentID string) (*http.Request, error)
GetRoleAssignmentByIDPreparer prepares the GetRoleAssignmentByID request.
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 (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 (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 (client RoleAssignmentsClient) ListRoleAssignmentsPreparer(ctx context.Context, roleID string, principalID string, scope string, continuationToken string) (*http.Request, error)
ListRoleAssignmentsPreparer prepares the ListRoleAssignments request.
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 (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.
RoleDefinitionsClient is the client for the RoleDefinitions methods of the Accesscontrol service.
type RoleDefinitionsClient struct {
BaseClient
}
func NewRoleDefinitionsClient(endpoint string) RoleDefinitionsClient
NewRoleDefinitionsClient creates an instance of the RoleDefinitionsClient client.
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 (client RoleDefinitionsClient) GetRoleDefinitionByIDPreparer(ctx context.Context, roleDefinitionID string) (*http.Request, error)
GetRoleDefinitionByIDPreparer prepares the GetRoleDefinitionByID request.
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 (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 (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 (client RoleDefinitionsClient) ListRoleDefinitionsPreparer(ctx context.Context, isBuiltIn *bool, scope string) (*http.Request, error)
ListRoleDefinitionsPreparer prepares the ListRoleDefinitions request.
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 (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 (client RoleDefinitionsClient) ListScopes(ctx context.Context) (result ListString, err error)
ListScopes list rbac scopes.
func (client RoleDefinitionsClient) ListScopesPreparer(ctx context.Context) (*http.Request, error)
ListScopesPreparer prepares the ListScopes request.
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 (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.
SubjectInfo subject details
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"`
}
SynapseRbacPermission synapse role definition details
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"`
}
SynapseRoleDefinition synapse role definition details
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"`
}
| Name | Synopsis |
|---|---|
| .. | |
| accesscontrolapi | |