Verifier Workspaces - List

Serviço:

Virtual Networks

Versão da API:

2024-05-01

Obtém a lista de Workspaces do Verificador.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/verifierWorkspaces?api-version=2024-05-01

Com parâmetros opcionais:

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/verifierWorkspaces?api-version=2024-05-01&skipToken={skipToken}&skip={skip}&top={top}&sortKey={sortKey}&sortValue={sortValue}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
networkManagerName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	O nome do gerenciador de rede.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	As credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.
skip	query		integer (int32)	Entradas num opcionais a serem ignoradas.
skipToken	query		string	Token de ignorar opcional.
sortKey	query		string	Chave opcional pela qual classificar.
sortValue	query		string	Valor de classificação opcional para paginação.
top	query		integer (int32)	Entradas num opcionais a serem exibidas.

Respostas

Nome	Tipo	Description
200 OK	VerifierWorkspaceListResult	Lista de VerifierWorkspaces.
Other Status Codes	CommonErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

VerifierWorkspaceList

Solicitação de exemplo

HTTP

GET /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces?api-version=2024-05-01

Java

/**
 * Samples for VerifierWorkspaces List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VerifierWorkspaceList.json
     */
    /**
     * Sample code: VerifierWorkspaceList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void verifierWorkspaceList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVerifierWorkspaces().list("rg1", "testNetworkManager", null, null,
            null, null, null, 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.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python verifier_workspace_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 = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.verifier_workspaces.list(
        resource_group_name="rg1",
        network_manager_name="testNetworkManager",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VerifierWorkspaceList.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 armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VerifierWorkspaceList.json
func ExampleVerifierWorkspacesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewVerifierWorkspacesClient().NewListPager("rg1", "testNetworkManager", &armnetwork.VerifierWorkspacesClientListOptions{SkipToken: nil,
		Skip:      nil,
		Top:       nil,
		SortKey:   nil,
		SortValue: 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.VerifierWorkspaceListResult = armnetwork.VerifierWorkspaceListResult{
		// 	Value: []*armnetwork.VerifierWorkspace{
		// 		{
		// 			Name: to.Ptr("testVerifierWorkspace1"),
		// 			Type: to.Ptr("Microsoft.Network/networkManagers/verifierWorkspaces"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1"),
		// 			SystemData: &armnetwork.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-11T18:52:27.000Z"); return t}()),
		// 				CreatedBy: to.Ptr("b69a9388-9488-4534-b470-7ec6d41beef5"),
		// 				CreatedByType: to.Ptr(armnetwork.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-11T18:52:27.000Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("b69a9388-9488-4534-b470-7ec6d41beef5"),
		// 				LastModifiedByType: to.Ptr(armnetwork.CreatedByTypeUser),
		// 			},
		// 			Location: to.Ptr("eastus"),
		// 			Properties: &armnetwork.VerifierWorkspaceProperties{
		// 				Description: to.Ptr("A sample verfier workspace"),
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 			},
		// 	}},
		// }
	}
}

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 { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets list of Verifier Workspaces.
 *
 * @summary Gets list of Verifier Workspaces.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VerifierWorkspaceList.json
 */
async function verifierWorkspaceList() {
  const subscriptionId =
    process.env["NETWORK_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkManagerName = "testNetworkManager";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.verifierWorkspaces.list(resourceGroupName, networkManagerName)) {
    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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VerifierWorkspaceList.json
// this example is just showing the usage of "VerifierWorkspaces_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this NetworkManagerResource created on azure
// for more information of creating NetworkManagerResource, please refer to the document of NetworkManagerResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string networkManagerName = "testNetworkManager";
ResourceIdentifier networkManagerResourceId = NetworkManagerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkManagerName);
NetworkManagerResource networkManager = client.GetNetworkManagerResource(networkManagerResourceId);

// get the collection of this NetworkVerifierWorkspaceResource
NetworkVerifierWorkspaceCollection collection = networkManager.GetNetworkVerifierWorkspaces();

// invoke the operation and iterate over the result
await foreach (NetworkVerifierWorkspaceResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    NetworkVerifierWorkspaceData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Resposta de exemplo

Código de status:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1",
      "name": "testVerifierWorkspace1",
      "type": "Microsoft.Network/networkManagers/verifierWorkspaces",
      "location": "eastus",
      "systemData": {
        "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
        "createdByType": "User",
        "createdAt": "2021-01-11T18:52:27Z",
        "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-01-11T18:52:27Z"
      },
      "properties": {
        "description": "A sample verfier workspace",
        "provisioningState": "Succeeded"
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces?api-version=2024-04-01-preview&$skipToken=10"
}

Definições

Nome	Description
CommonErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
CommonErrorDetail	O detalhe do erro.
CommonErrorResponse	Resposta de erro
createdByType	O tipo de identidade que criou o recurso.
ProvisioningState	Provisionando estados de um recurso.
SystemData	Metadados relativos à criação e última modificação do recurso.
VerifierWorkspace	Instância do Workspace do Verificador.
VerifierWorkspaceListResult	Uma lista do Workspace do Verificador
VerifierWorkspaceProperties	Propriedades do recurso workspace do Verificador.

CommonErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

CommonErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	CommonErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	CommonErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

CommonErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	CommonErrorDetail	O objeto de erro.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ProvisioningState

Enumeração

Provisionando estados de um recurso.

Valor	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

SystemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O tipo de identidade que modificou o recurso pela última vez.
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

VerifierWorkspace

Objeto

Instância do Workspace do Verificador.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	A localização geográfica onde o recurso reside
name	string	O nome do recurso
properties	VerifierWorkspaceProperties	Propriedades do recurso workspace do Verificador.
systemData	SystemData	Os metadados do sistema relacionados a esse recurso.
tags	object	Marcas de recurso.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

VerifierWorkspaceListResult

Objeto

Uma lista do Workspace do Verificador

Nome	Tipo	Description
nextLink	string	Obtém a URL para obter a próxima página de resultados.
value	VerifierWorkspace[]	Obtém uma página de Workspaces do Verificador.

VerifierWorkspaceProperties

Objeto

Propriedades do recurso workspace do Verificador.

Nome	Tipo	Description
description	string
provisioningState	ProvisioningState	Provisionando estados de um recurso.