Addons - List

Tjänst:

AVS

API-versionen:

2025-09-01

Lista addon-resurser efter PrivateCloud

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

URI-parametrar

Namn	I	Krävs	Typ	Beskrivning
privateCloudName	path	True	string pattern: ^[-\w\._]+$	Namnet på det privata molnet
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svaren

Namn	Typ	Beskrivning
200 OK	AddonList	Azure-åtgärden har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Rinna: implicit
Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/authorize

Scope

Namn	Beskrivning
user_impersonation	personifiera ditt användarkonto

Exempel

Addons_List

Exempelförfrågan

HTTP

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

Java

/**
 * Samples for Addons List.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-09-01/Addons_List.json
     */
    /**
     * Sample code: Addons_List.
     * 
     * @param manager Entry point to AvsManager.
     */
    public static void addonsList(com.azure.resourcemanager.avs.AvsManager manager) {
        manager.addons().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 addons_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.addons.list(
        resource_group_name="group1",
        private_cloud_name="cloud1",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-09-01/Addons_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/Addons_List.json
func ExampleAddonsClient_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.NewAddonsClient().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.AddonsClientListResponse{
		// 	AddonList: armavs.AddonList{
		// 		Value: []*armavs.Addon{
		// 			{
		// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/addons/srm"),
		// 				Name: to.Ptr("srm"),
		// 				Properties: &armavs.AddonSrmProperties{
		// 					AddonType: to.Ptr(armavs.AddonTypeSRM),
		// 					LicenseKey: to.Ptr("41915178-A8FF-4A4D-B683-6D735AF5E3F5"),
		// 					ProvisioningState: to.Ptr(armavs.AddonProvisioningStateSucceeded),
		// 				},
		// 				Type: to.Ptr("Microsoft.AVS/privateClouds/addons"),
		// 			},
		// 		},
		// 	},
		// }
	}
}

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 Addon resources by PrivateCloud
 *
 * @summary list Addon resources by PrivateCloud
 * x-ms-original-file: 2025-09-01/Addons_List.json
 */
async function addonsList() {
  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.addons.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

Exempelsvar

Statuskod:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/addons/srm",
      "name": "srm",
      "properties": {
        "addonType": "SRM",
        "licenseKey": "41915178-A8FF-4A4D-B683-6D735AF5E3F5",
        "provisioningState": "Succeeded"
      },
      "type": "Microsoft.AVS/privateClouds/addons"
    }
  ]
}

Definitioner

Namn	Beskrivning
Addon	En tilläggsresurs
AddonArcProperties	Egenskaperna hos ett Arc-tillägg
AddonHcxProperties	Egenskaperna hos ett HCX-tillägg
AddonList	Svaret från en addon-liståtgärd.
AddonProvisioningState	Etableringstillstånd för tillägg
AddonSrmProperties	Egenskaperna för ett SRM-tillägg (Site Recovery Manager)
AddonType	Tilläggstyp
AddonVrProperties	Egenskaperna för ett vSphere Replication-tillägg (VR)
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
systemData	Metadata som rör skapande och senaste ändring av resursen.

Addon

Objekt

En tilläggsresurs

Namn	Typ	Beskrivning
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties	AddonProperties: AddonArcProperties AddonHcxProperties AddonSrmProperties AddonVrProperties	Resursspecifika egenskaper för den här resursen.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

AddonArcProperties

Objekt

Egenskaperna hos ett Arc-tillägg

Namn	Typ	Beskrivning
addonType	string: Arc	Tilläggstyp
provisioningState	AddonProvisioningState	Status för tilläggsetablering
vCenter	string	Resurs-ID:t för VMware vCenter

AddonHcxProperties

Objekt

Egenskaperna hos ett HCX-tillägg

Namn	Typ	Beskrivning
addonType	string: HCX	Tilläggstyp
managementNetwork	string	HCX-hanteringsnätverk.
offer	string	HCX-erbjudandet, till exempel VMware MaaS Cloud Provider (Enterprise)
provisioningState	AddonProvisioningState	Status för tilläggsetablering
uplinkNetwork	string	HCX-nätverk för upplänk

AddonList

Objekt

Svaret från en addon-liståtgärd.

Namn	Typ	Beskrivning
nextLink	string (uri)	Länken till nästa sida med objekt
value	Addon[]	Addon-objekten på den här sidan

AddonProvisioningState

Uppräkning

Etableringstillstånd för tillägg

Värde	Beskrivning
Succeeded	Resursen har skapats.
Failed	Det gick inte att skapa resurser.
Canceled	Resursskapandet avbröts.
Cancelled	avbryts
Building	håller på att byggas
Deleting	tar bort
Updating	uppdateras

AddonSrmProperties

Objekt

Egenskaperna för ett SRM-tillägg (Site Recovery Manager)

Namn	Typ	Beskrivning
addonType	string: SRM	Tilläggstyp
licenseKey	string	Site Recovery Manager-licensen (SRM)
provisioningState	AddonProvisioningState	Status för tilläggsetablering

AddonType

Uppräkning

Tilläggstyp

Värde	Beskrivning
SRM
VR
HCX
Arc

AddonVrProperties

Objekt

Egenskaperna för ett vSphere Replication-tillägg (VR)

Namn	Typ	Beskrivning
addonType	string: VR	Tilläggstyp
provisioningState	AddonProvisioningState	Status för tilläggsetablering
vrsCount	integer (int32)	Antalet vSphere Replication Server (VRS)

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Beskrivning
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Namn	Typ	Beskrivning
info	object	Den ytterligare informationen.
type	string	Typen av ytterligare information.

ErrorDetail

Objekt

Felinformationen.

Namn	Typ	Beskrivning
additionalInfo	ErrorAdditionalInfo[]	Felet ytterligare information.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felet riktas.

ErrorResponse

Objekt

Felsvar

Namn	Typ	Beskrivning
error	ErrorDetail	Felet objektet.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Namn	Typ	Beskrivning
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för senaste ändring av resurs (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.