Resources interface

Interface representing a Resources.

Methods

beginCreateOrUpdate(string, string, string, string, string, string, GenericResource, ResourcesCreateOrUpdateOptionalParams)

Creates a resource.

beginCreateOrUpdateAndWait(string, string, string, string, string, string, GenericResource, ResourcesCreateOrUpdateOptionalParams)

Creates a resource.

beginCreateOrUpdateById(string, string, GenericResource, ResourcesCreateOrUpdateByIdOptionalParams)

Create a resource by ID.

beginCreateOrUpdateByIdAndWait(string, string, GenericResource, ResourcesCreateOrUpdateByIdOptionalParams)

Create a resource by ID.

beginDelete(string, string, string, string, string, string, ResourcesDeleteOptionalParams)

Deletes a resource.

beginDeleteAndWait(string, string, string, string, string, string, ResourcesDeleteOptionalParams)

Deletes a resource.

beginDeleteById(string, string, ResourcesDeleteByIdOptionalParams)

Deletes a resource by ID.

beginDeleteByIdAndWait(string, string, ResourcesDeleteByIdOptionalParams)

Deletes a resource by ID.

beginMoveResources(string, ResourcesMoveInfo, ResourcesMoveResourcesOptionalParams)

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.

beginMoveResourcesAndWait(string, ResourcesMoveInfo, ResourcesMoveResourcesOptionalParams)

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.

beginUpdate(string, string, string, string, string, string, GenericResource, ResourcesUpdateOptionalParams)

Updates a resource.

beginUpdateAndWait(string, string, string, string, string, string, GenericResource, ResourcesUpdateOptionalParams)

Updates a resource.

beginUpdateById(string, string, GenericResource, ResourcesUpdateByIdOptionalParams)

Updates a resource by ID.

beginUpdateByIdAndWait(string, string, GenericResource, ResourcesUpdateByIdOptionalParams)

Updates a resource by ID.

beginValidateMoveResources(string, ResourcesMoveInfo, ResourcesValidateMoveResourcesOptionalParams)

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.

beginValidateMoveResourcesAndWait(string, ResourcesMoveInfo, ResourcesValidateMoveResourcesOptionalParams)

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.

checkExistence(string, string, string, string, string, string, ResourcesCheckExistenceOptionalParams)

Checks whether a resource exists.

checkExistenceById(string, string, ResourcesCheckExistenceByIdOptionalParams)

Checks by ID whether a resource exists.

get(string, string, string, string, string, string, ResourcesGetOptionalParams)

Gets a resource.

getById(string, string, ResourcesGetByIdOptionalParams)

Gets a resource by ID.

list(ResourcesListOptionalParams)

Get all the resources in a subscription.

listByResourceGroup(string, ResourcesListByResourceGroupOptionalParams)

Get all the resources for a resource group.

Method Details

beginCreateOrUpdate(string, string, string, string, string, string, GenericResource, ResourcesCreateOrUpdateOptionalParams)

Creates a resource.

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

Parameters

resourceGroupName

string

The name of the resource group for the resource. The name is case insensitive.

resourceProviderNamespace

string

The namespace of the resource provider.

parentResourcePath

string

The parent resource identity.

resourceType

string

The resource type of the resource to create.

resourceName

string

The name of the resource to create.

apiVersion

string

The API version to use for the operation.

parameters
GenericResource

Parameters for creating or updating the resource.

options
ResourcesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<GenericResource>, GenericResource>>

beginCreateOrUpdateAndWait(string, string, string, string, string, string, GenericResource, ResourcesCreateOrUpdateOptionalParams)

Creates a resource.

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

Parameters

resourceGroupName

string

The name of the resource group for the resource. The name is case insensitive.

resourceProviderNamespace

string

The namespace of the resource provider.

parentResourcePath

string

The parent resource identity.

resourceType

string

The resource type of the resource to create.

resourceName

string

The name of the resource to create.

