ProvidersClient Interface

Package:

com.azure.resourcemanager.resources.fluent

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-resources:2.40.0

public interface ProvidersClient

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

Method Summary

Modifier and Type	Method and Description
abstract ProviderInner	get(String resourceProviderNamespace) Gets the specified resource provider.
abstract Mono<ProviderInner>	getAsync(String resourceProviderNamespace) Gets the specified resource provider.
abstract ProviderInner	getAtTenantScope(String resourceProviderNamespace) Gets the specified resource provider at the tenant level.
abstract Mono<ProviderInner>	getAtTenantScopeAsync(String resourceProviderNamespace) Gets the specified resource provider at the tenant level.
abstract Response<ProviderInner>	getAtTenantScopeWithResponse(String resourceProviderNamespace, String expand, Context context) Gets the specified resource provider at the tenant level.
abstract Mono<Response<ProviderInner>>	getAtTenantScopeWithResponseAsync(String resourceProviderNamespace, String expand) Gets the specified resource provider at the tenant level.
abstract Response<ProviderInner>	getWithResponse(String resourceProviderNamespace, String expand, Context context) Gets the specified resource provider.
abstract Mono<Response<ProviderInner>>	getWithResponseAsync(String resourceProviderNamespace, String expand) Gets the specified resource provider.
abstract PagedIterable<ProviderInner>	list() Gets all resource providers for a subscription.
abstract PagedIterable<ProviderInner>	list(String expand, Context context) Gets all resource providers for a subscription.
abstract PagedFlux<ProviderInner>	listAsync() Gets all resource providers for a subscription.
abstract PagedFlux<ProviderInner>	listAsync(String expand) Gets all resource providers for a subscription.
abstract PagedIterable<ProviderInner>	listAtTenantScope() Gets all resource providers for the tenant.
abstract PagedIterable<ProviderInner>	listAtTenantScope(String expand, Context context) Gets all resource providers for the tenant.
abstract PagedFlux<ProviderInner>	listAtTenantScopeAsync() Gets all resource providers for the tenant.
abstract PagedFlux<ProviderInner>	listAtTenantScopeAsync(String expand) Gets all resource providers for the tenant.
abstract ProviderPermissionListResultInner	providerPermissions(String resourceProviderNamespace) Get the provider permissions.
abstract Mono<ProviderPermissionListResultInner>	providerPermissionsAsync(String resourceProviderNamespace) Get the provider permissions.
abstract Response<ProviderPermissionListResultInner>	providerPermissionsWithResponse(String resourceProviderNamespace, Context context) Get the provider permissions.
abstract Mono<Response<ProviderPermissionListResultInner>>	providerPermissionsWithResponseAsync(String resourceProviderNamespace) Get the provider permissions.
abstract ProviderInner	register(String resourceProviderNamespace) Registers a subscription with a resource provider.
abstract Mono<ProviderInner>	registerAsync(String resourceProviderNamespace) Registers a subscription with a resource provider.
abstract void	registerAtManagementGroupScope(String resourceProviderNamespace, String groupId) Registers a management group with a resource provider.
abstract Mono<Void>	registerAtManagementGroupScopeAsync(String resourceProviderNamespace, String groupId) Registers a management group with a resource provider.
abstract Response<Void>	registerAtManagementGroupScopeWithResponse(String resourceProviderNamespace, String groupId, Context context) Registers a management group with a resource provider.
abstract Mono<Response<Void>>	registerAtManagementGroupScopeWithResponseAsync(String resourceProviderNamespace, String groupId) Registers a management group with a resource provider.
abstract Response<ProviderInner>	registerWithResponse(String resourceProviderNamespace, ProviderRegistrationRequest properties, Context context) Registers a subscription with a resource provider.
abstract Mono<Response<ProviderInner>>	registerWithResponseAsync(String resourceProviderNamespace, ProviderRegistrationRequest properties) Registers a subscription with a resource provider.
abstract ProviderInner	unregister(String resourceProviderNamespace) Unregisters a subscription from a resource provider.
abstract Mono<ProviderInner>	unregisterAsync(String resourceProviderNamespace) Unregisters a subscription from a resource provider.
abstract Response<ProviderInner>	unregisterWithResponse(String resourceProviderNamespace, Context context) Unregisters a subscription from a resource provider.
abstract Mono<Response<ProviderInner>>	unregisterWithResponseAsync(String resourceProviderNamespace) Unregisters a subscription from a resource provider.

Method Details

get

public abstract ProviderInner get(String resourceProviderNamespace)

Gets the specified resource provider.

Parameters:

resourceProviderNamespace - The namespace of the resource provider.

Returns:

the specified resource provider.

getAsync

