Scoping Configuration - List

Layanan:

App Compliance Automation

Versi API:

2024-06-27

Mengembalikan format daftar dari singleton scopingConfiguration untuk laporan tertentu.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
reportName	path	True	string pattern: ^[-a-zA-Z0-9_]{1,50}$	Nama Laporan.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	ScopingConfigurationResourceListResult	Operasi Azure berhasil diselesaikan.
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

ScopingConfiguration_List

Permintaan sampel

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

Respon sampel

Kode status:

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"
      }
    }
  ]
}

Definisi

Nama	Deskripsi
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
ProvisioningState	Status provisi sumber daya.
ScopingAnswer	Jawaban cakupan.
ScopingConfigurationResource	Kelas mewakili sumber daya konfigurasi cakupan AppComplianceAutomation.
ScopingConfigurationResourceListResult	Respons operasi daftar ScopingConfigurationResource.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

createdByType

Enumeration

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

ProvisioningState

Enumeration

Status provisi sumber daya.

Nilai	Deskripsi
Succeeded	Provisi berhasil.
Failed	Provisi gagal.
Canceled	Ketentuan dibatalkan.
Creating	Pembuatan sedang berlangsung.
Deleting	Penghapusan sedang berlangsung.
Fixing	Perbaikan sumber daya yang sedang berlangsung.
Verifying	Verifikasi sumber daya yang sedang berlangsung.
Updating	Pembaruan sumber daya yang sedang berlangsung.

ScopingAnswer

Objek

Jawaban cakupan.

Nama	Jenis	Deskripsi
answers	string[]	Daftar nilai jawaban atas pertanyaan.
questionId	string pattern: ^[-a-zA-Z0-9_]{1,50}$	Id pertanyaan.

ScopingConfigurationResource

Objek

Kelas mewakili sumber daya konfigurasi cakupan AppComplianceAutomation.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya
properties.answers	ScopingAnswer[]	Daftar jawaban atas pertanyaan.
properties.provisioningState	ProvisioningState	Manajemen siklus hidup Azure
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

ScopingConfigurationResourceListResult

Objek

Respons operasi daftar ScopingConfigurationResource.

Nama	Jenis	Deskripsi
nextLink	string (uri)	Tautan ke halaman item berikutnya
value	ScopingConfigurationResource[]	Item ScopingConfigurationResource di halaman ini

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.