Scoping Configuration - List

Serviço:

App Compliance Automation

Versão da API:

2024-06-27

Retorna um formato de lista do escopo singleton scopingConfiguration para um relatório especificado.

GET https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/{reportName}/scopingConfigurations?api-version=2024-06-27

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
reportName	path	True	string pattern: ^[-a-zA-Z0-9_]{1,50}$	Nome do relatório.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	ScopingConfigurationResourceListResult	Operação do Azure concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

ScopingConfiguration_List

Pedido de amostra

HTTP

GET https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/testReportName/scopingConfigurations?api-version=2024-06-27

Java

/**
 * Samples for ScopingConfiguration List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/
     * examples/ScopingConfiguration_List.json
     */
    /**
     * Sample code: ScopingConfiguration_List.
     * 
     * @param manager Entry point to AppComplianceAutomationManager.
     */
    public static void scopingConfigurationList(
        com.azure.resourcemanager.appcomplianceautomation.AppComplianceAutomationManager manager) {
        manager.scopingConfigurations().list("testReportName", 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.appcomplianceautomation import AppComplianceAutomationMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appcomplianceautomation
# USAGE
    python scoping_configuration_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 = AppComplianceAutomationMgmtClient(
        credential=DefaultAzureCredential(),
    )

    response = client.scoping_configuration.list(
        report_name="testReportName",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_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 armappcomplianceautomation_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcomplianceautomation/armappcomplianceautomation"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d88c94b22a8efdd47c0cadfe6d8d489107db2b23/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_List.json
func ExampleScopingConfigurationClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcomplianceautomation.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewScopingConfigurationClient().NewListPager("testReportName", 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.ScopingConfigurationResourceListResult = armappcomplianceautomation.ScopingConfigurationResourceListResult{
		// 	Value: []*armappcomplianceautomation.ScopingConfigurationResource{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.AppComplianceAutomation/reports/scopingConfigurations"),
		// 			ID: to.Ptr("/provider/Microsfot.AppComplianceAutomation/reports/testReportName/scopingConfigurations/default"),
		// 			SystemData: &armappcomplianceautomation.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()),
		// 				CreatedBy: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				CreatedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				LastModifiedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser),
		// 			},
		// 			Properties: &armappcomplianceautomation.ScopingConfigurationProperties{
		// 				Answers: []*armappcomplianceautomation.ScopingAnswer{
		// 					{
		// 						Answers: []*string{
		// 							to.Ptr("Azure")},
		// 							QuestionID: to.Ptr("GEN20_hostingEnvironment"),
		// 						},
		// 						{
		// 							Answers: []*string{
		// 							},
		// 							QuestionID: to.Ptr("DHP_G07_customerDataProcess"),
		// 						},
		// 						{
		// 							Answers: []*string{
		// 							},
		// 							QuestionID: to.Ptr("Tier2InitSub_serviceCommunicate"),
		// 					}},
		// 				},
		// 		}},
		// 	}
	}
}

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

/**
 * This sample demonstrates how to Returns a list format of the singleton scopingConfiguration for a specified report.
 *
 * @summary Returns a list format of the singleton scopingConfiguration for a specified report.
 * x-ms-original-file: specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_List.json
 */
async function scopingConfigurationList() {
  const reportName = "testReportName";
  const credential = new DefaultAzureCredential();
  const client = new AppComplianceAutomationToolForMicrosoft365(credential);
  const resArray = new Array();
  for await (let item of client.scopingConfiguration.list(reportName)) {
    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.AppComplianceAutomation;

// Generated from example definition: specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_List.json
// this example is just showing the usage of "ScopingConfiguration_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 AppComplianceReportResource created on azure
// for more information of creating AppComplianceReportResource, please refer to the document of AppComplianceReportResource
string reportName = "testReportName";
ResourceIdentifier appComplianceReportResourceId = AppComplianceReportResource.CreateResourceIdentifier(reportName);
AppComplianceReportResource appComplianceReport = client.GetAppComplianceReportResource(appComplianceReportResourceId);

// get the collection of this AppComplianceReportScopingConfigurationResource
AppComplianceReportScopingConfigurationCollection collection = appComplianceReport.GetAppComplianceReportScopingConfigurations();

// invoke the operation and iterate over the result
await foreach (AppComplianceReportScopingConfigurationResource 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
    AppComplianceReportScopingConfigurationData 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 da amostra

Código de estado:

200

{
  "value": [
    {
      "name": "default",
      "type": "Microsoft.AppComplianceAutomation/reports/scopingConfigurations",
      "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/scopingConfigurations/default",
      "properties": {
        "answers": [
          {
            "answers": [
              "Azure"
            ],
            "questionId": "GEN20_hostingEnvironment"
          },
          {
            "answers": [],
            "questionId": "DHP_G07_customerDataProcess"
          },
          {
            "answers": [],
            "questionId": "Tier2InitSub_serviceCommunicate"
          }
        ]
      },
      "systemData": {
        "createdAt": "2021-05-14T22:34:55.4499903Z",
        "createdBy": "00000000-0000-0000-0000-000000000000",
        "createdByType": "User",
        "lastModifiedAt": "2021-05-14T22:34:55.4499903Z",
        "lastModifiedBy": "00000000-0000-0000-0000-000000000000",
        "lastModifiedByType": "User"
      }
    }
  ]
}

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ProvisioningState	Estados de provisionamento de recursos.
ScopingAnswer	Resposta de escopo.
ScopingConfigurationResource	Uma classe representa um recurso de configuração de escopo AppComplianceAutomation.
ScopingConfigurationResourceListResult	A resposta de uma operação de lista ScopingConfigurationResource.
systemData	Metadados referentes à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Object

O detalhe do erro.

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

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ProvisioningState

Enumeração

Estados de provisionamento de recursos.

Valor	Description
Succeeded	A disposição é julgada procedente.
Failed	A disposição não foi aprovada.
Canceled	A provisão é cancelada.
Creating	A criação está em curso.
Deleting	A supressão está em curso.
Fixing	A correção do recurso em andamento.
Verifying	A verificação do recurso em curso.
Updating	A atualização do recurso em curso.

ScopingAnswer

Object

Resposta de escopo.

Name	Tipo	Description
answers	string[]	Lista de valores de resposta à pergunta.
questionId	string pattern: ^[-a-zA-Z0-9_]{1,50}$	Pergunta id.

ScopingConfigurationResource

Object

Uma classe representa um recurso de configuração de escopo AppComplianceAutomation.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.answers	ScopingAnswer[]	Lista de respostas de perguntas de escopo.
properties.provisioningState	ProvisioningState	Gerenciamento do ciclo de vida do Azure
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ScopingConfigurationResourceListResult

Object

A resposta de uma operação de lista ScopingConfigurationResource.

Name	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	ScopingConfigurationResource[]	Os itens ScopingConfigurationResource nesta página

systemData

Object

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

Name	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 carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.