你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Clients - Create Or Update

参考

服务:: Event Grid

API 版本:: 2025-02-15

使用指定的参数创建或更新客户端。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clients/{clientName}?api-version=2025-02-15

URI 参数

名称	在	必需	类型	说明
clientName	path	True	string minLength: 1 maxLength: 128 pattern: ^[-a-zA-Z0-9:\._]*$	客户端名称。
namespaceName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-zA-Z0-9-]*$	命名空间的名称。
resourceGroupName	path	True	string	用户订阅中的资源组的名称。
subscriptionId	path	True	string	唯一标识Microsoft Azure 订阅的订阅凭据。订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version	query	True	string	要用于客户端请求的 API 的版本。

请求正文

名称	类型	说明
properties.attributes		客户端的属性。支持的值为 int、bool、string、string[]。示例：“attributes”： { “room”： “345”， “floor”： 12， “deviceTypes”： [“Fan”， “Light”] }
properties.authenticationName	string	客户端提供用于身份验证的名称。默认值为资源的名称。
properties.clientCertificateAuthentication	ClientCertificateAuthentication	客户端证书身份验证信息。
properties.description	string	客户端资源的说明。
properties.state	ClientState	指示客户端是否处于启用状态。默认值为“已启用”。

响应

名称	类型	说明
200 OK	Client	创建或更新请求成功。
201 Created	Client	创建
Other Status Codes	ErrorResponse	如果请求失败，则返回错误响应。

示例

Clients_CreateOrUpdate

示例请求

PUT https://management.azure.com/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1/clients/exampleClientName1?api-version=2025-02-15

{
  "properties": {
    "state": "Enabled",
    "clientCertificateAuthentication": {
      "validationScheme": "SubjectMatchesAuthenticationName"
    },
    "attributes": {
      "room": "345",
      "floor": 3,
      "deviceTypes": [
        "Fan",
        "Light",
        "AC"
      ]
    },
    "description": "This is a test client"
  }
}


