Security Operators - List

Layanan:

Defender for Cloud

Versi API:

2023-01-01-preview

Mencantumkan Microsoft Defender untuk Cloud securityOperators dalam langganan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
pricingName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z][a-zA-Z0-9_]+$	nama konfigurasi harga
subscriptionId	path	True	string pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$	ID langganan Azure
api-version	query	True	string	Versi API untuk operasi

Respons

Nama	Jenis	Deskripsi
200 OK	SecurityOperatorList	OKE
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

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

List SecurityOperators

Permintaan sampel

HTTP

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

Java

/**
 * Samples for SecurityOperators List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2023-01-01-preview/examples/SecurityOperators/
     * ListSecurityOperators_example.json
     */
    /**
     * Sample code: List SecurityOperators.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void listSecurityOperators(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.securityOperators().listWithResponse("CloudPosture", 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.security import SecurityCenter

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-security
# USAGE
    python list_security_operators_example.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 = SecurityCenter(
        credential=DefaultAzureCredential(),
        subscription_id="20ff7fc3-e762-44dd-bd96-b71116dcdc23",
    )

    response = client.security_operators.list(
        pricing_name="CloudPosture",
    )
    print(response)


# x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-01-01-preview/examples/SecurityOperators/ListSecurityOperators_example.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 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/ListSecurityOperators_example.json
func ExampleOperatorsClient_List() {
	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().List(ctx, "CloudPosture", 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.OperatorList = armsecurity.OperatorList{
	// 	Value: []*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

JavaScript

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

/**
 * This sample demonstrates how to Lists Microsoft Defender for Cloud securityOperators in the subscription.
 *
 * @summary Lists Microsoft Defender for Cloud securityOperators in the subscription.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-01-01-preview/examples/SecurityOperators/ListSecurityOperators_example.json
 */
async function listSecurityOperators() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const pricingName = "CloudPosture";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.securityOperators.list(pricingName);
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.SecurityCenter;

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

// get the collection of this SecurityOperatorResource
SecurityOperatorCollection collection = securityCenterPricing.GetSecurityOperators();

// invoke the operation and iterate over the result
await foreach (SecurityOperatorResource 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
    SecurityOperatorData 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": [
    {
      "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"
      }
    }
  ]
}

Definisi

Nama	Deskripsi
CloudError	Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).
CloudErrorBody	Detail kesalahan.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
Identity	Identitas untuk sumber daya.
ResourceIdentityType	Jenis identitas.
SecurityOperator	Operator keamanan di bawah langganan dan harga tertentu
SecurityOperatorList	Daftar respons SecurityOperator.

CloudError

Objek

Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).

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

CloudErrorBody

Objek

Detail kesalahan.

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

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

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

Identity

Objek

Identitas untuk sumber daya.

Nama	Jenis	Deskripsi
principalId	string	ID utama identitas sumber daya.
tenantId	string	ID penyewa sumber daya.
type	ResourceIdentityType	Jenis identitas.

ResourceIdentityType

Enumeration

Jenis identitas.

Nilai	Deskripsi
SystemAssigned

SecurityOperator

Objek

Operator keamanan di bawah langganan dan harga tertentu

Nama	Jenis	Deskripsi
id	string	Id Sumber Daya
identity	Identity	Identitas untuk sumber daya.
name	string	Nama sumber daya
type	string	Jenis sumber daya

SecurityOperatorList

Objek

Daftar respons SecurityOperator.

Nama	Jenis	Deskripsi
value	SecurityOperator[]	Daftar konfigurasi SecurityOperator