Gateway Certificate Authority - Create Or Update

Service:

API Management

API Version:

2022-08-01

Asigne la entidad Certificate a la entidad de puerta de enlace como entidad de certificación.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities/{certificateId}?api-version=2022-08-01

Parámetros de identificador URI

Name	In	Required	Type	Description
certificateId	path	True	string	Identificador de la entidad de certificado. Debe ser único en la instancia de servicio API Management actual. Regex pattern: ^[^*#&+:<>?]+$
gatewayId	path	True	string	Identificador de entidad de puerta de enlace. Debe ser único en la instancia de servicio API Management actual. No debe tener el valor "administrado".
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serviceName	path	True	string	Nombre del servicio API Management. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Encabezado de la solicitud

Name	Required	Type	Description
If-Match		string	ETag de la entidad. No es necesario al crear una entidad, pero es necesario al actualizar una entidad.

Cuerpo de la solicitud

Name	Type	Description
properties.isTrusted	boolean	Determina si la entidad de certificación es de confianza.

Respuestas

Name	Type	Description
200 OK	GatewayCertificateAuthorityContract	Los detalles de la entidad de certificación de puerta de enlace se actualizaron correctamente Headers ETag: string
201 Created	GatewayCertificateAuthorityContract	La entidad de certificado se asignó correctamente a la entidad de puerta de enlace como entidad de certificación. Headers ETag: string
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ApiManagementCreateGatewayCertificateAuthority

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1?api-version=2022-08-01

{
  "properties": {
    "isTrusted": false
  }
}

Sample Response

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1",
  "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities",
  "name": "cert1",
  "properties": {
    "isTrusted": false
  }
}

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1",
  "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities",
  "name": "cert1",
  "properties": {
    "isTrusted": false
  }
}

Definiciones

ErrorFieldContract	Contrato de campo de error.
ErrorResponse	Respuesta de error.
GatewayCertificateAuthorityContract	Detalles de la entidad de certificación de puerta de enlace.

ErrorFieldContract

Contrato de campo de error.

Name	Type	Description
code	string	Código de error de nivel de propiedad.
message	string	Representación legible del error de nivel de propiedad.
target	string	Nombre de propiedad.

ErrorResponse

Respuesta de error.

Name	Type	Description
error.code	string	Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta.
error.details	ErrorFieldContract[]	La lista de campos no válidos que se envían en la solicitud, en caso de error de validación.
error.message	string	Representación legible del error.

GatewayCertificateAuthorityContract

Detalles de la entidad de certificación de puerta de enlace.

Name	Type	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso.
properties.isTrusted	boolean	Determina si la entidad de certificación es de confianza.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"