Security Operators - Create Or Update

Referencia

Servicio:: Defender for Cloud

Versión de la API:: 2023-01-01-preview

Crea un operador de seguridad de Microsoft Defender for Cloud en el ámbito especificado.

PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings/{pricingName}/securityOperators/{securityOperatorName}?api-version=2023-01-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
pricingName	path	True	string	nombre de la configuración de precios Patrón de Regex: `^[a-zA-Z][a-zA-Z0-9_]+$`
securityOperatorName	path	True	string	nombre de securityOperator Patrón de Regex: `^[a-zA-Z][a-zA-Z0-9_]+$`
subscriptionId	path	True	string	Identificador de suscripción de Azure Patrón de Regex: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Versión de API para la operación

Respuestas

Nombre	Tipo	Description
200 OK	SecurityOperator	Solicitud correcta para colocar el operador de seguridad.
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Create a security operator on the given scope

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/CloudPosture/securityOperators/DefenderCSPMSecurityOperator?api-version=2023-01-01-preview


/**
 * Samples for SecurityOperators CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2023-01-01-preview/examples/SecurityOperators/
     * PutSecurityOperatorByName_example.json
     */
    /**
     * Sample code: Create a security operator on the given scope.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void
        createASecurityOperatorOnTheGivenScope(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.securityOperators().createOrUpdateWithResponse("CloudPosture", "DefenderCSPMSecurityOperator",
            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/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/2023-01-01-preview/examples/SecurityOperators/PutSecurityOperatorByName_example.json
func ExampleOperatorsClient_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.NewOperatorsClient().CreateOrUpdate(ctx, "CloudPosture", "DefenderCSPMSecurityOperator", 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.OperatorResource = armsecurity.OperatorResource{
	// 	Name: to.Ptr("DefenderCSPMSecurityOperator"),
	// 	Type: to.Ptr("Microsoft.Security/pricings/securityOperator"),
	// 	ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/CloudPosture/securityOperators/DefenderCSPMSecurityOperator"),
	// 	Identity: &armsecurity.Identity{
	// 		Type: to.Ptr("SystemAssigned"),
	// 		PrincipalID: to.Ptr("44ee8e7e-7f52-4750-b937-27490fbf7663"),
	// 		TenantID: to.Ptr("72f988bf-86f1-41af-91ab-2d7cd011db47"),
	// 	},
	// }
}

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 Microsoft Defender for Cloud security operator on the given scope.
 *
 * @summary Creates Microsoft Defender for Cloud security operator on the given scope.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-01-01-preview/examples/SecurityOperators/PutSecurityOperatorByName_example.json
 */
async function createASecurityOperatorOnTheGivenScope() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const pricingName = "CloudPosture";
  const securityOperatorName = "DefenderCSPMSecurityOperator";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.securityOperators.createOrUpdate(pricingName, securityOperatorName);
  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.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.SecurityCenter;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2023-01-01-preview/examples/SecurityOperators/PutSecurityOperatorByName_example.json
// this example is just showing the usage of "SecurityOperators_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 SecurityOperatorResource created on azure
// for more information of creating SecurityOperatorResource, please refer to the document of SecurityOperatorResource
string subscriptionId = "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
string pricingName = "CloudPosture";
string securityOperatorName = "DefenderCSPMSecurityOperator";
ResourceIdentifier securityOperatorResourceId = SecurityOperatorResource.CreateResourceIdentifier(subscriptionId, pricingName, securityOperatorName);
SecurityOperatorResource securityOperator = client.GetSecurityOperatorResource(securityOperatorResourceId);

// invoke the operation
ArmOperation<SecurityOperatorResource> lro = await securityOperator.UpdateAsync(WaitUntil.Completed);
SecurityOperatorResource 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
SecurityOperatorData 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

Respuesta de muestra

status code:: 200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/CloudPosture/securityOperators/DefenderCSPMSecurityOperator",
  "name": "DefenderCSPMSecurityOperator",
  "type": "Microsoft.Security/pricings/securityOperator",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "44ee8e7e-7f52-4750-b937-27490fbf7663",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
  }
}

Definiciones

Nombre	Description
CloudError	Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).
CloudErrorBody	Detalle del error.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
Identity	Identidad del recurso.
ResourceIdentityType	Tipo de identidad.
SecurityOperator	Operador de seguridad en una suscripción y precios determinado

CloudError

Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

Nombre	Tipo	Description
error.additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
error.code	string	Código de error.
error.details	CloudErrorBody[]	Detalles del error.
error.message	string	Mensaje de error.
error.target	string	Destino del error.

CloudErrorBody

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	CloudErrorBody[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

Identity

Identidad del recurso.

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de la identidad del recurso.
tenantId	string	Identificador de inquilino del recurso.
type	ResourceIdentityType	Tipo de identidad.

ResourceIdentityType

Tipo de identidad.

Nombre	Tipo	Description
SystemAssigned	string