Interface ProvidersClient


public interface ProvidersClient
An instance of this class provides access to all the operations defined in ProvidersClient.
  • Method Details

    • unregisterWithResponseAsync

      Mono<com.azure.core.http.rest.Response<ProviderInner>> 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 on successful completion of Mono.
      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.
    • unregisterAsync

      Mono<ProviderInner> 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.
      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.
    • unregisterWithResponse

      com.azure.core.http.rest.Response<ProviderInner> unregisterWithResponse(String resourceProviderNamespace, com.azure.core.util.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.
      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.
    • unregister

      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.
      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.
    • registerAtManagementGroupScopeWithResponseAsync

      Mono<com.azure.core.http.rest.Response<Void>> 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 on successful completion of Mono.
      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.
    • registerAtManagementGroupScopeAsync

      Mono<Void> 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.
      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.
    • registerAtManagementGroupScopeWithResponse

      com.azure.core.http.rest.Response<Void> registerAtManagementGroupScopeWithResponse(String resourceProviderNamespace, String groupId, com.azure.core.util.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.
      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.
    • registerAtManagementGroupScope

      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.
      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.
    • providerPermissionsWithResponseAsync

      Mono<com.azure.core.http.rest.Response<ProviderPermissionListResultInner>> providerPermissionsWithResponseAsync(String resourceProviderNamespace)
      Get the provider permissions.
      Parameters:
      resourceProviderNamespace - The namespace of the resource provider.
      Returns:
      the provider permissions along with Response on successful completion of Mono.
      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.
    • providerPermissionsAsync

      Mono<ProviderPermissionListResultInner> providerPermissionsAsync(String resourceProviderNamespace)
      Get the provider permissions.
      Parameters:
      resourceProviderNamespace - The namespace of the resource provider.
      Returns:
      the provider permissions on successful completion of Mono.
      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.
    • providerPermissionsWithResponse

      com.azure.core.http.rest.Response<ProviderPermissionListResultInner> providerPermissionsWithResponse(String resourceProviderNamespace, com.azure.core.util.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.
      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.
    • providerPermissions

      ProviderPermissionListResultInner providerPermissions(String resourceProviderNamespace)
      Get the provider permissions.
      Parameters:
      resourceProviderNamespace - The namespace of the resource provider.
      Returns:
      the provider permissions.
      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.
    • registerWithResponseAsync

      Mono<com.azure.core.http.rest.Response<ProviderInner>> 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 on successful completion of Mono.
      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.
    • registerAsync

      Mono<ProviderInner> 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.
      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.
    • registerWithResponse

      com.azure.core.http.rest.Response<ProviderInner> registerWithResponse(String resourceProviderNamespace, ProviderRegistrationRequest properties, com.azure.core.util.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.
      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.
    • register

      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.
      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<ProviderInner> 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.
      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<ProviderInner> listAsync()
      Gets all resource providers for a subscription.
      Returns:
      all resource providers for a subscription as paginated response with PagedFlux.
      Throws:
      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<ProviderInner> list()
      Gets all resource providers for a subscription.
      Returns:
      all resource providers for a subscription as paginated response with PagedIterable.
      Throws:
      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<ProviderInner> list(String expand, com.azure.core.util.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.
      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.
    • listAtTenantScopeAsync

      com.azure.core.http.rest.PagedFlux<ProviderInner> 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.
      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.
    • listAtTenantScopeAsync

      com.azure.core.http.rest.PagedFlux<ProviderInner> listAtTenantScopeAsync()
      Gets all resource providers for the tenant.
      Returns:
      all resource providers for the tenant as paginated response with PagedFlux.
      Throws:
      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.
    • listAtTenantScope

      com.azure.core.http.rest.PagedIterable<ProviderInner> listAtTenantScope()
      Gets all resource providers for the tenant.
      Returns:
      all resource providers for the tenant as paginated response with PagedIterable.
      Throws:
      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.
    • listAtTenantScope

      com.azure.core.http.rest.PagedIterable<ProviderInner> listAtTenantScope(String expand, com.azure.core.util.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.
      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<ProviderInner>> 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 on successful completion of Mono.
      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<ProviderInner> 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.
      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<ProviderInner> getWithResponse(String resourceProviderNamespace, String expand, com.azure.core.util.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.
      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

      ProviderInner get(String resourceProviderNamespace)
      Gets the specified resource provider.
      Parameters:
      resourceProviderNamespace - The namespace of the resource provider.
      Returns:
      the specified resource provider.
      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.
    • getAtTenantScopeWithResponseAsync

      Mono<com.azure.core.http.rest.Response<ProviderInner>> 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 on successful completion of Mono.
      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.
    • getAtTenantScopeAsync

      Mono<ProviderInner> 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.
      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.
    • getAtTenantScopeWithResponse

      com.azure.core.http.rest.Response<ProviderInner> getAtTenantScopeWithResponse(String resourceProviderNamespace, String expand, com.azure.core.util.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.
      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.
    • getAtTenantScope

      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.
      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.