Security Connector Application - Create Or Update

Ссылка

Служба:: Defender for Cloud

Версия API:: 2022-07-01-preview

Создает или обновляет приложение безопасности в заданном соединителе безопасности.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/providers/Microsoft.Security/applications/{applicationId}?api-version=2022-07-01-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
applicationId	path	True	string	Ключ приложения безопасности — уникальный ключ для стандартного приложения
resourceGroupName	path	True	string	Имя группы ресурсов в подписке пользователя. Имя не учитывает регистр. Шаблон регулярного выражения: `^[-\w\._]+$`
securityConnectorName	path	True	string	Имя соединителя безопасности.
subscriptionId	path	True	string	Идентификатор подписки Azure Шаблон регулярного выражения: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Версия API для операции

Текст запроса

Имя	Обязательно	Тип	Описание
properties.conditionSets	True	ApplicationCondition[]	Наборы условий приложения— см. примеры
properties.sourceResourceType	True	ApplicationSourceResourceType	Источник приложения, что это влияет, например оценки
properties.description		string	описание приложения
properties.displayName		string	отображаемое имя приложения

Ответы

Имя	Тип	Описание
200 OK	Application	ОК — обновлено
201 Created	Application	Созданный
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Create Application

Образец запроса

PUT https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector/providers/Microsoft.Security/applications/ad9a8e26-29d9-4829-bb30-e597a58cdbb8?api-version=2022-07-01-preview

{
  "properties": {
    "displayName": "GCP Admin's application",
    "description": "An application on critical GCP recommendations",
    "sourceResourceType": "Assessments",
    "conditionSets": [
      {
        "conditions": [
          {
            "property": "$.Id",
            "value": "-prod-",
            "operator": "contains"
          }
        ]
      }
    ]
  }
}


import com.azure.core.management.serializer.SerializerFactory;
import com.azure.core.util.serializer.SerializerEncoding;
import com.azure.resourcemanager.security.fluent.models.ApplicationInner;
import com.azure.resourcemanager.security.models.ApplicationSourceResourceType;
import java.io.IOException;
import java.util.Arrays;

/**
 * Samples for SecurityConnectorApplicationOperation CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2022-07-01-preview/examples/Applications/
     * PutSecurityConnectorApplication_example.json
     */
    /**
     * Sample code: Create Application.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void createApplication(com.azure.resourcemanager.security.SecurityManager manager)
        throws IOException {
        manager.securityConnectorApplicationOperations().createOrUpdateWithResponse("gcpResourceGroup", "gcpconnector",
            "ad9a8e26-29d9-4829-bb30-e597a58cdbb8",
            new ApplicationInner().withDisplayName("GCP Admin's application")
                .withDescription("An application on critical GCP recommendations")
                .withSourceResourceType(ApplicationSourceResourceType.ASSESSMENTS).withConditionSets(
                    Arrays.asList(SerializerFactory.createDefaultManagementSerializerAdapter().deserialize(
                        "{\"conditions\":[{\"operator\":\"contains\",\"property\":\"$.Id\",\"value\":\"-prod-\"}]}",
                        Object.class, SerializerEncoding.JSON))),
            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

package armsecurity_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/PutSecurityConnectorApplication_example.json
func ExampleConnectorApplicationClient_CreateOrUpdate() {
	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)
	}
	res, err := clientFactory.NewConnectorApplicationClient().CreateOrUpdate(ctx, "gcpResourceGroup", "gcpconnector", "ad9a8e26-29d9-4829-bb30-e597a58cdbb8", armsecurity.Application{
		Properties: &armsecurity.ApplicationProperties{
			Description: to.Ptr("An application on critical GCP recommendations"),
			ConditionSets: []any{
				map[string]any{
					"conditions": []any{
						map[string]any{
							"operator": "contains",
							"property": "$.Id",
							"value":    "-prod-",
						},
					},
				}},
			DisplayName:        to.Ptr("GCP Admin's application"),
			SourceResourceType: to.Ptr(armsecurity.ApplicationSourceResourceTypeAssessments),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Application = armsecurity.Application{
	// 	Name: to.Ptr("1f3afdf9-d0c9-4c3d-847f-89da613e70a8"),
	// 	Type: to.Ptr("Microsoft.Security/applications"),
	// 	ID: to.Ptr("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector/providers/Microsoft.Security/applications/ad9a8e26-29d9-4829-bb30-e597a58cdbb8"),
	// 	Properties: &armsecurity.ApplicationProperties{
	// 		Description: to.Ptr("An application on critical GCP recommendations"),
	// 		ConditionSets: []any{
	// 			map[string]any{
	// 				"conditions":[]any{
	// 					map[string]any{
	// 						"operator": "contains",
	// 						"property": "$.Id",
	// 						"value": "-bil-",
	// 					},
	// 				},
	// 		}},
	// 		DisplayName: to.Ptr("GCP 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

const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or update a security Application on the given security connector.
 *
 * @summary Creates or update a security Application on the given security connector.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2022-07-01-preview/examples/Applications/PutSecurityConnectorApplication_example.json
 */
