Roles interface
Interface representing a Roles.
Methods
| begin |
Creates a new role or updates an existing role. |
| begin |
Creates a new role or updates an existing role. |
| begin |
Deletes a cluster role. |
| begin |
Deletes a cluster role. |
| get(string, string, string, Roles |
Gets information about a cluster role. |
| list |
List all the roles in a given cluster. |
Method Details
beginCreate(string, string, string, Role, RolesCreateOptionalParams)
Creates a new role or updates an existing role.
function beginCreate(resourceGroupName: string, clusterName: string, roleName: string, parameters: Role, options?: RolesCreateOptionalParams): Promise<SimplePollerLike<OperationState<Role>, Role>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the cluster.
- roleName
-
string
The name of the cluster role.
- parameters
- Role
The required parameters for creating or updating a role.
- options
- RolesCreateOptionalParams
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<Role>, Role>>
beginCreateAndWait(string, string, string, Role, RolesCreateOptionalParams)
Creates a new role or updates an existing role.
function beginCreateAndWait(resourceGroupName: string, clusterName: string, roleName: string, parameters: Role, options?: RolesCreateOptionalParams): Promise<Role>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the cluster.
- roleName
-
string
The name of the cluster role.
- parameters
- Role
The required parameters for creating or updating a role.
- options
- RolesCreateOptionalParams
The options parameters.
Returns
Promise<Role>
beginDelete(string, string, string, RolesDeleteOptionalParams)
Deletes a cluster role.
function beginDelete(resourceGroupName: string, clusterName: string, roleName: string, options?: RolesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<RolesDeleteHeaders>, RolesDeleteHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the cluster.
- roleName
-
string
The name of the cluster role.
- options
- RolesDeleteOptionalParams
The options parameters.
Returns
beginDeleteAndWait(string, string, string, RolesDeleteOptionalParams)
Deletes a cluster role.
function beginDeleteAndWait(resourceGroupName: string, clusterName: string, roleName: string, options?: RolesDeleteOptionalParams): Promise<RolesDeleteHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the cluster.
- roleName
-
string
The name of the cluster role.
- options
- RolesDeleteOptionalParams
The options parameters.
Returns
Promise<RolesDeleteHeaders>
get(string, string, string, RolesGetOptionalParams)
Gets information about a cluster role.
function get(resourceGroupName: string, clusterName: string, roleName: string, options?: RolesGetOptionalParams): Promise<Role>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the cluster.
- roleName
-
string
The name of the cluster role.
- options
- RolesGetOptionalParams
The options parameters.
Returns
Promise<Role>
listByCluster(string, string, RolesListByClusterOptionalParams)
List all the roles in a given cluster.
function listByCluster(resourceGroupName: string, clusterName: string, options?: RolesListByClusterOptionalParams): PagedAsyncIterableIterator<Role, Role[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the cluster.
- options
- RolesListByClusterOptionalParams
The options parameters.