Security Connector Application - Create Or Update

Reference

Služba:: Defender for Cloud

Verze rozhraní API:: 2022-07-01-preview

Vytvoří nebo aktualizuje aplikaci zabezpečení na daném konektoru zabezpečení.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
applicationId	path	True	string	Klíč aplikace zabezpečení – jedinečný klíč pro standardní aplikaci
resourceGroupName	path	True	string	Název skupiny prostředků v rámci předplatného uživatele. Název nerozlišuje malá a velká písmena. Vzor regulárního výrazu: `^[-\w\._]+$`
securityConnectorName	path	True	string	Název konektoru zabezpečení.
subscriptionId	path	True	string	ID předplatného Azure Vzor regulárního výrazu: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Verze rozhraní API pro operaci

Text požadavku

Name	Vyžadováno	Typ	Description
properties.conditionSets	True	ApplicationCondition[]	Sady podmínek aplikace – viz příklady
properties.sourceResourceType	True	ApplicationSourceResourceType	Zdroj aplikace, co ovlivňuje, například posouzení
properties.description		string	popis aplikace
properties.displayName		string	zobrazovaný název aplikace

Odpovědi

Name	Typ	Description
200 OK	Application	OK – aktualizováno
201 Created	Application	Vytvořil
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Create Application

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
          }
        ]
      }
    ]
  }
}

Stavový kód:: 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"
          }
        ]
      }
    ]
  }
}

Definice

Name	Description
Application	Aplikace zabezpečení nad daným oborem
ApplicationCondition	Podmínka aplikace
ApplicationConditionOperator	Operátor podmínky aplikace, například Obsahuje id nebo In pro seznam možných ID, najdete v příkladech.
ApplicationSourceResourceType	Zdroj aplikace, co ovlivňuje, například posouzení
CloudError	Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
CloudErrorBody	Podrobnosti o chybě.
ErrorAdditionalInfo	Další informace o chybě správy prostředků

Application

Aplikace zabezpečení nad daným oborem

Name	Typ	Description
id	string	ID prostředku
name	string	Název prostředku
properties.conditionSets	ApplicationCondition[]	Sady podmínek aplikace – viz příklady
properties.description	string	popis aplikace
properties.displayName	string	zobrazovaný název aplikace
properties.sourceResourceType	ApplicationSourceResourceType	Zdroj aplikace, co ovlivňuje, například posouzení
type	string	Typ prostředku

ApplicationCondition

Podmínka aplikace

Name	Typ	Description
operator	ApplicationConditionOperator	Operátor podmínky aplikace, například Obsahuje id nebo In pro seznam možných ID, najdete v příkladech.
property	string	Vlastnost podmínky aplikace, například ID, viz příklady
value	string	Hodnota podmínky aplikace, jako jsou ID, která obsahují nějaký řetězec, najdete v příkladech.

ApplicationConditionOperator

Operátor podmínky aplikace, například Obsahuje id nebo In pro seznam možných ID, najdete v příkladech.

Name	Typ	Description
Contains	string	Kontroluje, zda řetězcová hodnota dat definovaných ve vlastnosti obsahuje danou hodnotu.
Equals	string	Kontroluje, že řetězcová hodnota dat definovaných ve vlastnosti se rovná dané hodnotě.
In	string	Zkontroluje, jestli se řetězcová hodnota dat definovaných ve vlastnosti rovná některé z daných hodnot (přesné přizpůsobení).

ApplicationSourceResourceType

Zdroj aplikace, co ovlivňuje, například posouzení

Name	Typ	Description
Assessments	string	Zdrojem aplikace je posouzení.

CloudError

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Name	Typ	Description
error.additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
error.code	string	Kód chyby.
error.details	CloudErrorBody[]	Podrobnosti o chybě.
error.message	string	Chybová zpráva.
error.target	string	Cíl chyby.

CloudErrorBody

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	CloudErrorBody[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

Sdílet prostřednictvím

Security Connector Application - Create Or Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Create Application

Ukázkový požadavek

Ukázková odpověď

Definice

Application

ApplicationCondition

ApplicationConditionOperator

ApplicationSourceResourceType

CloudError

CloudErrorBody

ErrorAdditionalInfo

Další materiály