public abstract Mono getAsync(String resourceProviderNamespace)

Gets the specified resource provider.

Parameters:

resourceProviderNamespace - The namespace of the resource provider.

Returns:

the specified resource provider on successful completion of Mono.

getAtTenantScope

public abstract ProviderInner getAtTenantScope(String resourceProviderNamespace)

Gets the specified resource provider at the tenant level.

Parameters:

resourceProviderNamespace - The namespace of the resource provider.

Returns:

the specified resource provider at the tenant level.

getAtTenantScopeAsync

public abstract Mono getAtTenantScopeAsync(String resourceProviderNamespace)

Gets the specified resource provider at the tenant level.

Parameters:

resourceProviderNamespace - The namespace of the resource provider.

Returns:

the specified resource provider at the tenant level on successful completion of Mono.

getAtTenantScopeWithResponse

public abstract Response getAtTenantScopeWithResponse(String resourceProviderNamespace, String expand, Context context)

Gets the specified resource provider at the tenant level.

Parameters:

resourceProviderNamespace - The namespace of the resource provider.

expand - The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.

context - The context to associate with this operation.

Returns:

the specified resource provider at the tenant level along with Response<T>.

getAtTenantScopeWithResponseAsync

public abstract Mono<>> getAtTenantScopeWithResponseAsync(String resourceProviderNamespace, String expand)

Gets the specified resource provider at the tenant level.

Parameters:

resourceProviderNamespace - The namespace of the resource provider.

expand - The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.

Returns:

the specified resource provider at the tenant level along with Response<T> on successful completion of Mono.

getWithResponse

public abstract Response getWithResponse(String resourceProviderNamespace, String expand, Context context)

Gets the specified resource provider.

Parameters:

resourceProviderNamespace - The namespace of the resource provider.

expand - The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.

context - The context to associate with this operation.

Returns:

the specified resource provider along with Response<T>.

getWithResponseAsync

public abstract Mono<>> getWithResponseAsync(String resourceProviderNamespace, String expand)

Gets the specified resource provider.

Parameters:

resourceProviderNamespace - The namespace of the resource provider.

expand - The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.

Returns:

the specified resource provider along with Response<T> on successful completion of Mono.

list

public abstract PagedIterable list()

Gets all resource providers for a subscription.

Returns:

all resource providers for a subscription as paginated response with PagedIterable<T>.

list

public abstract PagedIterable list(String expand, Context context)

Gets all resource providers for a subscription.

Parameters:

expand - The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases.

context - The context to associate with this operation.

Returns:

all resource providers for a subscription as paginated response with PagedIterable<T>.

listAsync

public abstract PagedFlux listAsync()

Gets all resource providers for a subscription.

Returns:

all resource providers for a subscription as paginated response with PagedFlux<T>.

listAsync

public abstract PagedFlux listAsync(String expand)

Gets all resource providers for a subscription.

Parameters:

expand - The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases.

Returns:

all resource providers for a subscription as paginated response with PagedFlux<T>.

listAtTenantScope

public abstract PagedIterable listAtTenantScope()

Gets all resource providers for the tenant.

Returns:

all resource providers for the tenant as paginated response with PagedIterable<T>.

listAtTenantScope

public abstract PagedIterable listAtTenantScope(String expand, Context context)

Gets all resource providers for the tenant.

Parameters:

expand - The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases.

context - The context to associate with this operation.

Returns:

all resource providers for the tenant as paginated response with PagedIterable<T>.

listAtTenantScopeAsync

public abstract PagedFlux listAtTenantScopeAsync()

Gets all resource providers for the tenant.

Returns:

all resource providers for the tenant as paginated response with PagedFlux<T>.

listAtTenantScopeAsync

public abstract PagedFlux listAtTenantScopeAsync(String expand)

Gets all resource providers for the tenant.

Parameters:

expand - The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases.

Returns:

all resource providers for the tenant as paginated response with PagedFlux<T>.

providerPermissions

public abstract ProviderPermissionListResultInner providerPermissions(String resourceProviderNamespace)

Get the provider permissions.

Parameters:

resourceProviderNamespace - The namespace of the resource provider.

Returns:

the provider permissions.

providerPermissionsAsync

public abstract Mono providerPermissionsAsync(String resourceProviderNamespace)

Get the provider permissions.

Parameters:

resourceProviderNamespace - The namespace of the resource provider.

Returns:

the provider permissions on successful completion of Mono.

providerPermissionsWithResponse

public abstract Response providerPermissionsWithResponse(String resourceProviderNamespace, Context context)

Get the provider permissions.

Parameters:

resourceProviderNamespace - The namespace of the resource provider.

context - The context to associate with this operation.

