ResourcesOperations interface

Package:

@azure/arm-resources

Interface representing a Resources operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginCreateOrUpdateById
beginCreateOrUpdateByIdAndWait
beginDelete
beginDeleteAndWait
beginDeleteById
beginDeleteByIdAndWait
beginMoveResources
beginMoveResourcesAndWait
beginUpdate
beginUpdateAndWait
beginUpdateById
beginUpdateByIdAndWait
beginValidateMoveResources
beginValidateMoveResourcesAndWait
checkExistence	Checks whether a resource exists.
checkExistenceById	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.
createOrUpdate	Creates a resource.
createOrUpdateById	Create a resource by ID.
delete	Deletes a resource.
deleteById	Deletes a resource by ID.
get	Gets a resource.
getById	Gets a resource by ID.
list	Get all the resources in a subscription.
listByResourceGroup	Get all the resources for a resource group.
moveResources	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.
update	Updates a resource.
updateById	Update a resource by ID.
validateMoveResources	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.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<GenericResource>, GenericResource>>

Property Value

(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<GenericResource>, GenericResource>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateOptionalParams) => Promise<GenericResource>

Property Value

(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateOptionalParams) => Promise<GenericResource>

beginCreateOrUpdateById

Warning

This API is now deprecated.

use createOrUpdateById instead

beginCreateOrUpdateById: (resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateByIdOptionalParams) => Promise<SimplePollerLike<OperationState<GenericResource>, GenericResource>>

Property Value

(resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateByIdOptionalParams) => Promise<SimplePollerLike<OperationState<GenericResource>, GenericResource>>

beginCreateOrUpdateByIdAndWait

Warning

This API is now deprecated.

use createOrUpdateById instead

beginCreateOrUpdateByIdAndWait: (resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateByIdOptionalParams) => Promise<GenericResource>

Property Value

(resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateByIdOptionalParams) => Promise<GenericResource>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, options?: ResourcesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, options?: ResourcesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, options?: ResourcesDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, options?: ResourcesDeleteOptionalParams) => Promise<void>

beginDeleteById

Warning

This API is now deprecated.

use deleteById instead

