SignalR Custom Certificates - Create Or Update

Servicio:

SignalR Service

Versión de la API:

2024-03-01

Cree o actualice un certificado personalizado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
certificateName	path	True	string	Nombre del certificado personalizado
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
resourceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$	Nombre del recurso.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

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

Nombre	Requerido	Tipo	Description
properties.keyVaultBaseUri	True	string	URI base del almacén de claves que almacena el certificado.
properties.keyVaultSecretName	True	string	Nombre del secreto de certificado.
properties.keyVaultSecretVersion		string	Versión del secreto de certificado.

Respuestas

Nombre	Tipo	Description
200 OK	CustomCertificate	Éxito. La respuesta describe el certificado.
201 Created	CustomCertificate	Creado. La respuesta describe el certificado.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

SignalRCustomCertificates_CreateOrUpdate

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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

status code:

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

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
CustomCertificate	Un certificado personalizado.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ProvisioningState	Estado de aprovisionamiento del recurso.
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

CustomCertificate

Object

Un certificado personalizado.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso
properties.keyVaultBaseUri	string	URI base del almacén de claves que almacena el certificado.
properties.keyVaultSecretName	string	Nombre del secreto de certificado.
properties.keyVaultSecretVersion	string	Versión del secreto de certificado.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ProvisioningState

Enumeración

Estado de aprovisionamiento del recurso.

Valor	Description
Unknown
Succeeded
Failed
Canceled
Running
Creating
Updating
Deleting
Moving

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.