Package com.azure.resourcemanager.authorization.fluent

Interface RoleDefinitionsClient

All Superinterfaces:

InnerSupportsDelete<RoleDefinitionInner>

public interface RoleDefinitionsClient
extends InnerSupportsDelete<RoleDefinitionInner>

An instance of this class provides access to all the operations defined in RoleDefinitionsClient.

Method Summary

Modifier and Type	Method	Description
RoleDefinitionInner	createOrUpdate(String scope, String roleDefinitionId, RoleDefinitionInner roleDefinition)	Creates or updates a role definition.
Mono<RoleDefinitionInner>	createOrUpdateAsync(String scope, String roleDefinitionId, RoleDefinitionInner roleDefinition)	Creates or updates a role definition.
com.azure.core.http.rest.Response<RoleDefinitionInner>	createOrUpdateWithResponse(String scope, String roleDefinitionId, RoleDefinitionInner roleDefinition, com.azure.core.util.Context context)	Creates or updates a role definition.
Mono<com.azure.core.http.rest.Response<RoleDefinitionInner>>	createOrUpdateWithResponseAsync(String scope, String roleDefinitionId, RoleDefinitionInner roleDefinition)	Creates or updates a role definition.
RoleDefinitionInner	delete(String scope, String roleDefinitionId)	Deletes a role definition.
Mono<RoleDefinitionInner>	deleteAsync(String scope, String roleDefinitionId)	Deletes a role definition.
com.azure.core.http.rest.Response<RoleDefinitionInner>	deleteWithResponse(String scope, String roleDefinitionId, com.azure.core.util.Context context)	Deletes a role definition.
Mono<com.azure.core.http.rest.Response<RoleDefinitionInner>>	deleteWithResponseAsync(String scope, String roleDefinitionId)	Deletes a role definition.
RoleDefinitionInner	get(String scope, String roleDefinitionId)	Get role definition by name (GUID).
Mono<RoleDefinitionInner>	getAsync(String scope, String roleDefinitionId)	Get role definition by name (GUID).
RoleDefinitionInner	getById(String roleId)	Gets a role definition by ID.
Mono<RoleDefinitionInner>	getByIdAsync(String roleId)	Gets a role definition by ID.
com.azure.core.http.rest.Response<RoleDefinitionInner>	getByIdWithResponse(String roleId, com.azure.core.util.Context context)	Gets a role definition by ID.
Mono<com.azure.core.http.rest.Response<RoleDefinitionInner>>	getByIdWithResponseAsync(String roleId)	Gets a role definition by ID.
com.azure.core.http.rest.Response<RoleDefinitionInner>	getWithResponse(String scope, String roleDefinitionId, com.azure.core.util.Context context)	Get role definition by name (GUID).
Mono<com.azure.core.http.rest.Response<RoleDefinitionInner>>	getWithResponseAsync(String scope, String roleDefinitionId)	Get role definition by name (GUID).
com.azure.core.http.rest.PagedIterable<RoleDefinitionInner>	list(String scope)	Get all role definitions that are applicable at scope and above.
com.azure.core.http.rest.PagedIterable<RoleDefinitionInner>	list(String scope, String filter, com.azure.core.util.Context context)	Get all role definitions that are applicable at scope and above.
com.azure.core.http.rest.PagedFlux<RoleDefinitionInner>	listAsync(String scope)	Get all role definitions that are applicable at scope and above.
com.azure.core.http.rest.PagedFlux<RoleDefinitionInner>	listAsync(String scope, String filter)	Get all role definitions that are applicable at scope and above.

Method Detail

deleteWithResponseAsync

Mono<com.azure.core.http.rest.Response<RoleDefinitionInner>> deleteWithResponseAsync(String scope,
                                                                                     String roleDefinitionId)

Deletes a role definition.

Parameters:

scope - The scope of the role definition.

roleDefinitionId - The ID of the role definition to delete.

Returns:

role definition.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteAsync

Mono<RoleDefinitionInner> deleteAsync(String scope,
                                      String roleDefinitionId)

Deletes a role definition.

Specified by:

deleteAsync in interface InnerSupportsDelete<RoleDefinitionInner>

Parameters:

scope - The scope of the role definition.

roleDefinitionId - The ID of the role definition to delete.

Returns:

role definition.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

RoleDefinitionInner delete(String scope,
                           String roleDefinitionId)

Deletes a role definition.

Parameters:

scope - The scope of the role definition.

roleDefinitionId - The ID of the role definition to delete.

Returns:

role definition.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteWithResponse

com.azure.core.http.rest.Response<RoleDefinitionInner> deleteWithResponse(String scope,
                                                                          String roleDefinitionId,
                                                                          com.azure.core.util.Context context)

Deletes a role definition.

Parameters:

scope - The scope of the role definition.

roleDefinitionId - The ID of the role definition to delete.

context - The context to associate with this operation.

Returns:

role definition.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponseAsync

Mono<com.azure.core.http.rest.Response<RoleDefinitionInner>> getWithResponseAsync(String scope,
                                                                                  String roleDefinitionId)

Get role definition by name (GUID).

Parameters:

scope - The scope of the role definition.

roleDefinitionId - The ID of the role definition.

Returns:

role definition by name (GUID).

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getAsync

