SignalR Custom Certificates - Create Or Update

Dienst:

SignalR Service

API-Version:

2024-03-01

Erstellen oder Aktualisieren eines benutzerdefinierten Zertifikats.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName}?api-version=2024-03-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
certificateName	path	True	string	Benutzerdefinierter Zertifikatname
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
resourceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$	Der Name der Ressource.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Media Types: "application/json", "text/json"

Name	Erforderlich	Typ	Beschreibung
properties.keyVaultBaseUri	True	string	Basis-URI des KeyVault-Schlüssels, der das Zertifikat speichert.
properties.keyVaultSecretName	True	string	Name des geheimen Zertifikats.
properties.keyVaultSecretVersion		string	Version des geheimen Zertifikats.

Antworten

Name	Typ	Beschreibung
200 OK	CustomCertificate	Erfolg. Die Antwort beschreibt das Zertifikat.
201 Created	CustomCertificate	Erstellt. Die Antwort beschreibt das Zertifikat.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

SignalRCustomCertificates_CreateOrUpdate

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SignalRService/signalR/mySignalRService/customCertificates/myCert?api-version=2024-03-01

{
  "properties": {
    "keyVaultBaseUri": "https://myvault.keyvault.azure.net/",
    "keyVaultSecretName": "mycert",
    "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432"
  }
}

Beispiel für eine Antwort

Statuscode:

200

{
  "properties": {
    "provisioningState": "Succeeded",
    "keyVaultBaseUri": "https://myvault.keyvault.azure.net/",
    "keyVaultSecretName": "mycert",
    "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert",
  "name": "myCert",
  "type": "Microsoft.SignalRService/SignalR/customCertificates"
}

Statuscode:

201

{
  "properties": {
    "provisioningState": "Succeeded",
    "keyVaultBaseUri": "https://myvault.keyvault.azure.net/",
    "keyVaultSecretName": "mycert",
    "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert",
  "name": "myCert",
  "type": "Microsoft.SignalRService/SignalR/customCertificates"
}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
CustomCertificate	Ein benutzerdefiniertes Zertifikat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ProvisioningState	Bereitstellungsstatus der Ressource.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

CustomCertificate

Objekt

Ein benutzerdefiniertes Zertifikat.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.keyVaultBaseUri	string	Basis-URI des KeyVault-Schlüssels, der das Zertifikat speichert.
properties.keyVaultSecretName	string	Name des geheimen Zertifikats.
properties.keyVaultSecretVersion	string	Version des geheimen Zertifikats.
properties.provisioningState	ProvisioningState	Bereitstellungsstatus der Ressource.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ProvisioningState

Enumeration

Bereitstellungsstatus der Ressource.

Wert	Beschreibung
Canceled
Creating
Deleting
Failed
Moving
Running
Succeeded
Unknown
Updating

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.