SignalR Custom Certificates - Create Or Update

Service:

SignalR Service

Version d'API:

2024-03-01

Créez ou mettez à jour un certificat personnalisé.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
certificateName	path	True	string	Nom de certificat personnalisé
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
resourceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$	Nom de la ressource.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

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

Nom	Obligatoire	Type	Description
properties.keyVaultBaseUri	True	string	URI de base du Coffre de clés qui stocke le certificat.
properties.keyVaultSecretName	True	string	Nom du secret du certificat.
properties.keyVaultSecretVersion		string	Version du secret du certificat.

Réponses

Nom	Type	Description
200 OK	CustomCertificate	Succès. La réponse décrit le certificat.
201 Created	CustomCertificate	Créé. La réponse décrit le certificat.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

SignalRCustomCertificates_CreateOrUpdate

Exemple de requête

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"
  }
}

Exemple de réponse

Code d’état:

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"
}

Code d’état:

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"
}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
CustomCertificate	Un certificat personnalisé.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ProvisioningState	État d’approvisionnement de la ressource.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

CustomCertificate

Object

Un certificat personnalisé.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.keyVaultBaseUri	string	URI de base du Coffre de clés qui stocke le certificat.
properties.keyVaultSecretName	string	Nom du secret du certificat.
properties.keyVaultSecretVersion	string	Version du secret du certificat.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ProvisioningState

Énumération

État d’approvisionnement de la ressource.

Valeur	Description
Unknown
Succeeded
Failed
Canceled
Running
Creating
Updating
Deleting
Moving

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.