Skip to main content

resources

Overview

Nameresources
TypeResource
Idazure.resources.resources

Fields

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
namestringThe name of the resource
identityobjectIdentity for the resource.
kindstringThe kind of the resource.
managedBystringID of the resource that manages this resource.
planobjectPlan for the resource.
propertiesobjectThe resource properties.
skuobjectThe resource model definition representing SKU
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

NameAccessible byRequired ParamsDescription
getSELECTapi-version, parentResourcePath, resourceGroupName, resourceName, resourceProviderNamespace, resourceType, subscriptionIdGets a resource.
listSELECTsubscriptionIdGet all the resources in a subscription.
list_by_resource_groupSELECTresourceGroupName, subscriptionIdGet all the resources for a resource group.
create_or_updateINSERTapi-version, parentResourcePath, resourceGroupName, resourceName, resourceProviderNamespace, resourceType, subscriptionIdCreates a resource.
deleteDELETEapi-version, parentResourcePath, resourceGroupName, resourceName, resourceProviderNamespace, resourceType, subscriptionIdDeletes a resource.
delete_by_idDELETEapi-version, resourceIdDeletes a resource by ID.
_listEXECsubscriptionIdGet all the resources in a subscription.
_list_by_resource_groupEXECresourceGroupName, subscriptionIdGet all the resources for a resource group.
check_existenceEXECapi-version, parentResourcePath, resourceGroupName, resourceName, resourceProviderNamespace, resourceType, subscriptionIdChecks whether a resource exists.
check_existence_by_idEXECapi-version, resourceIdChecks 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.
create_or_update_by_idEXECapi-version, resourceIdCreate a resource by ID.
get_by_idEXECapi-version, resourceIdGets a resource by ID.
move_resourcesEXECsourceResourceGroupName, subscriptionIdThe 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.
updateEXECapi-version, parentResourcePath, resourceGroupName, resourceName, resourceProviderNamespace, resourceType, subscriptionIdUpdates a resource.
update_by_idEXECapi-version, resourceIdUpdates a resource by ID.
validate_move_resourcesEXECsourceResourceGroupName, subscriptionIdThis 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.