import com.azure.core.management.serializer.SerializerFactory;
import com.azure.core.util.serializer.SerializerEncoding;
import com.azure.resourcemanager.eventgrid.models.ClientCertificateAuthentication;
import com.azure.resourcemanager.eventgrid.models.ClientCertificateValidationScheme;
import com.azure.resourcemanager.eventgrid.models.ClientState;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Clients CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/Clients_CreateOrUpdate.
     * json
     */
    /**
     * Sample code: Clients_CreateOrUpdate.
     * 
     * @param manager Entry point to EventGridManager.
     */
    public static void clientsCreateOrUpdate(com.azure.resourcemanager.eventgrid.EventGridManager manager)
        throws IOException {
        manager.clients().define("exampleClientName1").withExistingNamespace("examplerg", "exampleNamespaceName1")
            .withDescription("This is a test client")
            .withClientCertificateAuthentication(new ClientCertificateAuthentication()
                .withValidationScheme(ClientCertificateValidationScheme.SUBJECT_MATCHES_AUTHENTICATION_NAME))
            .withState(ClientState.ENABLED)
            .withAttributes(
                mapOf("deviceTypes",
                    SerializerFactory.createDefaultManagementSerializerAdapter()
                        .deserialize("[\"Fan\",\"Light\",\"AC\"]", Object.class, SerializerEncoding.JSON),
                    "floor", 3, "room", "345"))
            .create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.eventgrid import EventGridManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-eventgrid
# USAGE
    python clients_create_or_update.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 = EventGridManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="8f6b6269-84f2-4d09-9e31-1127efcd1e40",
    )

    response = client.clients.begin_create_or_update(
        resource_group_name="examplerg",
        namespace_name="exampleNamespaceName1",
        client_name="exampleClientName1",
        client_info={
            "properties": {
                "attributes": {"deviceTypes": ["Fan", "Light", "AC"], "floor": 3, "room": "345"},
                "clientCertificateAuthentication": {"validationScheme": "SubjectMatchesAuthenticationName"},
                "description": "This is a test client",
                "state": "Enabled",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/Clients_CreateOrUpdate.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

package armeventgrid_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/eventgrid/armeventgrid/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ee1eec42dcc710ff88db2d1bf574b2f9afe3d654/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/Clients_CreateOrUpdate.json
func ExampleClientsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClientsClient().BeginCreateOrUpdate(ctx, "examplerg", "exampleNamespaceName1", "exampleClientName1", armeventgrid.Client{
		Properties: &armeventgrid.ClientProperties{
			Description: to.Ptr("This is a test client"),
			Attributes: map[string]any{
				"deviceTypes": []any{
					"Fan",
					"Light",
					"AC",
				},
				"floor": float64(3),
				"room":  "345",
			},
			ClientCertificateAuthentication: &armeventgrid.ClientCertificateAuthentication{
				ValidationScheme: to.Ptr(armeventgrid.ClientCertificateValidationSchemeSubjectMatchesAuthenticationName),
			},
			State: to.Ptr(armeventgrid.ClientStateEnabled),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.Client = armeventgrid.Client{
	// 	Name: to.Ptr("exampleClientName1"),
	// 	Type: to.Ptr("Microsoft.EventGrid/namespaces/clients"),
	// 	ID: to.Ptr("/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1/clients/exampleClientName1"),
	// 	Properties: &armeventgrid.ClientProperties{
	// 		Description: to.Ptr("This is a test client"),
	// 		Attributes: map[string]any{
	// 			"deviceTypes": []any{
	// 				"Light",
	// 				"1",
	// 			},
	// 			"floor": float64(3),
	// 			"room": "345a",
	// 		},
	// 		ClientCertificateAuthentication: &armeventgrid.ClientCertificateAuthentication{
	// 			ValidationScheme: to.Ptr(armeventgrid.ClientCertificateValidationSchemeSubjectMatchesAuthenticationName),
	// 		},
	// 		ProvisioningState: to.Ptr(armeventgrid.ClientProvisioningStateSucceeded),
	// 		State: to.Ptr(armeventgrid.ClientStateEnabled),
	// 	},
	// }
}

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

const { EventGridManagementClient } = require("@azure/arm-eventgrid");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Create or update a client with the specified parameters.
 *
 * @summary Create or update a client with the specified parameters.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/Clients_CreateOrUpdate.json
 */
async function clientsCreateOrUpdate() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "8f6b6269-84f2-4d09-9e31-1127efcd1e40";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const namespaceName = "exampleNamespaceName1";
  const clientName = "exampleClientName1";
  const clientInfo = {
    description: "This is a test client",
    attributes: { deviceTypes: ["Fan", "Light", "AC"], floor: 3, room: "345" },
    clientCertificateAuthentication: {
      validationScheme: "SubjectMatchesAuthenticationName",
    },
    state: "Enabled",
  };
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const result = await client.clients.beginCreateOrUpdateAndWait(
    resourceGroupName,
    namespaceName,
    clientName,
    clientInfo,
  );
  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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.EventGrid.Models;
using Azure.ResourceManager.EventGrid;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/Clients_CreateOrUpdate.json
// this example is just showing the usage of "Clients_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 EventGridNamespaceResource created on azure
// for more information of creating EventGridNamespaceResource, please refer to the document of EventGridNamespaceResource
string subscriptionId = "8f6b6269-84f2-4d09-9e31-1127efcd1e40";
string resourceGroupName = "examplerg";
string namespaceName = "exampleNamespaceName1";
ResourceIdentifier eventGridNamespaceResourceId = EventGridNamespaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName);
EventGridNamespaceResource eventGridNamespace = client.GetEventGridNamespaceResource(eventGridNamespaceResourceId);

// get the collection of this EventGridNamespaceClientResource
EventGridNamespaceClientCollection collection = eventGridNamespace.GetEventGridNamespaceClients();

// invoke the operation
string clientName = "exampleClientName1";
EventGridNamespaceClientData data = new EventGridNamespaceClientData
{
    Description = "This is a test client",
    ClientCertificateAuthentication = new ClientCertificateAuthentication
    {
        ValidationScheme = ClientCertificateValidationScheme.SubjectMatchesAuthenticationName,
    },
    State = EventGridNamespaceClientState.Enabled,
    Attributes =
    {
    ["deviceTypes"] = BinaryData.FromObjectAsJson(new object[]
    {
    "Fan",
    "Light",
    "AC"
    }),
    ["floor"] = BinaryData.FromObjectAsJson("3"),
    ["room"] = BinaryData.FromObjectAsJson("345")
    },
};
ArmOperation<EventGridNamespaceClientResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, clientName, data);
EventGridNamespaceClientResource 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
EventGridNamespaceClientData 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

{
  "properties": {
    "clientCertificateAuthentication": {
      "validationScheme": "SubjectMatchesAuthenticationName"
    },
    "state": "Enabled",
    "attributes": {
      "room": "345a",
      "floor": 3,
      "deviceTypes": [
        "Light",
        "1"
      ]
    },
    "provisioningState": "Succeeded",
    "description": "This is a test client"
  },
  "id": "/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1/clients/exampleClientName1",
  "name": "exampleClientName1",
  "type": "Microsoft.EventGrid/namespaces/clients"
}

状态代码:: 201

{
  "properties": {
    "clientCertificateAuthentication": {
      "validationScheme": "SubjectMatchesAuthenticationName"
    },
    "state": "Enabled",
    "attributes": {
      "room": "345a",
      "floor": 3,
      "deviceTypes": [
        "Light",
        "1"
      ]
    },
    "provisioningState": "Succeeded",
    "description": "This is a test client"
  },
  "id": "/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1/clients/exampleClientName1",
  "name": "exampleClientName1",
  "type": "Microsoft.EventGrid/namespaces/clients"
}

定义

名称	说明
Client	客户端资源。
ClientCertificateAuthentication	客户端的证书身份验证属性。
ClientCertificateValidationScheme	用于对客户端进行身份验证的验证方案。默认值为 SubjectMatchesAuthenticationName。
ClientProvisioningState	客户端资源的预配状态。
ClientState	指示客户端是否处于启用状态。默认值为“已启用”。
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
systemData	与创建和上次修改资源相关的元数据。

Client

Object

客户端资源。

名称	类型	默认值	说明
id	string		资源的完全限定标识符。
name	string		资源的名称。
properties.attributes			客户端的属性。支持的值为 int、bool、string、string[]。示例：“attributes”： { “room”： “345”， “floor”： 12， “deviceTypes”： [“Fan”， “Light”] }
properties.authenticationName	string		客户端提供用于身份验证的名称。默认值为资源的名称。
properties.clientCertificateAuthentication	ClientCertificateAuthentication		客户端证书身份验证信息。
properties.description	string		客户端资源的说明。
properties.provisioningState	ClientProvisioningState		客户端资源的预配状态。
properties.state	ClientState	Enabled	指示客户端是否处于启用状态。默认值为“已启用”。
systemData	systemData		与事件网格资源相关的系统元数据。
type	string		资源的类型。

ClientCertificateAuthentication

Object

客户端的证书身份验证属性。

名称	类型	说明
allowedThumbprints	string[]	客户端身份验证期间允许的指纹列表。仅当 validationScheme 为“ThumbprintMatch”时，才需要此属性。
validationScheme	ClientCertificateValidationScheme	用于对客户端进行身份验证的验证方案。默认值为 SubjectMatchesAuthenticationName。

ClientCertificateValidationScheme

枚举

用于对客户端进行身份验证的验证方案。默认值为 SubjectMatchesAuthenticationName。

值	说明
DnsMatchesAuthenticationName
EmailMatchesAuthenticationName
IpMatchesAuthenticationName
SubjectMatchesAuthenticationName
ThumbprintMatch
UriMatchesAuthenticationName

ClientProvisioningState

枚举

客户端资源的预配状态。

值	说明
Canceled
Creating
Deleted
Deleting
Failed
Succeeded
Updating

ClientState

枚举

指示客户端是否处于启用状态。默认值为“已启用”。

值	说明
Disabled
Enabled

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

资源管理错误附加信息。

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

ErrorDetail

Object

错误详细信息。

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

ErrorResponse

Object

错误响应

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

systemData

Object

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

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