apiVersion

string

The API version to use for the operation.

parameters
GenericResource

Parameters for creating or updating the resource.

options
ResourcesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<GenericResource>

beginCreateOrUpdateById(string, string, GenericResource, ResourcesCreateOrUpdateByIdOptionalParams)

Create a resource by ID.

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

Parameters

resourceId

string

The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}

apiVersion

string

The API version to use for the operation.

parameters
GenericResource

Create or update resource parameters.

options
ResourcesCreateOrUpdateByIdOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<GenericResource>, GenericResource>>

beginCreateOrUpdateByIdAndWait(string, string, GenericResource, ResourcesCreateOrUpdateByIdOptionalParams)

Create a resource by ID.

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

Parameters

resourceId

string

The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}

apiVersion

string

The API version to use for the operation.

parameters
GenericResource

Create or update resource parameters.

options
ResourcesCreateOrUpdateByIdOptionalParams

The options parameters.

Returns

Promise<GenericResource>

beginDelete(string, string, string, string, string, string, ResourcesDeleteOptionalParams)

Deletes a resource.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource to delete. The name is case insensitive.

resourceProviderNamespace

string

The namespace of the resource provider.

parentResourcePath

string

The parent resource identity.

resourceType

string

The resource type.

resourceName

string

The name of the resource to delete.

apiVersion

string

The API version to use for the operation.

options
ResourcesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, string, string, ResourcesDeleteOptionalParams)

Deletes a resource.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource to delete. The name is case insensitive.

resourceProviderNamespace

string

The namespace of the resource provider.

parentResourcePath

string

The parent resource identity.

resourceType

string

The resource type.

resourceName

string

The name of the resource to delete.

apiVersion

string

The API version to use for the operation.

options
ResourcesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDeleteById(string, string, ResourcesDeleteByIdOptionalParams)

Deletes a resource by ID.

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

Parameters

resourceId

string

The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}

apiVersion

string

The API version to use for the operation.

options
ResourcesDeleteByIdOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteByIdAndWait(string, string, ResourcesDeleteByIdOptionalParams)

Deletes a resource by ID.

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

Parameters

resourceId

string

The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}

apiVersion

string

The API version to use for the operation.

options
ResourcesDeleteByIdOptionalParams

The options parameters.

Returns

Promise<void>

beginMoveResources(string, ResourcesMoveInfo, ResourcesMoveResourcesOptionalParams)

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.

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

Parameters

sourceResourceGroupName

string

The name of the resource group from the source subscription containing the resources to be moved.

parameters
ResourcesMoveInfo

Parameters for moving resources.

options
ResourcesMoveResourcesOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginMoveResourcesAndWait(string, ResourcesMoveInfo, ResourcesMoveResourcesOptionalParams)

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.

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

Parameters

sourceResourceGroupName

string

The name of the resource group from the source subscription containing the resources to be moved.

parameters
ResourcesMoveInfo

Parameters for moving resources.

options
ResourcesMoveResourcesOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, string, string, string, GenericResource, ResourcesUpdateOptionalParams)

Updates a resource.

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

Parameters

resourceGroupName

string

The name of the resource group for the resource. The name is case insensitive.

resourceProviderNamespace

string

The namespace of the resource provider.

parentResourcePath

string

The parent resource identity.

resourceType

string

The resource type of the resource to update.

resourceName

string

The name of the resource to update.

apiVersion

string

The API version to use for the operation.

parameters
GenericResource

Parameters for updating the resource.

options
ResourcesUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<GenericResource>, GenericResource>>

beginUpdateAndWait(string, string, string, string, string, string, GenericResource, ResourcesUpdateOptionalParams)

Updates a resource.

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

Parameters

resourceGroupName

string

The name of the resource group for the resource. The name is case insensitive.

resourceProviderNamespace

string

The namespace of the resource provider.

parentResourcePath

string

The parent resource identity.

resourceType

string

The resource type of the resource to update.

