Certificates - Create Or Update

Tjänst:

IoT Hub

API-version:

2023-06-30

Ladda upp certifikatet till IoT-hubben.
Lägger till nytt eller ersätter befintligt certifikat.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}?api-version=2023-06-30

URI-parametrar

Name	I	Obligatorisk	Typ	Description
certificateName	path	True	string	Namnet på certifikatet Reguljärt uttrycksmönster: ^[A-Za-z0-9-._]{1,64}$
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller IoT-hubben.
resourceName	path	True	string	Namnet på IoT-hubben.
subscriptionId	path	True	string	Prenumerationsidentifieraren.
api-version	query	True	string	Versionen av API:et.

Begärandehuvud

Name	Obligatorisk	Typ	Description
If-Match		string	ETag för certifikatet. Ange inte för att skapa ett helt nytt certifikat. Krävs för att uppdatera ett befintligt certifikat.

Begärandetext

Name	Typ	Description
properties	CertificateProperties	Beskrivningen av ett X509 CA-certifikat.

Svar

Name	Typ	Description
200 OK	CertificateDescription	Om certifikatet redan finns och uppdateringen lyckades returnerar åtgärden HTTP-statuskoden 201 (OK).
201 Created	CertificateDescription	Om det inte fanns något certifikat som skapades returnerar åtgärden HTTP-statuskoden 201 (OK).
Other Status Codes	ErrorDetails	DefaultErrorResponse

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Certificates_CreateOrUpdate

Exempelbegäran

HTTP

PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/iothub/certificates/cert?api-version=2023-06-30

{
  "properties": {
    "certificate": "############################################"
  }
}

Java

import com.azure.resourcemanager.iothub.models.CertificateProperties;

/**
 * Samples for Certificates CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/
     * iothub_certificatescreateorupdate.json
     */
    /**
     * Sample code: Certificates_CreateOrUpdate.
     * 
     * @param manager Entry point to IotHubManager.
     */
    public static void certificatesCreateOrUpdate(com.azure.resourcemanager.iothub.IotHubManager manager) {
        manager.certificates().define("cert").withExistingIotHub("myResourceGroup", "iothub")
            .withProperties(new CertificateProperties().withCertificate("############################################"))
            .create();
    }
}

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.iothub import IotHubClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-iothub
# USAGE
    python iothub_certificatescreateorupdate.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 = IotHubClient(
        credential=DefaultAzureCredential(),
        subscription_id="91d12660-3dec-467a-be2a-213b5544ddc0",
    )

    response = client.certificates.create_or_update(
        resource_group_name="myResourceGroup",
        resource_name="iothub",
        certificate_name="cert",
        certificate_description={"properties": {"certificate": "############################################"}},
    )
    print(response)