Returns:

the provider permissions along with Response<T>.

providerPermissionsWithResponseAsync

public abstract Mono<>> providerPermissionsWithResponseAsync(String resourceProviderNamespace)

Get the provider permissions.

Parameters:

resourceProviderNamespace - The namespace of the resource provider.

Returns:

the provider permissions along with Response<T> on successful completion of Mono.

register

public abstract ProviderInner register(String resourceProviderNamespace)

Registers a subscription with a resource provider.

Parameters:

resourceProviderNamespace - The namespace of the resource provider to register.

Returns:

resource provider information.

registerAsync

public abstract Mono registerAsync(String resourceProviderNamespace)

Registers a subscription with a resource provider.

Parameters:

resourceProviderNamespace - The namespace of the resource provider to register.

Returns:

resource provider information on successful completion of Mono.

registerAtManagementGroupScope

public abstract void registerAtManagementGroupScope(String resourceProviderNamespace, String groupId)

Registers a management group with a resource provider. Use this operation to register a resource provider with resource types that can be deployed at the management group scope. It does not recursively register subscriptions within the management group. Instead, you must register subscriptions individually.

Parameters:

resourceProviderNamespace - The namespace of the resource provider to register.

groupId - The management group ID.

registerAtManagementGroupScopeAsync

public abstract Mono registerAtManagementGroupScopeAsync(String resourceProviderNamespace, String groupId)

Registers a management group with a resource provider. Use this operation to register a resource provider with resource types that can be deployed at the management group scope. It does not recursively register subscriptions within the management group. Instead, you must register subscriptions individually.

Parameters:

resourceProviderNamespace - The namespace of the resource provider to register.

groupId - The management group ID.

Returns:

A Mono that completes when a successful response is received.

registerAtManagementGroupScopeWithResponse

public abstract Response registerAtManagementGroupScopeWithResponse(String resourceProviderNamespace, String groupId, Context context)

Registers a management group with a resource provider. Use this operation to register a resource provider with resource types that can be deployed at the management group scope. It does not recursively register subscriptions within the management group. Instead, you must register subscriptions individually.

Parameters:

resourceProviderNamespace - The namespace of the resource provider to register.

groupId - The management group ID.

context - The context to associate with this operation.

Returns:

the Response<T>.

registerAtManagementGroupScopeWithResponseAsync

public abstract Mono<>> registerAtManagementGroupScopeWithResponseAsync(String resourceProviderNamespace, String groupId)

Registers a management group with a resource provider. Use this operation to register a resource provider with resource types that can be deployed at the management group scope. It does not recursively register subscriptions within the management group. Instead, you must register subscriptions individually.

Parameters:

resourceProviderNamespace - The namespace of the resource provider to register.

groupId - The management group ID.

Returns:

the Response<T> on successful completion of Mono.

registerWithResponse

public abstract Response registerWithResponse(String resourceProviderNamespace, ProviderRegistrationRequest properties, Context context)

Registers a subscription with a resource provider.

Parameters:

resourceProviderNamespace - The namespace of the resource provider to register.

properties - The third party consent for S2S.

context - The context to associate with this operation.

Returns:

resource provider information along with Response<T>.

registerWithResponseAsync

public abstract Mono<>> registerWithResponseAsync(String resourceProviderNamespace, ProviderRegistrationRequest properties)

Registers a subscription with a resource provider.

Parameters:

resourceProviderNamespace - The namespace of the resource provider to register.

properties - The third party consent for S2S.

Returns:

resource provider information along with Response<T> on successful completion of Mono.

unregister

public abstract ProviderInner unregister(String resourceProviderNamespace)

Unregisters a subscription from a resource provider.

Parameters:

resourceProviderNamespace - The namespace of the resource provider to unregister.

Returns:

resource provider information.

unregisterAsync

public abstract Mono unregisterAsync(String resourceProviderNamespace)

Unregisters a subscription from a resource provider.

Parameters:

resourceProviderNamespace - The namespace of the resource provider to unregister.

Returns:

resource provider information on successful completion of Mono.

unregisterWithResponse

public abstract Response unregisterWithResponse(String resourceProviderNamespace, Context context)

Unregisters a subscription from a resource provider.

Parameters:

resourceProviderNamespace - The namespace of the resource provider to unregister.

context - The context to associate with this operation.

Returns:

resource provider information along with Response<T>.

unregisterWithResponseAsync

public abstract Mono<>> unregisterWithResponseAsync(String resourceProviderNamespace)

Unregisters a subscription from a resource provider.

Parameters:

resourceProviderNamespace - The namespace of the resource provider to unregister.

Returns:

resource provider information along with Response<T> on successful completion of Mono.