Mono<RoleDefinitionInner> getAsync(String scope,
                                   String roleDefinitionId)

Get role definition by name (GUID).

Parameters:

scope - The scope of the role definition.

roleDefinitionId - The ID of the role definition.

Returns:

role definition by name (GUID).

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

get

RoleDefinitionInner get(String scope,
                        String roleDefinitionId)

Get role definition by name (GUID).

Parameters:

scope - The scope of the role definition.

roleDefinitionId - The ID of the role definition.

Returns:

role definition by name (GUID).

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponse

com.azure.core.http.rest.Response<RoleDefinitionInner> getWithResponse(String scope,
                                                                       String roleDefinitionId,
                                                                       com.azure.core.util.Context context)

Get role definition by name (GUID).

Parameters:

scope - The scope of the role definition.

roleDefinitionId - The ID of the role definition.

context - The context to associate with this operation.

Returns:

role definition by name (GUID).

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateWithResponseAsync

Mono<com.azure.core.http.rest.Response<RoleDefinitionInner>> createOrUpdateWithResponseAsync(String scope,
                                                                                             String roleDefinitionId,
                                                                                             RoleDefinitionInner roleDefinition)

Creates or updates a role definition.

Parameters:

scope - The scope of the role definition.

roleDefinitionId - The ID of the role definition.

roleDefinition - The values for the role definition.

Returns:

role definition.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateAsync

Mono<RoleDefinitionInner> createOrUpdateAsync(String scope,
                                              String roleDefinitionId,
                                              RoleDefinitionInner roleDefinition)

Creates or updates a role definition.

Parameters:

scope - The scope of the role definition.

roleDefinitionId - The ID of the role definition.

roleDefinition - The values for the role definition.

Returns:

role definition.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

RoleDefinitionInner createOrUpdate(String scope,
                                   String roleDefinitionId,
                                   RoleDefinitionInner roleDefinition)

Creates or updates a role definition.

Parameters:

scope - The scope of the role definition.

roleDefinitionId - The ID of the role definition.

roleDefinition - The values for the role definition.

Returns:

role definition.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateWithResponse

com.azure.core.http.rest.Response<RoleDefinitionInner> createOrUpdateWithResponse(String scope,
                                                                                  String roleDefinitionId,
                                                                                  RoleDefinitionInner roleDefinition,
                                                                                  com.azure.core.util.Context context)

Creates or updates a role definition.

Parameters:

scope - The scope of the role definition.

roleDefinitionId - The ID of the role definition.

roleDefinition - The values for the role definition.

context - The context to associate with this operation.

Returns:

role definition.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listAsync

com.azure.core.http.rest.PagedFlux<RoleDefinitionInner> listAsync(String scope,
                                                                  String filter)

Get all role definitions that are applicable at scope and above.

Parameters:

scope - The scope of the role definition.

filter - The filter to apply on the operation. Use atScopeAndBelow filter to search below the given scope as well.

Returns:

all role definitions that are applicable at scope and above.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listAsync

com.azure.core.http.rest.PagedFlux<RoleDefinitionInner> listAsync(String scope)

Get all role definitions that are applicable at scope and above.

Parameters:

scope - The scope of the role definition.

Returns:

all role definitions that are applicable at scope and above.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<RoleDefinitionInner> list(String scope)

Get all role definitions that are applicable at scope and above.

Parameters:

scope - The scope of the role definition.

Returns:

all role definitions that are applicable at scope and above.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<RoleDefinitionInner> list(String scope,
                                                                 String filter,
                                                                 com.azure.core.util.Context context)

Get all role definitions that are applicable at scope and above.

Parameters:

scope - The scope of the role definition.

filter - The filter to apply on the operation. Use atScopeAndBelow filter to search below the given scope as well.

context - The context to associate with this operation.

Returns:

all role definitions that are applicable at scope and above.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByIdWithResponseAsync

Mono<com.azure.core.http.rest.Response<RoleDefinitionInner>> getByIdWithResponseAsync(String roleId)

Gets a role definition by ID.

Parameters:

roleId - The fully qualified role definition ID. Use the format, /subscriptions/{guid}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for subscription level role definitions, or /providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for tenant level role definitions.

Returns:

a role definition by ID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByIdAsync

Mono<RoleDefinitionInner> getByIdAsync(String roleId)

Gets a role definition by ID.

Parameters:

roleId - The fully qualified role definition ID. Use the format, /subscriptions/{guid}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for subscription level role definitions, or /providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for tenant level role definitions.

Returns:

a role definition by ID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getById

RoleDefinitionInner getById(String roleId)

Gets a role definition by ID.

Parameters:

roleId - The fully qualified role definition ID. Use the format, /subscriptions/{guid}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for subscription level role definitions, or /providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for tenant level role definitions.

Returns:

a role definition by ID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByIdWithResponse

com.azure.core.http.rest.Response<RoleDefinitionInner> getByIdWithResponse(String roleId,
                                                                           com.azure.core.util.Context context)

Gets a role definition by ID.

Parameters:

roleId - The fully qualified role definition ID. Use the format, /subscriptions/{guid}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for subscription level role definitions, or /providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for tenant level role definitions.

context - The context to associate with this operation.

Returns:

a role definition by ID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.