Script Packages - List

Service:

AVS

API Version:

2025-09-01

List ScriptPackage resources by PrivateCloud

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages?api-version=2025-09-01

URI Parameters

Name	In	Required	Type	Description
privateCloudName	path	True	string pattern: ^[-\w\._]+$	Name of the private cloud
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ScriptPackagesList	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

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

ScriptPackages_List

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptPackages?api-version=2025-09-01

Java

/**
 * Samples for ScriptPackages List.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-09-01/ScriptPackages_List.json
     */
    /**
     * Sample code: ScriptPackages_List.
     * 
     * @param manager Entry point to AvsManager.
     */
    public static void scriptPackagesList(com.azure.resourcemanager.avs.AvsManager manager) {
        manager.scriptPackages().list("group1", "cloud1", com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.avs import AVSClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-avs
# USAGE
    python script_packages_list.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 = AVSClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.script_packages.list(
        resource_group_name="group1",
        private_cloud_name="cloud1",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-09-01/ScriptPackages_List.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

Go

package armavs_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/avs/armavs/v2"
)

// Generated from example definition: 2025-09-01/ScriptPackages_List.json
func ExampleScriptPackagesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armavs.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewScriptPackagesClient().NewListPager("group1", "cloud1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armavs.ScriptPackagesClientListResponse{
		// 	ScriptPackagesList: armavs.ScriptPackagesList{
		// 		Value: []*armavs.ScriptPackage{
		// 			{
		// 				Name: to.Ptr("Microsoft.AVS.Management@3.0.48"),
		// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptPackages/Microsoft.AVS.Management@3.0.48"),
		// 				Properties: &armavs.ScriptPackageProperties{
		// 					Description: to.Ptr("Various cmdlets for elevated access to Private Cloud administrative functions"),
		// 					Version: to.Ptr("3.0.48"),
		// 					Company: to.Ptr("Microsoft"),
		// 					URI: to.Ptr("https://microsoft.com"),
		// 				},
		// 				Type: to.Ptr("Microsoft.AVS/privateClouds/scriptPackages"),
		// 			},
		// 			{
		// 				Name: to.Ptr("JSDR.Configuration@1.0.0"),
		// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptPackages/JSDR.Configuration@1.0.0"),
		// 				Properties: &armavs.ScriptPackageProperties{
		// 					Description: to.Ptr("Various cmdlets by Jetstream for Private Cloud administration"),
		// 					Version: to.Ptr("1.0.0"),
		// 					Company: to.Ptr("Jetstream Software"),
		// 					URI: to.Ptr("https://www.jetstreamsoft.com/about/support/"),
		// 				},
		// 				Type: to.Ptr("Microsoft.AVS/privateClouds/scriptPackages"),
		// 			},
		// 		},
		// 	},
		// }
	}
}

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

JavaScript

const { AzureVMwareSolutionAPI } = require("@azure/arm-avs");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to list ScriptPackage resources by PrivateCloud
 *
 * @summary list ScriptPackage resources by PrivateCloud
 * x-ms-original-file: 2025-09-01/ScriptPackages_List.json
 */
async function scriptPackagesList() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new AzureVMwareSolutionAPI(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.scriptPackages.list("group1", "cloud1")) {
    resArray.push(item);
  }

  console.log(resArray);
}

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": [
    {
      "name": "Microsoft.AVS.Management@3.0.48",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptPackages/Microsoft.AVS.Management@3.0.48",
      "properties": {
        "description": "Various cmdlets for elevated access to Private Cloud administrative functions",
        "version": "3.0.48",
        "company": "Microsoft",
        "uri": "https://microsoft.com"
      },
      "type": "Microsoft.AVS/privateClouds/scriptPackages"
    },
    {
      "name": "JSDR.Configuration@1.0.0",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptPackages/JSDR.Configuration@1.0.0",
      "properties": {
        "description": "Various cmdlets by Jetstream for Private Cloud administration",
        "version": "1.0.0",
        "company": "Jetstream Software",
        "uri": "https://www.jetstreamsoft.com/about/support/"
      },
      "type": "Microsoft.AVS/privateClouds/scriptPackages"
    }
  ]
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ScriptPackage	Script Package resources available for execution
ScriptPackageProvisioningState	Script Package provisioning state
ScriptPackagesList	The response of a ScriptPackage list operation.
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

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

ErrorDetail

Object

The error detail.

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

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ScriptPackage

Object

Script Package resources available for execution

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.company	string	Company that created and supports the package
properties.description	string	User friendly description of the package
properties.provisioningState	ScriptPackageProvisioningState	The provisioning state of the resource.
properties.uri	string	Link to support by the package vendor
properties.version	string	Module version
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ScriptPackageProvisioningState

Enumeration

Script Package provisioning state

Value	Description
Succeeded	Resource has been created.
Failed	Resource creation failed.
Canceled	Resource creation was canceled.

ScriptPackagesList

Object

The response of a ScriptPackage list operation.

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	ScriptPackage[]	The ScriptPackage items on this page

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.