Deployment Scripts - Get Logs

Service:

Resource Management

API Version:

2020-10-01

Gets deployment script logs for a given deployment script name.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}/logs?api-version=2020-10-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
scriptName	path	True	string minLength: 1 maxLength: 90	Name of the deployment script.
subscriptionId	path	True	string	Subscription Id which forms part of the URI for every service call.
api-version	query	True	string	Client Api version.

Responses

Name	Type	Description
200 OK	ScriptLogsList	OK -- Returns deployment script logs if available.
Other Status Codes	DeploymentScriptsError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

DeploymentScriptsGetLogs

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/script-rg/providers/Microsoft.Resources/deploymentScripts/MyDeploymentScript/logs?api-version=2020-10-01

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.deploymentscripts import DeploymentScriptsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-deploymentscripts
# USAGE
    python deployment_scripts_get_logs.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DeploymentScriptsClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.deployment_scripts.get_logs(
        resource_group_name="script-rg",
        script_name="MyDeploymentScript",
    )
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deploymentScripts/stable/2020-10-01/examples/DeploymentScripts_GetLogs.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "properties": {
        "log": "script execution stdout/stderr logs"
      }
    }
  ]
}

Definitions

Name	Description
DeploymentScriptsError	Deployment scripts error response.
ErrorAdditionalInfo	The resource management error additional info.
ErrorResponse	Error Response
ScriptLog	Script execution log object.
ScriptLogsList	Deployment script execution logs.

DeploymentScriptsError

Object

Deployment scripts error response.

Name	Type	Description
error	ErrorResponse	Error Response Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorResponse

Object

Error Response

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorResponse[]	The error details.
message	string	The error message.
target	string	The error target.

ScriptLog

Object

Script execution log object.

Name	Type	Description
id	string	String Id used to locate any resource on Azure.
name	string	Name of this resource.
properties.log	string	Script execution logs in text format.
type	string	Type of this resource.

ScriptLogsList

Object

Deployment script execution logs.

Name	Type	Description
value	ScriptLog[]	Deployment scripts logs.