Create Api Key - Post

Servicio:

Marketplace Catalog

Versión de la API:

2023-01-01-preview

Genera una clave de API, concediéndole acceso a toda la gama de API del catálogo de Marketplace. Tenga en cuenta que esta API está actualmente en un estado de versión preliminar y requiere el registro en la característica de versión preliminar "Discovery Api Key Early Access" mediante una suscripción de Azure válida. Para obtener más información sobre este proceso, consulte la documentación de las API del catálogo de Marketplace aquí

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/keys/{apiKeyAlias}/create?api-version=2023-01-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
apiKeyAlias	path	True	string	Alias para la nueva clave de API. Este alias debe ser único y contener solo caracteres alfanuméricos separados por guiones.
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.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-tenant-id	True	string	Inquilino asociado a la suscripción.

Respuestas

Nombre	Tipo	Description
200 OK	ApiKey	Devuelve la clave de API recién creada.
Other Status Codes	ErrorResponse	Respuesta de error de Microsoft.Marketplace que describe por qué se produjo un error en la operación.

Ejemplos

Create_Key

Solicitud de ejemplo

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Marketplace/keys/key1/create?api-version=2023-01-01-preview

Respuesta de muestra

status code:

200

{
  "keyAlias": "keyName",
  "key": "keyValue"
}

Definiciones

Nombre	Description
ApiKey	Objeto ApiKey que contiene la clave y su alias.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error

ApiKey

Object

Objeto ApiKey que contiene la clave y su alias.

Nombre	Tipo	Description
key	string	Clave de API que se va a usar al llamar a los puntos de conexión de detección pertinentes.
keyAlias	string	Alias de clave de API.

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.