Clients - Create Or Update

Reference

Service:: Event Grid

API Version:: 2024-06-01-preview

Create or update a client with the specified parameters.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clients/{clientName}?api-version=2024-06-01-preview

URI Parameters

Name	In	Required	Type	Description
clientName	path	True	string	The client name. Regex pattern: `^[-a-zA-Z0-9:\._]*$`
namespaceName	path	True	string	Name of the namespace. Regex pattern: `^[a-zA-Z0-9-]*$`
resourceGroupName	path	True	string	The name of the resource group within the user's subscription.
subscriptionId	path	True	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Version of the API to be used with the client request.

Request Body

Name	Type	Description
properties.attributes		Attributes for the client. Supported values are int, bool, string, string[]. Example: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }
properties.authenticationName	string	The name presented by the client for authentication. The default value is the name of the resource.
properties.clientCertificateAuthentication	ClientCertificateAuthentication	The client certificate authentication information.
properties.description	string	Description for the Client resource.
properties.state	ClientState	Indicates if the client is enabled or not. Default value is Enabled.

Responses

Name	Type	Description
200 OK	Client	Create or update request is successful.
201 Created	Client	Created
Other Status Codes	ErrorResponse	Error response returned if request was unsuccessful.

Examples

Clients_CreateOrUpdate

Sample Request

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

{
  "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/preview/2024-06-01-preview/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 typing import Any, IO, Union

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/preview/2024-06-01-preview/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/b8691fbfca8fcdc5a241a0b501c32fd4a76bb0cd/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2024-06-01-preview/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");

/**
 * 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/preview/2024-06-01-preview/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

Sample Response

Status code:: 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"
}

Status code:: 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"
}

Definitions

Name	Description
Client	The Client resource.
ClientCertificateAuthentication	The certificate authentication properties for the client.
ClientCertificateValidationScheme	The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName.
ClientProvisioningState	Provisioning state of the Client resource.
ClientState	Indicates if the client is enabled or not. Default value is Enabled.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
systemData	Metadata pertaining to creation and last modification of the resource.

Client

The Client resource.

Name	Type	Default Value	Description
id	string		Fully qualified identifier of the resource.
name	string		Name of the resource.
properties.attributes			Attributes for the client. Supported values are int, bool, string, string[]. Example: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }
properties.authenticationName	string		The name presented by the client for authentication. The default value is the name of the resource.
properties.clientCertificateAuthentication	ClientCertificateAuthentication		The client certificate authentication information.
properties.description	string		Description for the Client resource.
properties.provisioningState	ClientProvisioningState		Provisioning state of the Client resource.
properties.state	ClientState	Enabled	Indicates if the client is enabled or not. Default value is Enabled.
systemData	systemData		The system metadata relating to the Client resource.
type	string		Type of the resource.

ClientCertificateAuthentication

The certificate authentication properties for the client.

Name	Type	Description
allowedThumbprints	string[]	The list of thumbprints that are allowed during client authentication. This property is required only if the validationScheme is 'ThumbprintMatch'.
validationScheme	ClientCertificateValidationScheme	The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName.

ClientCertificateValidationScheme

The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName.

Name	Type	Description
DnsMatchesAuthenticationName	string
EmailMatchesAuthenticationName	string
IpMatchesAuthenticationName	string
SubjectMatchesAuthenticationName	string
ThumbprintMatch	string
UriMatchesAuthenticationName	string

ClientProvisioningState

Provisioning state of the Client resource.

Name	Type	Description
Canceled	string
Creating	string
Deleted	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ClientState

Indicates if the client is enabled or not. Default value is Enabled.

Name	Type	Description
Disabled	string
Enabled	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via

Clients - Create Or Update

URI Parameters

Request Body

Responses

Examples

Clients_CreateOrUpdate

Sample Request

Sample Response

Definitions

Client

ClientCertificateAuthentication

ClientCertificateValidationScheme

ClientProvisioningState

ClientState

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

systemData

Additional resources