Gateway Certificate Authority - Create Or Update
Weisen Sie die Zertifikatentität der Gatewayentität als Zertifizierungsstelle zu.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities/{certificateId}?api-version=2022-08-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
certificate
|
path | True |
string |
Bezeichner der Zertifikatentität. Muss im aktuellen API Management Dienst instance eindeutig sein. Regex pattern: |
gateway
|
path | True |
string |
Gatewayentitätsbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein. Darf nicht über den Wert "verwaltet" verfügen |
resource
|
path | True |
string |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
service
|
path | True |
string |
Der Name des API Management-Diensts. Regex pattern: |
subscription
|
path | True |
string |
Hierbei handelt es sich um die ID des Zielabonnements. |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
If-Match |
string |
ETag der Entität. Beim Erstellen einer Entität nicht erforderlich, aber beim Aktualisieren einer Entität erforderlich. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
properties.isTrusted |
boolean |
Bestimmt, ob die Zertifizierungsstelle vertrauenswürdig ist. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Details der Gatewayzertifizierungsstelle wurden erfolgreich aktualisiert Headers ETag: string |
|
201 Created |
Die Zertifikatentität wurde der Gatewayentität erfolgreich als Zertifizierungsstelle zugewiesen. Headers ETag: string |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
ApiManagementCreateGatewayCertificateAuthority
Sample Request
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
{
"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
}
}
{
"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
}
}
Definitionen
Name | Beschreibung |
---|---|
Error |
Fehlerfeldvertrag. |
Error |
Fehlerantwort. |
Gateway |
Details der Gatewayzertifizierungsstelle. |
ErrorFieldContract
Fehlerfeldvertrag.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode auf Eigenschaftsebene. |
message |
string |
Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene. |
target |
string |
Der Eigenschaftsname. |
ErrorResponse
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error.code |
string |
Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode. |
error.details |
Die Liste der ungültigen Felder, die im Falle eines Überprüfungsfehlers gesendet werden. |
|
error.message |
string |
Lesbare Darstellung des Fehlers. |
GatewayCertificateAuthorityContract
Details der Gatewayzertifizierungsstelle.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Der Name der Ressource |
properties.isTrusted |
boolean |
Bestimmt, ob die Zertifizierungsstelle vertrauenswürdig ist. |
type |
string |
Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |