Gateway Certificate Authority - Create Or Update

Service:

API Management

Version d'API:

2024-05-01

Attribuez une entité de certificat à l’entité de passerelle en tant qu’autorité de certification.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
certificateId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificateur de l’entité de certificat. Doit être unique dans l’instance actuelle du service Gestion des API.
gatewayId	path	True	string minLength: 1 maxLength: 80	Identificateur d’entité de passerelle. Doit être unique dans l’instance actuelle du service Gestion des API. Ne doit pas avoir la valeur 'managed'
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nom du service Gestion des API.
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.

En-tête de la demande

Nom	Obligatoire	Type	Description
If-Match		string	ETag de l’entité. Non obligatoire lors de la création d’une entité, mais obligatoire lors de la mise à jour d’une entité.

Corps de la demande

Nom	Type	Description
properties.isTrusted	boolean	Détermine si l’autorité de certification est approuvée.

Réponses

Nom	Type	Description
200 OK	GatewayCertificateAuthorityContract	Les détails de l’autorité de certification de passerelle ont été mis à jour avec succès En-têtes ETag: string
201 Created	GatewayCertificateAuthorityContract	L’entité de certificat a été affectée à l’entité de passerelle en tant qu’autorité de certification. En-têtes ETag: string
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

ApiManagementCreateGatewayCertificateAuthority

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1?api-version=2024-05-01

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

Exemple de réponse

Code d’état:

201

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

Code d’état:

200

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

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
GatewayCertificateAuthorityContract	Détails de l’autorité de certification de passerelle.

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.

GatewayCertificateAuthorityContract

Object

Détails de l’autorité de certification de passerelle.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nom de la ressource
properties.isTrusted	boolean	Détermine si l’autorité de certification est approuvée.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »