Access interface
Interface representing a Access.
Methods
Method Details
createRoleBinding(string, string, AccessCreateRoleBindingRequestModel, AccessCreateRoleBindingOptionalParams)
Organization role bindings
function createRoleBinding(resourceGroupName: string, organizationName: string, body: AccessCreateRoleBindingRequestModel, options?: AccessCreateRoleBindingOptionalParams): Promise<RoleBindingRecord>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- organizationName
-
string
Organization resource name
Create role binding Request Model
The options parameters.
Returns
Promise<RoleBindingRecord>
deleteRoleBinding(string, string, string, AccessDeleteRoleBindingOptionalParams)
Organization role bindings
function deleteRoleBinding(resourceGroupName: string, organizationName: string, roleBindingId: string, options?: AccessDeleteRoleBindingOptionalParams): Promise<void>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- organizationName
-
string
Organization resource name
- roleBindingId
-
string
Confluent Role binding id
The options parameters.
Returns
Promise<void>
inviteUser(string, string, AccessInviteUserAccountModel, AccessInviteUserOptionalParams)
Invite user to the organization
function inviteUser(resourceGroupName: string, organizationName: string, body: AccessInviteUserAccountModel, options?: AccessInviteUserOptionalParams): Promise<InvitationRecord>
Parameters
- resourceGroupName
-
string
Resource group name
- organizationName
-
string
Organization resource name
Invite user account model
- options
- AccessInviteUserOptionalParams
The options parameters.
Returns
Promise<InvitationRecord>
listClusters(string, string, ListAccessRequestModel, AccessListClustersOptionalParams)
Cluster details
function listClusters(resourceGroupName: string, organizationName: string, body: ListAccessRequestModel, options?: AccessListClustersOptionalParams): Promise<AccessListClusterSuccessResponse>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- organizationName
-
string
Organization resource name
List Access Request Model
- options
- AccessListClustersOptionalParams
The options parameters.
Returns
Promise<AccessListClusterSuccessResponse>
listEnvironments(string, string, ListAccessRequestModel, AccessListEnvironmentsOptionalParams)
Environment list of an organization
function listEnvironments(resourceGroupName: string, organizationName: string, body: ListAccessRequestModel, options?: AccessListEnvironmentsOptionalParams): Promise<AccessListEnvironmentsSuccessResponse>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- organizationName
-
string
Organization resource name
List Access Request Model
The options parameters.
Returns
listInvitations(string, string, ListAccessRequestModel, AccessListInvitationsOptionalParams)
Organization accounts invitation details
function listInvitations(resourceGroupName: string, organizationName: string, body: ListAccessRequestModel, options?: AccessListInvitationsOptionalParams): Promise<AccessListInvitationsSuccessResponse>
Parameters
- resourceGroupName
-
string
Resource group name
- organizationName
-
string
Organization resource name
List Access Request Model
The options parameters.
Returns
Promise<AccessListInvitationsSuccessResponse>
listRoleBindingNameList(string, string, ListAccessRequestModel, AccessListRoleBindingNameListOptionalParams)
Organization role bindings
function listRoleBindingNameList(resourceGroupName: string, organizationName: string, body: ListAccessRequestModel, options?: AccessListRoleBindingNameListOptionalParams): Promise<AccessRoleBindingNameListSuccessResponse>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- organizationName
-
string
Organization resource name
List Access Request Model
The options parameters.
Returns
listRoleBindings(string, string, ListAccessRequestModel, AccessListRoleBindingsOptionalParams)
Organization role bindings
function listRoleBindings(resourceGroupName: string, organizationName: string, body: ListAccessRequestModel, options?: AccessListRoleBindingsOptionalParams): Promise<AccessListRoleBindingsSuccessResponse>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- organizationName
-
string
Organization resource name
List Access Request Model
The options parameters.
Returns
listServiceAccounts(string, string, ListAccessRequestModel, AccessListServiceAccountsOptionalParams)
Organization service accounts details
function listServiceAccounts(resourceGroupName: string, organizationName: string, body: ListAccessRequestModel, options?: AccessListServiceAccountsOptionalParams): Promise<AccessListServiceAccountsSuccessResponse>
Parameters
- resourceGroupName
-
string
Resource group name
- organizationName
-
string
Organization resource name
List Access Request Model
The options parameters.
Returns
listUsers(string, string, ListAccessRequestModel, AccessListUsersOptionalParams)
Organization users details
function listUsers(resourceGroupName: string, organizationName: string, body: ListAccessRequestModel, options?: AccessListUsersOptionalParams): Promise<AccessListUsersSuccessResponse>
Parameters
- resourceGroupName
-
string
Resource group name
- organizationName
-
string
Organization resource name
List Access Request Model
- options
- AccessListUsersOptionalParams
The options parameters.
Returns
Promise<AccessListUsersSuccessResponse>