async function createApplication() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const resourceGroupName = process.env["SECURITY_RESOURCE_GROUP"] || "gcpResourceGroup";
  const securityConnectorName = "gcpconnector";
  const applicationId = "ad9a8e26-29d9-4829-bb30-e597a58cdbb8";
  const application = {
    description: "An application on critical GCP recommendations",
    conditionSets: [
      {
        conditions: [{ operator: "contains", property: "$.Id", value: "-prod-" }],
      },
    ],
    displayName: "GCP Admin's application",
    sourceResourceType: "Assessments",
  };
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.securityConnectorApplication.createOrUpdate(
    resourceGroupName,
    securityConnectorName,
    applicationId,
    application,
  );
  console.log(result);
}

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

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
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/PutSecurityConnectorApplication_example.json
// this example is just showing the usage of "SecurityConnectorApplications_CreateOrUpdate" 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 SecurityConnectorApplicationResource created on azure
// for more information of creating SecurityConnectorApplicationResource, please refer to the document of SecurityConnectorApplicationResource
string subscriptionId = "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
string resourceGroupName = "gcpResourceGroup";
string securityConnectorName = "gcpconnector";
string applicationId = "ad9a8e26-29d9-4829-bb30-e597a58cdbb8";
ResourceIdentifier securityConnectorApplicationResourceId = SecurityConnectorApplicationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, securityConnectorName, applicationId);
SecurityConnectorApplicationResource securityConnectorApplication = client.GetSecurityConnectorApplicationResource(securityConnectorApplicationResourceId);

// invoke the operation
SecurityApplicationData data = new SecurityApplicationData()
{
    DisplayName = "GCP Admin's application",
    Description = "An application on critical GCP recommendations",
    SourceResourceType = ApplicationSourceResourceType.Assessments,
    ConditionSets =
    {
    BinaryData.FromObjectAsJson(new Dictionary<string, object>()
    {
    ["conditions"] = new object[] { new Dictionary<string, object>()
    {
    ["operator"] = "contains",
    ["property"] = "$.Id",
    ["value"] = "-prod-"} }})
    },
};
ArmOperation<SecurityConnectorApplicationResource> lro = await securityConnectorApplication.UpdateAsync(WaitUntil.Completed, data);
SecurityConnectorApplicationResource result = lro.Value;

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Пример ответа

Код состояния:: 200

{
  "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector/providers/Microsoft.Security/applications/ad9a8e26-29d9-4829-bb30-e597a58cdbb8",
  "name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
  "type": "Microsoft.Security/applications",
  "properties": {
    "displayName": "GCP Admin's application",
    "description": "An application on critical GCP recommendations",
    "sourceResourceType": "Assessments",
    "conditionSets": [
      {
        "conditions": [
          {
            "property": "$.Id",
            "value": "-bil-",
            "operator": "contains"
          }
        ]
      }
    ]
  }
}

Код состояния:: 201

{
  "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector/providers/Microsoft.Security/applications/ad9a8e26-29d9-4829-bb30-e597a58cdbb8",
  "name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
  "type": "Microsoft.Security/applications",
  "properties": {
    "displayName": "GCP Admin's application",
    "description": "An application on critical GCP recommendations",
    "sourceResourceType": "Assessments",
    "conditionSets": [
      {
        "conditions": [
          {
            "property": "$.Id",
            "value": "-pricing-",
            "operator": "contains"
          }
        ]
      }
    ]
  }
}

Определения

Имя	Описание
Application	Приложение безопасности по заданной области
ApplicationCondition	Условие приложения
ApplicationConditionOperator	Оператор условия приложения, например "Содержит идентификатор" или "В" для списка возможных идентификаторов, см. в примерах
ApplicationSourceResourceType	Источник приложения, что это влияет, например оценки
CloudError	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
CloudErrorBody	Сведения об ошибке.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.

Application

Приложение безопасности по заданной области

Имя	Тип	Описание
id	string	Идентификатор ресурса
name	string	Имя ресурса
properties.conditionSets	ApplicationCondition[]	Наборы условий приложения— см. примеры
properties.description	string	описание приложения
properties.displayName	string	отображаемое имя приложения
properties.sourceResourceType	ApplicationSourceResourceType	Источник приложения, что это влияет, например оценки
type	string	Тип ресурса

ApplicationCondition

Условие приложения

Имя	Тип	Описание
operator	ApplicationConditionOperator	Оператор условия приложения, например "Содержит идентификатор" или "В" для списка возможных идентификаторов, см. в примерах
property	string	Свойство условия приложения, например идентификатор, см. примеры
value	string	Значение условия приложения, например идентификаторы, содержащие некоторую строку, см. примеры

ApplicationConditionOperator

Оператор условия приложения, например "Содержит идентификатор" или "В" для списка возможных идентификаторов, см. в примерах

Имя	Тип	Описание
Contains	string	Проверяет, содержит ли строковое значение данных, определенное в свойстве.
Equals	string	Проверяет, что строковое значение данных, определенное в свойстве, равно заданному значению.
In	string	Проверяет, что строковое значение данных, определенное в свойстве, равно любому из заданных значений (точное соответствие)

ApplicationSourceResourceType

Источник приложения, что это влияет, например оценки

Имя	Тип	Описание
Assessments	string	Источником приложения является оценка

CloudError

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

Имя	Тип	Описание
error.additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
error.code	string	Код ошибки.
error.details	CloudErrorBody[]	Сведения об ошибке.
error.message	string	Сообщение об ошибке.
error.target	string	Целевой объект ошибки.

CloudErrorBody

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	CloudErrorBody[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

Поделиться через

Security Connector Application - Create Or Update

Параметры URI

Текст запроса

Ответы

Безопасность

azure_auth

Области

Примеры

Create Application

Образец запроса

Пример ответа

Определения

Application

ApplicationCondition

ApplicationConditionOperator

ApplicationSourceResourceType

CloudError

CloudErrorBody

ErrorAdditionalInfo

Дополнительные ресурсы