Security Settings - Get

服务:

Azure Stack HCI

API 版本:

2024-04-01

获取 SecuritySetting

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/securitySettings/{securitySettingsName}?api-version=2024-04-01

URI 参数

名称	在	必需	类型	说明
clusterName	path	True	string	群集的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 名称不区分大小写。
securitySettingsName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	安全设置的名称
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	SecuritySetting	ARM 操作已成功完成。
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get Security Settings

示例请求

HTTP

GET https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/securitySettings/default?api-version=2024-04-01

Java

/**
 * Samples for SecuritySettings Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/
     * GetSecuritySettings.json
     */
    /**
     * Sample code: Get Security Settings.
     * 
     * @param manager Entry point to AzureStackHciManager.
     */
    public static void getSecuritySettings(com.azure.resourcemanager.azurestackhci.AzureStackHciManager manager) {
        manager.securitySettings().getWithResponse("test-rg", "myCluster", "default", 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.azurestackhci import AzureStackHCIClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-azurestackhci
# USAGE
    python get_security_settings.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 = AzureStackHCIClient(
        credential=DefaultAzureCredential(),
        subscription_id="fd3c3665-1729-4b7b-9a38-238e83b0f98b",
    )

    response = client.security_settings.get(
        resource_group_name="test-rg",
        cluster_name="myCluster",
    )
    print(response)


# x-ms-original-file: specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetSecuritySettings.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 armazurestackhci_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/azurestackhci/armazurestackhci/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetSecuritySettings.json
func ExampleSecuritySettingsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSecuritySettingsClient().Get(ctx, "test-rg", "myCluster", "default", 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.SecuritySetting = armazurestackhci.SecuritySetting{
	// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters/securitySettings"),
	// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/securitySettings/default"),
	// 	SystemData: &armazurestackhci.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
	// 		CreatedBy: to.Ptr("user1"),
	// 		CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user2"),
	// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 	},
	// 	Properties: &armazurestackhci.SecurityProperties{
	// 		ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
	// 		SecuredCoreComplianceAssignment: to.Ptr(armazurestackhci.ComplianceAssignmentTypeAudit),
	// 		SecurityComplianceStatus: &armazurestackhci.SecurityComplianceStatus{
	// 			DataAtRestEncrypted: to.Ptr(armazurestackhci.ComplianceStatusCompliant),
	// 			DataInTransitProtected: to.Ptr(armazurestackhci.ComplianceStatusCompliant),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-11-14T07:09:44.771Z"); return t}()),
	// 			SecuredCoreCompliance: to.Ptr(armazurestackhci.ComplianceStatusCompliant),
	// 			WdacCompliance: to.Ptr(armazurestackhci.ComplianceStatusCompliant),
	// 		},
	// 		SmbEncryptionForIntraClusterTrafficComplianceAssignment: to.Ptr(armazurestackhci.ComplianceAssignmentTypeAudit),
	// 		WdacComplianceAssignment: to.Ptr(armazurestackhci.ComplianceAssignmentTypeApplyAndAutoCorrect),
	// 	},
	// }
}

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

/**
 * This sample demonstrates how to Get a SecuritySetting
 *
 * @summary Get a SecuritySetting
 * x-ms-original-file: specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetSecuritySettings.json
 */
async function getSecuritySettings() {
  const subscriptionId =
    process.env["AZURESTACKHCI_SUBSCRIPTION_ID"] || "fd3c3665-1729-4b7b-9a38-238e83b0f98b";
  const resourceGroupName = process.env["AZURESTACKHCI_RESOURCE_GROUP"] || "test-rg";
  const clusterName = "myCluster";
  const securitySettingsName = "default";
  const credential = new DefaultAzureCredential();
  const client = new AzureStackHCIClient(credential, subscriptionId);
  const result = await client.securitySettings.get(
    resourceGroupName,
    clusterName,
    securitySettingsName,
  );
  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.Hci.Models;
using Azure.ResourceManager.Hci;

// Generated from example definition: specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetSecuritySettings.json
// this example is just showing the usage of "SecuritySettings_Get" 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 HciClusterSecuritySettingResource created on azure
// for more information of creating HciClusterSecuritySettingResource, please refer to the document of HciClusterSecuritySettingResource
string subscriptionId = "fd3c3665-1729-4b7b-9a38-238e83b0f98b";
string resourceGroupName = "test-rg";
string clusterName = "myCluster";
string securitySettingsName = "default";
ResourceIdentifier hciClusterSecuritySettingResourceId = HciClusterSecuritySettingResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, clusterName, securitySettingsName);
HciClusterSecuritySettingResource hciClusterSecuritySetting = client.GetHciClusterSecuritySettingResource(hciClusterSecuritySettingResourceId);

// invoke the operation
HciClusterSecuritySettingResource result = await hciClusterSecuritySetting.GetAsync();

// 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
HciClusterSecuritySettingData 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/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/securitySettings/default",
  "type": "Microsoft.AzureStackHCI/clusters/securitySettings",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "securedCoreComplianceAssignment": "Audit",
    "wdacComplianceAssignment": "ApplyAndAutoCorrect",
    "smbEncryptionForIntraClusterTrafficComplianceAssignment": "Audit",
    "securityComplianceStatus": {
      "securedCoreCompliance": "Compliant",
      "wdacCompliance": "Compliant",
      "dataAtRestEncrypted": "Compliant",
      "dataInTransitProtected": "Compliant",
      "lastUpdated": "2023-11-14T07:09:44.771Z"
    },
    "provisioningState": "Succeeded"
  }
}

定义

名称	说明
ComplianceAssignmentType	表示资源的符合性分配类型。
ComplianceStatus	表示资源的符合性状态。
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ProvisioningState	资源的预配状态。
SecurityComplianceStatus	资源的安全符合性属性
SecuritySetting	安全设置代理资源
systemData	与创建和上次修改资源相关的元数据。

ComplianceAssignmentType

枚举

表示资源的符合性分配类型。

值	说明
Audit	报告计算机的状态，但不进行更改。
ApplyAndAutoCorrect	应用于计算机。 如果偏移，则计算机内的本地服务在下一次评估时进行更正。

ComplianceStatus

枚举

表示资源的符合性状态。

值	说明
Compliant	资源符合性
NonCompliant	资源不符合
Pending	资源符合性状态处于挂起状态

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ProvisioningState

枚举

资源的预配状态。

值	说明
Succeeded	已创建资源。
Failed	资源创建失败。
Canceled	资源创建已取消。
Provisioning	正在预配资源
Updating	资源正在更新
Deleting	正在删除资源
Accepted	已接受资源创建请求

SecurityComplianceStatus

Object

资源的安全符合性属性

名称	类型	说明
dataAtRestEncrypted	ComplianceStatus	指示是否在 Azure Stack HCI 群集卷上启用静态数据加密。
dataInTransitProtected	ComplianceStatus	指示 HCI 群集是否具有传输中数据保护。
lastUpdated	string (date-time)	上次更新符合性状态的 UTC 时间。
securedCoreCompliance	ComplianceStatus	指示 HCI 主机是否满足安全核心服务器要求。
wdacCompliance	ComplianceStatus	指示 HCI 主机是否已强制实施一致的 Windows Defender 应用程序控制。

SecuritySetting

Object

安全设置代理资源

名称	类型	默认值	说明
id	string (arm-id)		资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string		资源的名称
properties.provisioningState	ProvisioningState		上次操作的状态。
properties.securedCoreComplianceAssignment	ComplianceAssignmentType	Audit	安全核心符合性分配
properties.securityComplianceStatus	SecurityComplianceStatus		安全符合性状态
properties.smbEncryptionForIntraClusterTrafficComplianceAssignment	ComplianceAssignmentType	Audit	群集内流量符合性分配的 SMB 加密
properties.wdacComplianceAssignment	ComplianceAssignmentType	Audit	WDAC 合规性分配
systemData	systemData		包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string		资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。