# x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_certificatescreateorupdate.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 armiothub_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/iothub/armiothub"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/32c178f2467f792a322f56174be244135d2c907f/specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_certificatescreateorupdate.json
func ExampleCertificatesClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armiothub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCertificatesClient().CreateOrUpdate(ctx, "myResourceGroup", "iothub", "cert", armiothub.CertificateDescription{
		Properties: &armiothub.CertificateProperties{
			Certificate: to.Ptr("############################################"),
		},
	}, &armiothub.CertificatesClientCreateOrUpdateOptions{IfMatch: 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.CertificateDescription = armiothub.CertificateDescription{
	// 	Name: to.Ptr("cert"),
	// 	Type: to.Ptr("Microsoft.Devices/IotHubs/Certificates"),
	// 	Etag: to.Ptr("AAAAAAExpNs="),
	// 	ID: to.Ptr("/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServives/myFirstProvisioningService/certificates/cert"),
	// 	Properties: &armiothub.CertificateProperties{
	// 		Certificate: to.Ptr("############################################"),
	// 		Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC1123, "2017-10-12T19:23:50.000Z"); return t}()),
	// 		Expiry: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC1123, "2039-12-31T23:59:59.000Z"); return t}()),
	// 		IsVerified: to.Ptr(false),
	// 		Subject: to.Ptr("CN=testdevice1"),
	// 		Thumbprint: to.Ptr("97388663832D0393C9246CAB4FBA2C8677185A25"),
	// 		Updated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC1123, "2017-10-12T19:23:50.000Z"); return t}()),
	// 	},
	// }
}

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

/**
 * This sample demonstrates how to Adds new or replaces existing certificate.
 *
 * @summary Adds new or replaces existing certificate.
 * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_certificatescreateorupdate.json
 */
async function certificatesCreateOrUpdate() {
  const subscriptionId =
    process.env["IOTHUB_SUBSCRIPTION_ID"] || "91d12660-3dec-467a-be2a-213b5544ddc0";
  const resourceGroupName = process.env["IOTHUB_RESOURCE_GROUP"] || "myResourceGroup";
  const resourceName = "iothub";
  const certificateName = "cert";
  const certificateDescription = {
    properties: { certificate: "############################################" },
  };
  const credential = new DefaultAzureCredential();
  const client = new IotHubClient(credential, subscriptionId);
  const result = await client.certificates.createOrUpdate(
    resourceGroupName,
    resourceName,
    certificateName,
    certificateDescription
  );
  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.IotHub.Models;
using Azure.ResourceManager.IotHub;

// Generated from example definition: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_certificatescreateorupdate.json
// this example is just showing the usage of "Certificates_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 IotHubDescriptionResource created on azure
// for more information of creating IotHubDescriptionResource, please refer to the document of IotHubDescriptionResource
string subscriptionId = "91d12660-3dec-467a-be2a-213b5544ddc0";
string resourceGroupName = "myResourceGroup";
string resourceName = "iothub";
ResourceIdentifier iotHubDescriptionResourceId = IotHubDescriptionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, resourceName);
IotHubDescriptionResource iotHubDescription = client.GetIotHubDescriptionResource(iotHubDescriptionResourceId);

// get the collection of this IotHubCertificateDescriptionResource
IotHubCertificateDescriptionCollection collection = iotHubDescription.GetIotHubCertificateDescriptions();

// invoke the operation
string certificateName = "cert";
IotHubCertificateDescriptionData data = new IotHubCertificateDescriptionData()
{
    Properties = new IotHubCertificateProperties()
    {
        Certificate = BinaryData.FromString("\"############################################\""),
    },
};
ArmOperation<IotHubCertificateDescriptionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, certificateName, data);
IotHubCertificateDescriptionResource 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
IotHubCertificateDescriptionData 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

Exempelsvar

Statuskod:

201

{
  "properties": {
    "subject": "CN=testdevice1",
    "expiry": "Sat, 31 Dec 2039 23:59:59 GMT",
    "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25",
    "isVerified": false,
    "created": "Thu, 12 Oct 2017 19:23:50 GMT",
    "updated": "Thu, 12 Oct 2017 19:23:50 GMT",
    "certificate": "############################################"
  },
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServives/myFirstProvisioningService/certificates/cert",
  "name": "cert",
  "type": "Microsoft.Devices/IotHubs/Certificates",
  "etag": "AAAAAAExpNs="
}

Statuskod:

200

{
  "properties": {
    "subject": "CN=testdevice1",
    "expiry": "Sat, 31 Dec 2039 23:59:59 GMT",
    "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25",
    "isVerified": false,
    "created": "Thu, 12 Oct 2017 19:23:50 GMT",
    "updated": "Thu, 12 Oct 2017 19:23:50 GMT",
    "certificate": "############################################"
  },
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServives/myFirstProvisioningService/certificates/cert",
  "name": "cert",
  "type": "Microsoft.Devices/IotHubs/Certificates",
  "etag": "AAAAAAExpNs="
}

Definitioner

Name	Description
CertificateDescription	X509-certifikatet.
CertificateProperties	Beskrivningen av ett X509 CA-certifikat.
ErrorDetails	Felinformation.

CertificateDescription

X509-certifikatet.

Name	Typ	Description
etag	string	Entitetstaggen.
id	string	Resursidentifieraren.
name	string	Namnet på certifikatet.
properties	CertificateProperties	Beskrivningen av ett X509 CA-certifikat.
type	string	Resurstypen.

CertificateProperties

Beskrivningen av ett X509 CA-certifikat.

Name	Typ	Description
certificate	string	Certifikatinnehållet
created	string	Certifikatets skapa datum och tid.
expiry	string	Certifikatets förfallodatum och tid.
isVerified	boolean	Avgör om certifikatet har verifierats.
subject	string	Certifikatets ämnesnamn.
thumbprint	string	Certifikatets tumavtryck.
updated	string	Certifikatets senaste uppdateringsdatum och -tid.

ErrorDetails

Felinformation.

Name	Typ	Description
code	string	Felkoden.
details	string	Felinformationen.
httpStatusCode	string	HTTP-statuskoden.
message	string	Felmeddelandet.