resourceName

string

The name of the resource to update.

apiVersion

string

The API version to use for the operation.

parameters
GenericResource

Parameters for updating the resource.

options
ResourcesUpdateOptionalParams

The options parameters.

Returns

Promise<GenericResource>

beginUpdateById(string, string, GenericResource, ResourcesUpdateByIdOptionalParams)

Updates a resource by ID.

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

Parameters

resourceId

string

The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}

apiVersion

string

The API version to use for the operation.

parameters
GenericResource

Update resource parameters.

options
ResourcesUpdateByIdOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<GenericResource>, GenericResource>>

beginUpdateByIdAndWait(string, string, GenericResource, ResourcesUpdateByIdOptionalParams)

Updates a resource by ID.

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

Parameters

resourceId

string

The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}

apiVersion

string

The API version to use for the operation.

parameters
GenericResource

Update resource parameters.

options
ResourcesUpdateByIdOptionalParams

The options parameters.

Returns

Promise<GenericResource>

beginValidateMoveResources(string, ResourcesMoveInfo, ResourcesValidateMoveResourcesOptionalParams)

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.

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

Parameters

sourceResourceGroupName

string

The name of the resource group from the source subscription containing the resources to be validated for move.

parameters
ResourcesMoveInfo

Parameters for moving resources.

options
ResourcesValidateMoveResourcesOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginValidateMoveResourcesAndWait(string, ResourcesMoveInfo, ResourcesValidateMoveResourcesOptionalParams)

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.

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

Parameters

sourceResourceGroupName

string

The name of the resource group from the source subscription containing the resources to be validated for move.

parameters
ResourcesMoveInfo

Parameters for moving resources.

options
ResourcesValidateMoveResourcesOptionalParams

The options parameters.

Returns

Promise<void>

checkExistence(string, string, string, string, string, string, ResourcesCheckExistenceOptionalParams)

Checks whether a resource exists.

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

Parameters

resourceGroupName

string

The name of the resource group containing the resource to check. The name is case insensitive.

resourceProviderNamespace

string

The resource provider of the resource to check.

parentResourcePath

string

The parent resource identity.

resourceType

string

The resource type.

resourceName

string

The name of the resource to check whether it exists.

apiVersion

string

The API version to use for the operation.

options
ResourcesCheckExistenceOptionalParams

The options parameters.

Returns

checkExistenceById(string, string, ResourcesCheckExistenceByIdOptionalParams)

Checks by ID whether a resource exists.

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

Parameters

resourceId

string

The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}

apiVersion

string

The API version to use for the operation.

options
ResourcesCheckExistenceByIdOptionalParams

The options parameters.

Returns

get(string, string, string, string, string, string, ResourcesGetOptionalParams)

Gets a resource.

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

Parameters

resourceGroupName

string

The name of the resource group containing the resource to get. The name is case insensitive.

resourceProviderNamespace

string

The namespace of the resource provider.

parentResourcePath

string

The parent resource identity.

resourceType

string

The resource type of the resource.

resourceName

string

The name of the resource to get.

apiVersion

string

The API version to use for the operation.

options
ResourcesGetOptionalParams

The options parameters.

Returns

Promise<GenericResource>

getById(string, string, ResourcesGetByIdOptionalParams)

Gets a resource by ID.

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

Parameters

resourceId

string

The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}

apiVersion

string

The API version to use for the operation.

options
ResourcesGetByIdOptionalParams

The options parameters.

Returns

Promise<GenericResource>

list(ResourcesListOptionalParams)

Get all the resources in a subscription.

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

Parameters

options
ResourcesListOptionalParams

The options parameters.

Returns

listByResourceGroup(string, ResourcesListByResourceGroupOptionalParams)

Get all the resources for a resource group.

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

Parameters

resourceGroupName

string

The resource group with the resources to get.

options
ResourcesListByResourceGroupOptionalParams

The options parameters.

Returns