Applications - List

Serviço:

Defender for Cloud

Versão da API:

2022-07-01-preview

Obter uma lista de todos os aplicativos relevantes em um escopo de nível de assinatura

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/applications?api-version=2022-07-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string	ID da assinatura do Azure Padrão Regex: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version	query	True	string	Versão da API para a operação

Respostas

Nome	Tipo	Description
200 OK	ApplicationsList	OKEY
Other Status Codes	CloudError	Resposta de erro descrevendo 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

List applications security by subscription level scope

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/applications?api-version=2022-07-01-preview

Java

/**
 * Samples for Applications List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2022-07-01-preview/examples/Applications/
     * ListBySubscriptionApplications_example.json
     */
    /**
     * Sample code: List applications security by subscription level scope.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void
        listApplicationsSecurityBySubscriptionLevelScope(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.applications().list(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

Go

package armsecurity_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/preview/2022-07-01-preview/examples/Applications/ListBySubscriptionApplications_example.json
func ExampleApplicationsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewApplicationsClient().NewListPager(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.ApplicationsList = armsecurity.ApplicationsList{
		// 	Value: []*armsecurity.Application{
		// 		{
		// 			Name: to.Ptr("ad9a8e26-29d9-4829-bb30-e597a58cdbb8"),
		// 			Type: to.Ptr("Microsoft.Security/applications"),
		// 			ID: to.Ptr("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/applications/ad9a8e26-29d9-4829-bb30-e597a58cdbb8"),
		// 			Properties: &armsecurity.ApplicationProperties{
		// 				Description: to.Ptr("An application on critical recommendations"),
		// 				ConditionSets: []any{
		// 					map[string]any{
		// 						"conditions":[]any{
		// 							map[string]any{
		// 								"operator": "contains",
		// 								"property": "$.Id",
		// 								"value": "-bil-",
		// 							},
		// 						},
		// 				}},
		// 				DisplayName: to.Ptr("Admin's application"),
		// 				SourceResourceType: to.Ptr(armsecurity.ApplicationSourceResourceTypeAssessments),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("4106f43c-6d82-4fc8-a92c-dcfe50799d1d"),
		// 			Type: to.Ptr("Microsoft.Security/applications"),
		// 			ID: to.Ptr("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/applications/4106f43c-6d82-4fc8-a92c-dcfe50799d1d"),
		// 			Properties: &armsecurity.ApplicationProperties{
		// 				Description: to.Ptr("An application on critical recommendations"),
		// 				ConditionSets: []any{
		// 					map[string]any{
		// 						"conditions":[]any{
		// 							map[string]any{
		// 								"operator": "contains",
		// 								"property": "$.Id",
		// 								"value": "-prod-",
		// 							},
		// 						},
		// 				}},
		// 				DisplayName: to.Ptr("Admin's application"),
		// 				SourceResourceType: to.Ptr(armsecurity.ApplicationSourceResourceTypeAssessments),
		// 			},
		// 	}},
		// }
	}
}

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

/**
 * This sample demonstrates how to Get a list of all relevant applications over a subscription level scope
 *
 * @summary Get a list of all relevant applications over a subscription level scope
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2022-07-01-preview/examples/Applications/ListBySubscriptionApplications_example.json
 */
async function listApplicationsSecurityBySubscriptionLevelScope() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.applications.list()) {
    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 System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.SecurityCenter;
using Azure.ResourceManager.SecurityCenter.Models;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2022-07-01-preview/examples/Applications/ListBySubscriptionApplications_example.json
// this example is just showing the usage of "Applications_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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// get the collection of this SubscriptionSecurityApplicationResource
SubscriptionSecurityApplicationCollection collection = subscriptionResource.GetSubscriptionSecurityApplications();

// invoke the operation and iterate over the result
await foreach (SubscriptionSecurityApplicationResource 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
    SecurityApplicationData 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/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/applications/ad9a8e26-29d9-4829-bb30-e597a58cdbb8",
      "name": "ad9a8e26-29d9-4829-bb30-e597a58cdbb8",
      "type": "Microsoft.Security/applications",
      "properties": {
        "displayName": "Admin's application",
        "description": "An application on critical recommendations",
        "sourceResourceType": "Assessments",
        "conditionSets": [
          {
            "conditions": [
              {
                "property": "$.Id",
                "value": "-bil-",
                "operator": "contains"
              }
            ]
          }
        ]
      }
    },
    {
      "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/applications/4106f43c-6d82-4fc8-a92c-dcfe50799d1d",
      "name": "4106f43c-6d82-4fc8-a92c-dcfe50799d1d",
      "type": "Microsoft.Security/applications",
      "properties": {
        "displayName": "Admin's application",
        "description": "An application on critical recommendations",
        "sourceResourceType": "Assessments",
        "conditionSets": [
          {
            "conditions": [
              {
                "property": "$.Id",
                "value": "-prod-",
                "operator": "contains"
              }
            ]
          }
        ]
      }
    }
  ]
}

Definições

Nome	Description
Application	Aplicativo de segurança em um determinado escopo
ApplicationCondition	Condição do aplicativo
ApplicationConditionOperator	O operador da condição do aplicativo, por exemplo, Contém para id ou para lista de IDs possíveis, confira exemplos
ApplicationsList	Página de uma lista de aplicativos de segurança
ApplicationSourceResourceType	A origem do aplicativo, o que ela afeta, por exemplo, avaliações
CloudError	Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).
CloudErrorBody	O detalhe do erro.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.

Application

Aplicativo de segurança em um determinado escopo

Nome	Tipo	Description
id	string	ID do recurso
name	string	Nome do recurso
properties.conditionSets	ApplicationCondition[]	Os conjuntos de condições do aplicativo – veja exemplos
properties.description	string	descrição do aplicativo
properties.displayName	string	nome de exibição do aplicativo
properties.sourceResourceType	ApplicationSourceResourceType	A origem do aplicativo, o que ela afeta, por exemplo, avaliações
type	string	Tipo de recurso

ApplicationCondition

Condição do aplicativo

Nome	Tipo	Description
operator	ApplicationConditionOperator	O operador da condição do aplicativo, por exemplo, Contém para id ou para lista de IDs possíveis, confira exemplos
property	string	A Propriedade da Condição do aplicativo, por exemplo, ID, confira exemplos
value	string	O valor da condição do aplicativo, como IDs que contêm alguma cadeia de caracteres, confira exemplos

ApplicationConditionOperator

O operador da condição do aplicativo, por exemplo, Contém para id ou para lista de IDs possíveis, confira exemplos

Nome	Tipo	Description
Contains	string	Verifica se o valor da cadeia de caracteres dos dados definidos na Propriedade contém o valor fornecido
Equals	string	Verifica se o valor da cadeia de caracteres dos dados definidos na Propriedade é igual ao valor fornecido
In	string	Verifica se o valor da cadeia de caracteres dos dados definidos na Propriedade é igual a qualquer um dos valores fornecidos (ajuste exato)

ApplicationsList

Página de uma lista de aplicativos de segurança

Nome	Tipo	Description
nextLink	string	O URI para buscar a próxima página
value	Application[]	Coleção de aplicativos nesta página

ApplicationSourceResourceType

A origem do aplicativo, o que ela afeta, por exemplo, avaliações

Nome	Tipo	Description
Assessments	string	A origem do aplicativo são avaliações

CloudError

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).

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

CloudErrorBody

O detalhe do erro.

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

ErrorAdditionalInfo

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.