beginDeleteById: (resourceId: string, apiVersion: string, options?: ResourcesDeleteByIdOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceId: string, apiVersion: string, options?: ResourcesDeleteByIdOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteByIdAndWait

Warning

This API is now deprecated.

use deleteById instead

beginDeleteByIdAndWait: (resourceId: string, apiVersion: string, options?: ResourcesDeleteByIdOptionalParams) => Promise<void>

Property Value

(resourceId: string, apiVersion: string, options?: ResourcesDeleteByIdOptionalParams) => Promise<void>

beginMoveResources

Warning

This API is now deprecated.

use moveResources instead

beginMoveResources: (sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesMoveResourcesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesMoveResourcesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginMoveResourcesAndWait

Warning

This API is now deprecated.

use moveResources instead

beginMoveResourcesAndWait: (sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesMoveResourcesOptionalParams) => Promise<void>

Property Value

(sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesMoveResourcesOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<GenericResource>, GenericResource>>

Property Value

(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<GenericResource>, GenericResource>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateOptionalParams) => Promise<GenericResource>

Property Value

(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateOptionalParams) => Promise<GenericResource>

beginUpdateById

Warning

This API is now deprecated.

use updateById instead

beginUpdateById: (resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateByIdOptionalParams) => Promise<SimplePollerLike<OperationState<GenericResource>, GenericResource>>

Property Value

(resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateByIdOptionalParams) => Promise<SimplePollerLike<OperationState<GenericResource>, GenericResource>>

beginUpdateByIdAndWait

Warning

This API is now deprecated.

use updateById instead

beginUpdateByIdAndWait: (resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateByIdOptionalParams) => Promise<GenericResource>

Property Value

(resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateByIdOptionalParams) => Promise<GenericResource>

beginValidateMoveResources

Warning

This API is now deprecated.

use validateMoveResources instead

beginValidateMoveResources: (sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesValidateMoveResourcesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesValidateMoveResourcesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginValidateMoveResourcesAndWait

Warning

This API is now deprecated.

use validateMoveResources instead

beginValidateMoveResourcesAndWait: (sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesValidateMoveResourcesOptionalParams) => Promise<void>

Property Value

(sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesValidateMoveResourcesOptionalParams) => Promise<void>

checkExistence

Checks whether a resource exists.

checkExistence: (resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, options?: ResourcesCheckExistenceOptionalParams) => Promise<ResourcesCheckExistenceResponse>

Property Value

(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, options?: ResourcesCheckExistenceOptionalParams) => Promise<ResourcesCheckExistenceResponse>

checkExistenceById

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.

checkExistenceById: (resourceId: string, apiVersion: string, options?: ResourcesCheckExistenceByIdOptionalParams) => Promise<ResourcesCheckExistenceByIdResponse>

Property Value

(resourceId: string, apiVersion: string, options?: ResourcesCheckExistenceByIdOptionalParams) => Promise<ResourcesCheckExistenceByIdResponse>

createOrUpdate

Creates a resource.

createOrUpdate: (resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateOptionalParams) => PollerLike<OperationState<GenericResource>, GenericResource>

Property Value

(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateOptionalParams) => PollerLike<OperationState<GenericResource>, GenericResource>

createOrUpdateById

Create a resource by ID.

createOrUpdateById: (resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateByIdOptionalParams) => PollerLike<OperationState<GenericResource>, GenericResource>

Property Value

(resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateByIdOptionalParams) => PollerLike<OperationState<GenericResource>, GenericResource>

delete

Deletes a resource.

delete: (resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, options?: ResourcesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, options?: ResourcesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

deleteById

Deletes a resource by ID.

deleteById: (resourceId: string, apiVersion: string, options?: ResourcesDeleteByIdOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceId: string, apiVersion: string, options?: ResourcesDeleteByIdOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets a resource.

get: (resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, options?: ResourcesGetOptionalParams) => Promise<GenericResource>

Property Value

(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, options?: ResourcesGetOptionalParams) => Promise<GenericResource>

getById

Gets a resource by ID.

getById: (resourceId: string, apiVersion: string, options?: ResourcesGetByIdOptionalParams) => Promise<GenericResource>

Property Value

(resourceId: string, apiVersion: string, options?: ResourcesGetByIdOptionalParams) => Promise<GenericResource>

list

Get all the resources in a subscription.

list: (options?: ResourcesListOptionalParams) => PagedAsyncIterableIterator<GenericResourceExpanded, GenericResourceExpanded[], PageSettings>

Property Value

(options?: ResourcesListOptionalParams) => PagedAsyncIterableIterator<GenericResourceExpanded, GenericResourceExpanded[], PageSettings>

listByResourceGroup

Get all the resources for a resource group.

listByResourceGroup: (resourceGroupName: string, options?: ResourcesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<GenericResourceExpanded, GenericResourceExpanded[], PageSettings>

Property Value

(resourceGroupName: string, options?: ResourcesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<GenericResourceExpanded, GenericResourceExpanded[], PageSettings>

moveResources

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.

moveResources: (sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesMoveResourcesOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesMoveResourcesOptionalParams) => PollerLike<OperationState<void>, void>

update

Updates a resource.

update: (resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateOptionalParams) => PollerLike<OperationState<GenericResource>, GenericResource>

Property Value

(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateOptionalParams) => PollerLike<OperationState<GenericResource>, GenericResource>

updateById

Update a resource by ID.

updateById: (resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateByIdOptionalParams) => PollerLike<OperationState<GenericResource>, GenericResource>

Property Value

(resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateByIdOptionalParams) => PollerLike<OperationState<GenericResource>, GenericResource>

validateMoveResources

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.

validateMoveResources: (sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesValidateMoveResourcesOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesValidateMoveResourcesOptionalParams) => PollerLike<OperationState<void>, void>