You can provide the template and parameters directly in the request or link to JSON files.
For more information, see the official documentation for Deployments: Create or update.
| Field | Type | Description | Required |
|---|---|---|---|
| subscriptionId | string | The ID of the target subscription. | Required |
| resourceGroupName | string | The name of the resource group to deploy the resources to. | Required |
| deploymentName | string | The name of the deployment. | Required |
| parameters | Deployment | See parameters fields. | Required |
| Field | Type | Description | Required |
|---|---|---|---|
| properties | DeploymentProperties | See properties fields. | Required |
| Field | Type | Description | Required |
|---|---|---|---|
| mode | DeploymentMode | The mode that is used to deploy resources. | Required |
| parameters | Record<string, DeploymentParameter> | Name and value pairs that define the deployment parameters for the template. | Optional |
| template | Record<string, unknown> | The template content. | Optional |
| templateLink | TemplateLink | The URI of the template. | Optional |
| validationLevel | string | The validation level of the deployment. | Optional |
The action may return partial results if the timeout limit for workflow actions has been reached. Returns fields as described in DeploymentExtended.
When you delete a resource group, all of its resources are also deleted.
For more information, see the official documentation for Resource Groups: Delete.
| Field | Type | Description | Required |
|---|---|---|---|
| subscriptionId | string | The ID of the target subscription. | Required |
| resourceGroupName | string | The name of the resource group to delete. | Required |
The action does not have an output.
Creates or updates a resource group.
For more information, see the official documentation for Resource Groups: Create or update.
| Field | Type | Description | Required |
|---|---|---|---|
| subscriptionId | string | The ID of the target subscription. | Required |
| resourceGroupName | string | The name of the resource group to create or update. | Required |
| parameters | ResourceGroup | See parameters fields. | Required |
| Field | Type | Description | Required |
|---|---|---|---|
| location | string | The location of the resource group. | Required |
| managedBy | string | The ID of the resource that manages this resource group. | Optional |
| tags | Record<string, string> | The tags attached to the resource group. | Optional |
Returns fields as described in ResourceGroup.
Gets a resource group.
For more information, see the official documentation for Resource Groups: Get.
| Field | Type | Description | Required |
|---|---|---|---|
| subscriptionId | string | The ID of the target subscription. | Required |
| resourceGroupName | string | The name of the resource group to get. | Required |
Returns fields as described in ResourceGroup.
Gets all the resource groups for a subscription.
For more information, see the official documentation for Resource Groups: List.
| Field | Type | Description | Required |
|---|---|---|---|
| subscriptionId | string | The ID of the target subscription. | Required |
| options | ResourceGroupsListOptionalParams | See options fields. | Optional |
| Field | Type | Description | Required |
|---|---|---|---|
| filter | string | The filter to apply to the operation. | Optional |
Returns an array of ResourceGroup objects.
This operation allows adding or replacing the entire set of tags on the specified resource or subscription.
For more information, see the official documentation for Tags Operations: Create or update at scope.
| Field | Type | Description | Required |
|---|---|---|---|
| subscriptionId | string | The ID of the target subscription. | Required |
| scope | string | The resource scope. | Required |
| parameters | TagsResource | See parameters fields. | Required |
| Field | Type | Description | Required |
|---|---|---|---|
| properties | Tags | See properties fields. | Required |
| Field | Type | Description | Required |
|---|---|---|---|
| tags | Record<string, string> | A set of key-value pairs to assign as tags to the resource. | Optional |
The action may return partial results if the timeout limit for workflow actions has been reached. Returns fields as described in TagsResource.
This operation allows replacing, merging or selectively deleting tags on the specified resource or subscription.
For more information, see the official documentation for Tags Operations: Update at scope.
| Field | Type | Description | Required |
|---|---|---|---|
| subscriptionId | string | The ID of the target subscription. | Required |
| scope | string | The resource scope. | Required |
| parameters | TagsPatchResource | See parameters fields. | Required |
| Field | Type | Description | Required |
|---|---|---|---|
| operation | string | The operation type for the patch API. | Optional |
| properties | Tags | See properties fields. | Optional |
| Field | Type | Description | Required |
|---|---|---|---|
| tags | Record<string, string> | A set of key-value pairs to assign as tags to the resource. | Optional |
The action may return partial results if the timeout limit for workflow actions has been reached. Returns fields as described in TagsResource.
Gets the entire set of tags on a resource or subscription.
For more information, see the official documentation for Tags Operations: Get at scope.
| Field | Type | Description | Required |
|---|---|---|---|
| subscriptionId | string | The ID of the target subscription. | Required |
| scope | string | The resource scope. | Required |
Returns fields as described in TagsResource.