Package com.azure.resourcemanager.resources.fluent

Interface ResourceGroupsClient

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

    • Method Detail

      • checkExistenceWithResponseAsync

        Mono<com.azure.core.http.rest.Response<Boolean>> checkExistenceWithResponseAsync​(String resourceGroupName)
        Checks whether a resource group exists.
        Parameters:
        resourceGroupName - The name of the resource group to check. The name is case insensitive.
        Returns:
        whether resource exists 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.

      • checkExistenceAsync

        Mono<Boolean> checkExistenceAsync​(String resourceGroupName)
        Checks whether a resource group exists.
        Parameters:
        resourceGroupName - The name of the resource group to check. The name is case insensitive.
        Returns:
        whether resource exists 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.

      • checkExistence

        boolean checkExistence​(String resourceGroupName)
        Checks whether a resource group exists.
        Parameters:
        resourceGroupName - The name of the resource group to check. The name is case insensitive.
        Returns:
        whether resource exists.
        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.

      • checkExistenceWithResponse

        com.azure.core.http.rest.Response<Boolean> checkExistenceWithResponse​(String resourceGroupName,
                                                                      com.azure.core.util.Context context)
        Checks whether a resource group exists.
        Parameters:
        resourceGroupName - The name of the resource group to check. The name is case insensitive.
        context - The context to associate with this operation.
        Returns:
        whether resource exists 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.

      • createOrUpdateWithResponseAsync

        Mono<com.azure.core.http.rest.Response<ResourceGroupInner>> createOrUpdateWithResponseAsync​(String resourceGroupName,
                                                                                            ResourceGroupInner parameters)
        Creates or updates a resource group.
        Parameters:
        resourceGroupName - The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.
        parameters - Parameters supplied to the create or update a resource group.
        Returns:
        resource group 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.

      • createOrUpdateAsync

        Mono<ResourceGroupInner> createOrUpdateAsync​(String resourceGroupName,
                                             ResourceGroupInner parameters)
        Creates or updates a resource group.
        Parameters:
        resourceGroupName - The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.
        parameters - Parameters supplied to the create or update a resource group.
        Returns:
        resource group 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.

      • createOrUpdate

        ResourceGroupInner createOrUpdate​(String resourceGroupName,
                                  ResourceGroupInner parameters)
        Creates or updates a resource group.
        Parameters:
        resourceGroupName - The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.
        parameters - Parameters supplied to the create or update a resource group.
        Returns:
        resource group 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.

      • createOrUpdateWithResponse

        com.azure.core.http.rest.Response<ResourceGroupInner> createOrUpdateWithResponse​(String resourceGroupName,
                                                                                 ResourceGroupInner parameters,
                                                                                 com.azure.core.util.Context context)
        Creates or updates a resource group.
        Parameters:
        resourceGroupName - The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.
        parameters - Parameters supplied to the create or update a resource group.
        context - The context to associate with this operation.
        Returns:
        resource group 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.

      • deleteWithResponseAsync

        Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> deleteWithResponseAsync​(String resourceGroupName,
                                                                                  String forceDeletionTypes)
        When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.
        Parameters:
        resourceGroupName - The name of the resource group to delete. The name is case insensitive.
        forceDeletionTypes - The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets.
        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.

      • beginDeleteAsync

        com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<Void>,​Void> beginDeleteAsync​(String resourceGroupName,
                                                                                                                       String forceDeletionTypes)
        When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.
        Parameters:
        resourceGroupName - The name of the resource group to delete. The name is case insensitive.
        forceDeletionTypes - The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets.
        Returns:
        the PollerFlux for polling of long-running operation.
        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.

      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                  String forceDeletionTypes)
        When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.
        Parameters:
        resourceGroupName - The name of the resource group to delete. The name is case insensitive.
        forceDeletionTypes - The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets.
        Returns:
        the SyncPoller for polling of long-running operation.
        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.

      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                  String forceDeletionTypes,
                                                                                                                  com.azure.core.util.Context context)
        When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.
        Parameters:
        resourceGroupName - The name of the resource group to delete. The name is case insensitive.
        forceDeletionTypes - The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of long-running operation.
        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<Void> deleteAsync​(String resourceGroupName,
                       String forceDeletionTypes)
        When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.
        Parameters:
        resourceGroupName - The name of the resource group to delete. The name is case insensitive.
        forceDeletionTypes - The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets.
        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.

      • deleteAsync

        Mono<Void> deleteAsync​(String resourceGroupName)
        When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.
        Parameters:
        resourceGroupName - The name of the resource group to delete. The name is case insensitive.
        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.

      • delete

        void delete​(String resourceGroupName,
            String forceDeletionTypes)
        When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.
        Parameters:
        resourceGroupName - The name of the resource group to delete. The name is case insensitive.
        forceDeletionTypes - The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets.
        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

        void delete​(String resourceGroupName)
        When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.
        Parameters:
        resourceGroupName - The name of the resource group to delete. The name is case insensitive.
        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

        void delete​(String resourceGroupName,
            String forceDeletionTypes,
            com.azure.core.util.Context context)
        When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.
        Parameters:
        resourceGroupName - The name of the resource group to delete. The name is case insensitive.
        forceDeletionTypes - The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets.
        context - The context to associate with this operation.
        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<ResourceGroupInner>> getWithResponseAsync​(String resourceGroupName)
        Gets a resource group.
        Parameters:
        resourceGroupName - The name of the resource group to get. The name is case insensitive.
        Returns:
        a resource group 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<ResourceGroupInner> getAsync​(String resourceGroupName)
        Gets a resource group.
        Parameters:
        resourceGroupName - The name of the resource group to get. The name is case insensitive.
        Returns:
        a resource group 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.

      • get

        ResourceGroupInner get​(String resourceGroupName)
        Gets a resource group.
        Parameters:
        resourceGroupName - The name of the resource group to get. The name is case insensitive.
        Returns:
        a resource group.
        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<ResourceGroupInner> getWithResponse​(String resourceGroupName,
                                                                      com.azure.core.util.Context context)
        Gets a resource group.
        Parameters:
        resourceGroupName - The name of the resource group to get. The name is case insensitive.
        context - The context to associate with this operation.
        Returns:
        a resource group 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.

      • updateWithResponseAsync

        Mono<com.azure.core.http.rest.Response<ResourceGroupInner>> updateWithResponseAsync​(String resourceGroupName,
                                                                                    ResourceGroupPatchable parameters)
        Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.
        Parameters:
        resourceGroupName - The name of the resource group to update. The name is case insensitive.
        parameters - Parameters supplied to update a resource group.
        Returns:
        resource group 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.

      • updateAsync

        Mono<ResourceGroupInner> updateAsync​(String resourceGroupName,
                                     ResourceGroupPatchable parameters)
        Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.
        Parameters:
        resourceGroupName - The name of the resource group to update. The name is case insensitive.
        parameters - Parameters supplied to update a resource group.
        Returns:
        resource group 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.

      • update

        ResourceGroupInner update​(String resourceGroupName,
                          ResourceGroupPatchable parameters)
        Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.
        Parameters:
        resourceGroupName - The name of the resource group to update. The name is case insensitive.
        parameters - Parameters supplied to update a resource group.
        Returns:
        resource group 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.

      • updateWithResponse

        com.azure.core.http.rest.Response<ResourceGroupInner> updateWithResponse​(String resourceGroupName,
                                                                         ResourceGroupPatchable parameters,
                                                                         com.azure.core.util.Context context)
        Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.
        Parameters:
        resourceGroupName - The name of the resource group to update. The name is case insensitive.
        parameters - Parameters supplied to update a resource group.
        context - The context to associate with this operation.
        Returns:
        resource group 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.

      • exportTemplateWithResponseAsync

        Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> exportTemplateWithResponseAsync​(String resourceGroupName,
                                                                                          ExportTemplateRequest parameters)
        Captures the specified resource group as a template.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        parameters - Parameters for exporting the template.
        Returns:
        resource group export result 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.

      • beginExportTemplateAsync

        com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<ResourceGroupExportResultInner>,​ResourceGroupExportResultInner> beginExportTemplateAsync​(String resourceGroupName,
                                                                                                                                                                                   ExportTemplateRequest parameters)
        Captures the specified resource group as a template.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        parameters - Parameters for exporting the template.
        Returns:
        the PollerFlux for polling of resource group export result.
        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.

      • beginExportTemplate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ResourceGroupExportResultInner>,​ResourceGroupExportResultInner> beginExportTemplate​(String resourceGroupName,
                                                                                                                                                                              ExportTemplateRequest parameters)
        Captures the specified resource group as a template.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        parameters - Parameters for exporting the template.
        Returns:
        the SyncPoller for polling of resource group export result.
        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.

      • beginExportTemplate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ResourceGroupExportResultInner>,​ResourceGroupExportResultInner> beginExportTemplate​(String resourceGroupName,
                                                                                                                                                                              ExportTemplateRequest parameters,
                                                                                                                                                                              com.azure.core.util.Context context)
        Captures the specified resource group as a template.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        parameters - Parameters for exporting the template.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of resource group export result.
        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.

      • exportTemplateAsync

        Mono<ResourceGroupExportResultInner> exportTemplateAsync​(String resourceGroupName,
                                                         ExportTemplateRequest parameters)
        Captures the specified resource group as a template.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        parameters - Parameters for exporting the template.
        Returns:
        resource group export result 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.

      • exportTemplate

        ResourceGroupExportResultInner exportTemplate​(String resourceGroupName,
                                              ExportTemplateRequest parameters)
        Captures the specified resource group as a template.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        parameters - Parameters for exporting the template.
        Returns:
        resource group export result.
        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.

      • exportTemplate

        ResourceGroupExportResultInner exportTemplate​(String resourceGroupName,
                                              ExportTemplateRequest parameters,
                                              com.azure.core.util.Context context)
        Captures the specified resource group as a template.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        parameters - Parameters for exporting the template.
        context - The context to associate with this operation.
        Returns:
        resource group export result.
        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<ResourceGroupInner> listAsync​(String filter,
                                                                 Integer top)
        Gets all the resource groups for a subscription.
        Parameters:
        filter - The filter to apply on the operation.<br><br>You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'.
        top - The number of results to return. If null is passed, returns all resource groups.
        Returns:
        all the resource groups 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<ResourceGroupInner> listAsync()
        Gets all the resource groups for a subscription.
        Returns:
        all the resource groups 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<ResourceGroupInner> list()
        Gets all the resource groups for a subscription.
        Returns:
        all the resource groups 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<ResourceGroupInner> list​(String filter,
                                                                Integer top,
                                                                com.azure.core.util.Context context)
        Gets all the resource groups for a subscription.
        Parameters:
        filter - The filter to apply on the operation.<br><br>You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'.
        top - The number of results to return. If null is passed, returns all resource groups.
        context - The context to associate with this operation.
        Returns:
        all the resource groups 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.