WorkspaceAcl class
Class representing a WorkspaceAcl.
Constructors
| Workspace |
Create a WorkspaceAcl. |
Methods
Constructor Details
WorkspaceAcl(SynapseClientContext)
Create a WorkspaceAcl.
new WorkspaceAcl(client: SynapseClientContext)Parameters
- client
- SynapseClientContext
Reference to the service client.
Method Details
getAccessControlInfo(string, GetAccessControlInfoRequest, RequestOptionsBase)
Get access control info.
function getAccessControlInfo(workspaceName: string, resource: GetAccessControlInfoRequest, options?: RequestOptionsBase): Promise<WorkspaceAclGetAccessControlInfoResponse>Parameters
- workspaceName
-
string
The name of the workspace to execute operations on.
- resource
- GetAccessControlInfoRequest
The resource to get the access control info for.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<Models.WorkspaceAclGetAccessControlInfoResponse>
getAccessControlInfo(string, GetAccessControlInfoRequest, RequestOptionsBase, ServiceCallback<WorkspaceAccessControlResponse>)
function getAccessControlInfo(workspaceName: string, resource: GetAccessControlInfoRequest, options: RequestOptionsBase, callback: ServiceCallback<WorkspaceAccessControlResponse>)Parameters
- workspaceName
-
string
The name of the workspace to execute operations on.
- resource
- GetAccessControlInfoRequest
The resource to get the access control info for.
- options
- RequestOptionsBase
The optional parameters
The callback
getAccessControlInfo(string, GetAccessControlInfoRequest, ServiceCallback<WorkspaceAccessControlResponse>)
function getAccessControlInfo(workspaceName: string, resource: GetAccessControlInfoRequest, callback: ServiceCallback<WorkspaceAccessControlResponse>)Parameters
- workspaceName
-
string
The name of the workspace to execute operations on.
- resource
- GetAccessControlInfoRequest
The resource to get the access control info for.
The callback
setWorkspaceAdministrators(string, SetWorkspaceAdministratorsRequest, RequestOptionsBase)
Replace Admins of the Workspace.
function setWorkspaceAdministrators(workspaceName: string, request: SetWorkspaceAdministratorsRequest, options?: RequestOptionsBase): Promise<WorkspaceAclSetWorkspaceAdministratorsResponse>Parameters
- workspaceName
-
string
The name of the workspace to execute operations on.
Details of administrators object-ids.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<Models.WorkspaceAclSetWorkspaceAdministratorsResponse>
setWorkspaceAdministrators(string, SetWorkspaceAdministratorsRequest, RequestOptionsBase, ServiceCallback<WorkspaceAccessControlResponse>)
function setWorkspaceAdministrators(workspaceName: string, request: SetWorkspaceAdministratorsRequest, options: RequestOptionsBase, callback: ServiceCallback<WorkspaceAccessControlResponse>)Parameters
- workspaceName
-
string
The name of the workspace to execute operations on.
Details of administrators object-ids.
- options
- RequestOptionsBase
The optional parameters
The callback
setWorkspaceAdministrators(string, SetWorkspaceAdministratorsRequest, ServiceCallback<WorkspaceAccessControlResponse>)
function setWorkspaceAdministrators(workspaceName: string, request: SetWorkspaceAdministratorsRequest, callback: ServiceCallback<WorkspaceAccessControlResponse>)Parameters
- workspaceName
-
string
The name of the workspace to execute operations on.
Details of administrators object-ids.
The callback