Microsoft.Resources (stable:2023-08-01)

2025/06/04 • 8 new, 8 deleted methods

DeploymentScripts_Create (new)
Description :  Creates a deployment script.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scriptName:
{
Description: Name of the deployment script. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
deploymentScript:
{
Description: Deployment script supplied to the operation. ,
Required: True ,
}
{
identity:
{
Description: Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported. ,
Required: False ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The location of the ACI and the storage account for the deployment script. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
kind:
{
Description: Type of the script. ,
Enum:
{
AzurePowerShell: No description available. ,
AzureCLI: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: The system metadata related to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported. ,
Required: False ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The location of the ACI and the storage account for the deployment script. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
kind:
{
Description: Type of the script. ,
Enum:
{
AzurePowerShell: No description available. ,
AzureCLI: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: The system metadata related to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported. ,
Required: False ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The location of the ACI and the storage account for the deployment script. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
kind:
{
Description: Type of the script. ,
Enum:
{
AzurePowerShell: No description available. ,
AzureCLI: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: The system metadata related to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentScripts_Update (new)
Description :  Updates deployment script tags with specified values.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scriptName:
{
Description: Name of the deployment script. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
deploymentScript:
{
Description: Deployment script resource with the tags to be updated. ,
Required: False ,
}
{
tags:
{
Description: Resource tags to be updated. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported. ,
Required: False ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The location of the ACI and the storage account for the deployment script. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
kind:
{
Description: Type of the script. ,
Enum:
{
AzurePowerShell: No description available. ,
AzureCLI: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: The system metadata related to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentScripts_Get (new)
Description :  Gets a deployment script with a given name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scriptName:
{
Description: Name of the deployment script. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported. ,
Required: False ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The location of the ACI and the storage account for the deployment script. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
kind:
{
Description: Type of the script. ,
Enum:
{
AzurePowerShell: No description available. ,
AzureCLI: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: The system metadata related to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentScripts_Delete (new)
Description :  Deletes a deployment script. When operation completes, status code 200 returned without content.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scriptName:
{
Description: Name of the deployment script. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentScripts_ListBySubscription (new)
Description :  Lists all deployment scripts for a given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentScripts
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of deployment scripts. ,
Required: False ,
}
[
{
identity:
{
Description: Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported. ,
Required: False ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The location of the ACI and the storage account for the deployment script. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
kind:
{
Description: Type of the script. ,
Enum:
{
AzurePowerShell: No description available. ,
AzureCLI: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: The system metadata related to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentScripts_GetLogs (new)
Description :  Gets deployment script logs for a given deployment script name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}/logs
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scriptName:
{
Description: Name of the deployment script. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Deployment scripts logs. ,
Required: False ,
}
[
{
properties:
{
Description: Script log properties. ,
Required: False ,
}
{
log:
{
Description: Script execution logs in text format. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentScripts_GetLogsDefault (new)
Description :  Gets deployment script logs for a given deployment script name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}/logs/default
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scriptName:
{
Description: Name of the deployment script. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
tail:
{
Description: The number of lines to show from the tail of the deployment script log. Valid value is a positive number up to 1000. If 'tail' is not provided, all available logs are shown up to container instance log capacity of 4mb. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
properties:
{
Description: Script log properties. ,
Required: False ,
}
{
log:
{
Description: Script execution logs in text format. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentScripts_ListByResourceGroup (new)
Description :  Lists deployments scripts.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of deployment scripts. ,
Required: False ,
}
[
{
identity:
{
Description: Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported. ,
Required: False ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The location of the ACI and the storage account for the deployment script. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
kind:
{
Description: Type of the script. ,
Enum:
{
AzurePowerShell: No description available. ,
AzureCLI: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: The system metadata related to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentScripts_Create (removed)
Description :  Creates a deployment script.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scriptName:
{
Description: Name of the deployment script. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
deploymentScript:
{
Description: Deployment script supplied to the operation. ,
Required: True ,
}
{
identity:
{
Description: Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported. ,
Required: False ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The location of the ACI and the storage account for the deployment script. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
kind:
{
Description: Type of the script. ,
Enum:
{
AzurePowerShell: No description available. ,
AzureCLI: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: The system metadata related to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported. ,
Required: False ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The location of the ACI and the storage account for the deployment script. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
kind:
{
Description: Type of the script. ,
Enum:
{
AzurePowerShell: No description available. ,
AzureCLI: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: The system metadata related to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported. ,
Required: False ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The location of the ACI and the storage account for the deployment script. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
kind:
{
Description: Type of the script. ,
Enum:
{
AzurePowerShell: No description available. ,
AzureCLI: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: The system metadata related to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentScripts_Update (removed)
Description :  Updates deployment script tags with specified values.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scriptName:
{
Description: Name of the deployment script. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
deploymentScript:
{
Description: Deployment script resource with the tags to be updated. ,
Required: False ,
}
{
tags:
{
Description: Resource tags to be updated. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported. ,
Required: False ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The location of the ACI and the storage account for the deployment script. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
kind:
{
Description: Type of the script. ,
Enum:
{
AzurePowerShell: No description available. ,
AzureCLI: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: The system metadata related to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentScripts_Get (removed)
Description :  Gets a deployment script with a given name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scriptName:
{
Description: Name of the deployment script. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported. ,
Required: False ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The location of the ACI and the storage account for the deployment script. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
kind:
{
Description: Type of the script. ,
Enum:
{
AzurePowerShell: No description available. ,
AzureCLI: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: The system metadata related to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentScripts_Delete (removed)
Description :  Deletes a deployment script. When operation completes, status code 200 returned without content.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scriptName:
{
Description: Name of the deployment script. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentScripts_ListBySubscription (removed)
Description :  Lists all deployment scripts for a given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentScripts
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of deployment scripts. ,
Required: False ,
}
[
{
identity:
{
Description: Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported. ,
Required: False ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The location of the ACI and the storage account for the deployment script. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
kind:
{
Description: Type of the script. ,
Enum:
{
AzurePowerShell: No description available. ,
AzureCLI: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: The system metadata related to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentScripts_GetLogs (removed)
Description :  Gets deployment script logs for a given deployment script name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}/logs
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scriptName:
{
Description: Name of the deployment script. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Deployment scripts logs. ,
Required: False ,
}
[
{
properties:
{
Description: Script log properties. ,
Required: False ,
}
{
log:
{
Description: Script execution logs in text format. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentScripts_GetLogsDefault (removed)
Description :  Gets deployment script logs for a given deployment script name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}/logs/default
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scriptName:
{
Description: Name of the deployment script. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
tail:
{
Description: The number of lines to show from the tail of the deployment script log. Valid value is a positive number up to 1000. If 'tail' is not provided, all available logs are shown up to container instance log capacity of 4mb. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
properties:
{
Description: Script log properties. ,
Required: False ,
}
{
log:
{
Description: Script execution logs in text format. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentScripts_ListByResourceGroup (removed)
Description :  Lists deployments scripts.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of deployment scripts. ,
Required: False ,
}
[
{
identity:
{
Description: Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported. ,
Required: False ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The location of the ACI and the storage account for the deployment script. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
kind:
{
Description: Type of the script. ,
Enum:
{
AzurePowerShell: No description available. ,
AzureCLI: No description available. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: The system metadata related to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}