Gateway Certificate Authority - Create Or Update
Tilldela certifikatentiteten till gatewayentiteten som certifikatutfärdare.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities/{certificateId}?api-version=2022-08-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
certificate
|
path | True |
string |
Identifierare för certifikatentiteten. Måste vara unikt i den aktuella API Management tjänstinstansen. Reguljärt uttrycksmönster: |
gateway
|
path | True |
string |
Gatewayentitetsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Får inte ha värdet "hanterat" |
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
service
|
path | True |
string |
Namnet på API Management-tjänsten. Reguljärt uttrycksmönster: |
subscription
|
path | True |
string |
ID för målprenumerationen. |
api-version
|
query | True |
string |
Den API-version som ska användas för den här åtgärden. |
Begärandehuvud
Name | Obligatorisk | Typ | Description |
---|---|---|---|
If-Match |
string |
ETag för entiteten. Krävs inte när du skapar en entitet, men krävs vid uppdatering av en entitet. |
Begärandetext
Name | Typ | Description |
---|---|---|
properties.isTrusted |
boolean |
Avgör om certifikatutfärdare är betrodd. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Information om gatewaycertifikatutfärdare har uppdaterats Sidhuvuden ETag: string |
|
201 Created |
Certifikatentiteten har tilldelats gatewayentiteten som certifikatutfärdare. Sidhuvuden ETag: string |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
ApiManagementCreateGatewayCertificateAuthority
Exempelbegäran
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
}
}
Exempelsvar
{
"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
}
}
Definitioner
Name | Description |
---|---|
Error |
Fel Fältkontrakt. |
Error |
Felsvar. |
Gateway |
Information om utfärdare av gatewaycertifikat. |
ErrorFieldContract
Fel Fältkontrakt.
Name | Typ | Description |
---|---|---|
code |
string |
Felkod på egenskapsnivå. |
message |
string |
Mänsklig läsbar representation av fel på egenskapsnivå. |
target |
string |
Egenskapsnamn. |
ErrorResponse
Felsvar.
Name | Typ | Description |
---|---|---|
error.code |
string |
Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret. |
error.details |
Listan över ogiltiga fält som skickas i begäran, om verifieringsfel uppstår. |
|
error.message |
string |
Mänsklig läsbar representation av felet. |
GatewayCertificateAuthorityContract
Information om utfärdare av gatewaycertifikat.
Name | Typ | Description |
---|---|---|
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Namnet på resursen |
properties.isTrusted |
boolean |
Avgör om certifikatutfärdare är betrodd. |
type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |