ResourcesClient Interface
Implements
public interface ResourcesClient
extends InnerSupportsListing<GenericResourceExpandedInner>
An instance of this class provides access to all the operations defined in ResourcesClient.
Method Summary
Method Details
beginCreateOrUpdate
public abstract SyncPoller
Creates a resource.
Parameters:
Returns:
beginCreateOrUpdate
public abstract SyncPoller
Creates a resource.
Parameters:
Returns:
beginCreateOrUpdateAsync
public abstract PollerFlux
Creates a resource.
Parameters:
Returns:
beginCreateOrUpdateById
public abstract SyncPoller
Create a resource by ID.
Parameters:
Returns:
beginCreateOrUpdateById
public abstract SyncPoller
Create a resource by ID.
Parameters:
Returns:
beginCreateOrUpdateByIdAsync
public abstract PollerFlux
Create a resource by ID.
Parameters:
Returns:
beginDelete
public abstract SyncPoller
Deletes a resource.
Parameters:
Returns:
beginDelete
public abstract SyncPoller
Deletes a resource.
Parameters:
Returns:
beginDeleteAsync
public abstract PollerFlux
Deletes a resource.
Parameters:
Returns:
beginDeleteById
public abstract SyncPoller
Deletes a resource by ID.
Parameters:
Returns:
beginDeleteById
public abstract SyncPoller
Deletes a resource by ID.
Parameters:
Returns:
beginDeleteByIdAsync
public abstract PollerFlux
Deletes a resource by ID.
Parameters:
Returns:
beginMoveResources
public abstract SyncPoller
Moves resources from one resource group to another resource group. The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes.
Parameters:
Returns:
beginMoveResources
public abstract SyncPoller
Moves resources from one resource group to another resource group. The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes.
Parameters:
Returns:
beginMoveResourcesAsync
public abstract PollerFlux
Moves resources from one resource group to another resource group. The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes.
Parameters:
Returns:
beginUpdate
public abstract SyncPoller
Updates a resource.
Parameters:
Returns:
beginUpdate
public abstract SyncPoller
Updates a resource.
Parameters:
Returns:
beginUpdateAsync
public abstract PollerFlux
Updates a resource.
Parameters:
Returns:
beginUpdateById
public abstract SyncPoller
Updates a resource by ID.
Parameters:
Returns:
beginUpdateById
public abstract SyncPoller
Updates a resource by ID.
Parameters:
Returns:
beginUpdateByIdAsync
public abstract PollerFlux
Updates a resource by ID.
Parameters:
Returns:
beginValidateMoveResources
public abstract SyncPoller
Validates whether resources can be moved from one resource group to another resource group. This operation checks whether the specified resources can be moved to the target. The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation.
Parameters:
Returns:
beginValidateMoveResources
public abstract SyncPoller
Validates whether resources can be moved from one resource group to another resource group. This operation checks whether the specified resources can be moved to the target. The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation.
Parameters:
Returns:
beginValidateMoveResourcesAsync
public abstract PollerFlux
Validates whether resources can be moved from one resource group to another resource group. This operation checks whether the specified resources can be moved to the target. The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation.
Parameters:
Returns:
checkExistence
public abstract boolean checkExistence(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)
Checks whether a resource exists.
Parameters:
Returns:
checkExistenceAsync
public abstract Mono
Checks whether a resource exists.
Parameters:
Returns:
checkExistenceById
public abstract boolean checkExistenceById(String resourceId, String apiVersion)
Checks by ID whether a resource exists. This API currently works only for a limited set of Resource providers. In the event that a Resource provider does not implement this API, ARM will respond with a 405. The alternative then is to use the GET API to check for the existence of the resource.
Parameters:
Returns:
checkExistenceByIdAsync
public abstract Mono
Checks by ID whether a resource exists. This API currently works only for a limited set of Resource providers. In the event that a Resource provider does not implement this API, ARM will respond with a 405. The alternative then is to use the GET API to check for the existence of the resource.
Parameters:
Returns:
checkExistenceByIdWithResponse
public abstract Response
Checks by ID whether a resource exists. This API currently works only for a limited set of Resource providers. In the event that a Resource provider does not implement this API, ARM will respond with a 405. The alternative then is to use the GET API to check for the existence of the resource.
Parameters:
Returns:
checkExistenceByIdWithResponseAsync
public abstract Mono
Checks by ID whether a resource exists. This API currently works only for a limited set of Resource providers. In the event that a Resource provider does not implement this API, ARM will respond with a 405. The alternative then is to use the GET API to check for the existence of the resource.
Parameters:
Returns:
checkExistenceWithResponse
public abstract Response
Checks whether a resource exists.
Parameters:
Returns:
checkExistenceWithResponseAsync
public abstract Mono
Checks whether a resource exists.
Parameters:
Returns:
createOrUpdate
public abstract GenericResourceInner createOrUpdate(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion, GenericResourceInner parameters)
Creates a resource.
Parameters:
Returns:
createOrUpdate
public abstract GenericResourceInner createOrUpdate(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion, GenericResourceInner parameters, Context context)
Creates a resource.
Parameters:
Returns:
createOrUpdateAsync
public abstract Mono
Creates a resource.
Parameters:
Returns:
createOrUpdateById
public abstract GenericResourceInner createOrUpdateById(String resourceId, String apiVersion, GenericResourceInner parameters)
Create a resource by ID.
Parameters:
Returns:
createOrUpdateById
public abstract GenericResourceInner createOrUpdateById(String resourceId, String apiVersion, GenericResourceInner parameters, Context context)
Create a resource by ID.
Parameters:
Returns:
createOrUpdateByIdAsync
public abstract Mono
Create a resource by ID.
Parameters:
Returns:
createOrUpdateByIdWithResponseAsync
public abstract Mono
Create a resource by ID.
Parameters:
Returns:
createOrUpdateWithResponseAsync
public abstract Mono
Creates a resource.
Parameters:
Returns:
delete
public abstract void delete(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)
Deletes a resource.
Parameters:
delete
public abstract void delete(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion, Context context)
Deletes a resource.
Parameters:
deleteAsync
public abstract Mono
Deletes a resource.
Parameters:
Returns:
deleteById
public abstract void deleteById(String resourceId, String apiVersion)
Deletes a resource by ID.
Parameters:
deleteById
public abstract void deleteById(String resourceId, String apiVersion, Context context)
Deletes a resource by ID.
Parameters:
deleteByIdAsync
public abstract Mono
Deletes a resource by ID.
Parameters:
Returns:
deleteByIdWithResponseAsync
public abstract Mono
Deletes a resource by ID.
Parameters:
Returns:
deleteWithResponseAsync
public abstract Mono
Deletes a resource.
Parameters:
Returns:
get
public abstract GenericResourceInner get(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)
Gets a resource.
Parameters:
Returns:
getAsync
public abstract Mono
Gets a resource.
Parameters:
Returns:
getById
public abstract GenericResourceInner getById(String resourceId, String apiVersion)
Gets a resource by ID.
Parameters:
Returns:
getByIdAsync
public abstract Mono
Gets a resource by ID.
Parameters:
Returns:
getByIdWithResponse
public abstract Response
Gets a resource by ID.
Parameters:
Returns:
getByIdWithResponseAsync
public abstract Mono
Gets a resource by ID.
Parameters:
Returns:
getWithResponse
public abstract Response
Gets a resource.
Parameters:
Returns:
getWithResponseAsync
public abstract Mono
Gets a resource.
Parameters:
Returns:
list
public abstract PagedIterable
Get all the resources in a subscription.
Returns:
list
public abstract PagedIterable
Get all the resources in a subscription.
Parameters:
eq
(equals) and ne
(not equals) and may be used with the following properties: location
, resourceType
, name
,
resourceGroup
, identity
, identity/principalId
, plan
, plan/publisher
, plan/product
, plan/name
,
plan/version
, and plan/promotionCode
.<br><br>For example, to filter by a resource type, use
$filter=resourceType eq 'Microsoft.Network/virtualNetworks'
<br><br><br>substringof(value, property)
can be used to filter for substrings of the following currently-supported properties: name
and
resourceGroup
<br><br>For example, to get all resources with 'demo' anywhere in the resource name,
use $filter=substringof('demo', name)
<br><br>Multiple substring operations can also be combined
using and
/or
operators.<br><br>Note that any truncated number of results queried via $top
may
also not be compatible when using a filter.<br><br><br>Resources can be filtered by tag names
and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'
. Note that when resources are filtered by tag name and value, <b>the original tags for each
resource will not be returned in the results.</b> Any list of additional properties queried via $expand
may also not be compatible when filtering by tag names/values. <br><br>For tag names only, resources
can be filtered by prefix using the following syntax: $filter=startswith(tagName, 'depart')
. This query will
return all resources with a tag name prefixed by the phrase depart
(i.e.department
, departureDate
,
departureTime
, etc.)<br><br><br>Note that some properties can be combined when filtering
resources, which include the following: substringof() and/or resourceType
, plan and plan/publisher and plan/name
, and identity and identity/principalId
.
createdTime
, changedTime
and provisioningState
. For example, $expand=createdTime,changedTime
.
Returns:
listAsync
public abstract PagedFlux
Get all the resources in a subscription.
Returns:
listAsync
public abstract PagedFlux
Get all the resources in a subscription.
Parameters:
eq
(equals) and ne
(not equals) and may be used with the following properties: location
, resourceType
, name
,
resourceGroup
, identity
, identity/principalId
, plan
, plan/publisher
, plan/product
, plan/name
,
plan/version
, and plan/promotionCode
.<br><br>For example, to filter by a resource type, use
$filter=resourceType eq 'Microsoft.Network/virtualNetworks'
<br><br><br>substringof(value, property)
can be used to filter for substrings of the following currently-supported properties: name
and
resourceGroup
<br><br>For example, to get all resources with 'demo' anywhere in the resource name,
use $filter=substringof('demo', name)
<br><br>Multiple substring operations can also be combined
using and
/or
operators.<br><br>Note that any truncated number of results queried via $top
may
also not be compatible when using a filter.<br><br><br>Resources can be filtered by tag names
and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'
. Note that when resources are filtered by tag name and value, <b>the original tags for each
resource will not be returned in the results.</b> Any list of additional properties queried via $expand
may also not be compatible when filtering by tag names/values. <br><br>For tag names only, resources
can be filtered by prefix using the following syntax: $filter=startswith(tagName, 'depart')
. This query will
return all resources with a tag name prefixed by the phrase depart
(i.e.department
, departureDate
,
departureTime
, etc.)<br><br><br>Note that some properties can be combined when filtering
resources, which include the following: substringof() and/or resourceType
, plan and plan/publisher and plan/name
, and identity and identity/principalId
.
createdTime
, changedTime
and provisioningState
. For example, $expand=createdTime,changedTime
.
Returns:
listByResourceGroup
public abstract PagedIterable
Get all the resources for a resource group.
Parameters:
Returns:
listByResourceGroup
public abstract PagedIterable
Get all the resources for a resource group.
Parameters:
createdTime
, changedTime
and provisioningState
. For example, $expand=createdTime,changedTime
.
Returns:
listByResourceGroupAsync
public abstract PagedFlux
Get all the resources for a resource group.
Parameters:
Returns:
listByResourceGroupAsync
public abstract PagedFlux
Get all the resources for a resource group.
Parameters:
createdTime
, changedTime
and provisioningState
. For example, $expand=createdTime,changedTime
.
Returns:
moveResources
public abstract void moveResources(String sourceResourceGroupName, ResourcesMoveInfo parameters)
Moves resources from one resource group to another resource group. The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes.
Parameters:
moveResources
public abstract void moveResources(String sourceResourceGroupName, ResourcesMoveInfo parameters, Context context)
Moves resources from one resource group to another resource group. The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes.
Parameters:
moveResourcesAsync
public abstract Mono
Moves resources from one resource group to another resource group. The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes.
Parameters:
Returns:
moveResourcesWithResponseAsync
public abstract Mono
Moves resources from one resource group to another resource group. The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes.
Parameters:
Returns:
update
public abstract GenericResourceInner update(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion, GenericResourceInner parameters)
Updates a resource.
Parameters:
Returns:
update
public abstract GenericResourceInner update(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion, GenericResourceInner parameters, Context context)
Updates a resource.
Parameters:
Returns:
updateAsync
public abstract Mono
Updates a resource.
Parameters:
Returns:
updateById
public abstract GenericResourceInner updateById(String resourceId, String apiVersion, GenericResourceInner parameters)
Updates a resource by ID.
Parameters:
Returns:
updateById
public abstract GenericResourceInner updateById(String resourceId, String apiVersion, GenericResourceInner parameters, Context context)
Updates a resource by ID.
Parameters:
Returns:
updateByIdAsync
public abstract Mono
Updates a resource by ID.
Parameters:
Returns:
updateByIdWithResponseAsync
public abstract Mono
Updates a resource by ID.
Parameters:
Returns:
updateWithResponseAsync
public abstract Mono
Updates a resource.
Parameters:
Returns:
validateMoveResources
public abstract void validateMoveResources(String sourceResourceGroupName, ResourcesMoveInfo parameters)
Validates whether resources can be moved from one resource group to another resource group. This operation checks whether the specified resources can be moved to the target. The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation.
Parameters:
validateMoveResources
public abstract void validateMoveResources(String sourceResourceGroupName, ResourcesMoveInfo parameters, Context context)
Validates whether resources can be moved from one resource group to another resource group. This operation checks whether the specified resources can be moved to the target. The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation.
Parameters:
validateMoveResourcesAsync
public abstract Mono
Validates whether resources can be moved from one resource group to another resource group. This operation checks whether the specified resources can be moved to the target. The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation.
Parameters:
Returns:
validateMoveResourcesWithResponseAsync
public abstract Mono
Validates whether resources can be moved from one resource group to another resource group. This operation checks whether the specified resources can be moved to the target. The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation.
Parameters:
Returns:
Applies to
Azure SDK for Java