Gateway - Update
Updates de details van de gateway die is opgegeven door de id.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}?api-version=2022-08-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
gateway
|
path | True |
string |
Gateway-entiteits-id. Moet uniek zijn in het huidige API Management service-exemplaar. Mag geen waarde 'beheerd' hebben |
resource
|
path | True |
string |
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig. |
service
|
path | True |
string |
De naam van de API Management service. Regex pattern: |
subscription
|
path | True |
string |
De id van het doelabonnement. |
api-version
|
query | True |
string |
De API-versie die voor deze bewerking moet worden gebruikt. |
Aanvraagkoptekst
Name | Vereist | Type | Description |
---|---|---|---|
If-Match | True |
string |
ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus uit het headerantwoord van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update. |
Aanvraagbody
Name | Type | Description |
---|---|---|
properties.description |
string |
Beschrijving van gateway |
properties.locationData |
Gatewaylocatie. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
De gatewaygegevens zijn bijgewerkt. Headers ETag: string |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | uw gebruikersaccount imiteren |
Voorbeelden
ApiManagementUpdateGateway
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1?api-version=2022-08-01
{
"properties": {
"description": "my gateway 1",
"locationData": {
"name": "my location"
}
}
}
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1",
"type": "Microsoft.ApiManagement/service/gateways",
"name": "a1",
"properties": {
"description": "my gateway 1",
"locationData": {
"name": "my location"
}
}
}
Definities
Name | Description |
---|---|
Error |
Fout Veldcontract. |
Error |
Foutreactie. |
Gateway |
Gatewaydetails. |
Resource |
Eigenschappen van resourcelocatiegegevens. |
ErrorFieldContract
Fout Veldcontract.
Name | Type | Description |
---|---|---|
code |
string |
Foutcode op eigenschapsniveau. |
message |
string |
Door mensen leesbare weergave van fout op eigenschapsniveau. |
target |
string |
Naam van eigenschap. |
ErrorResponse
Foutreactie.
Name | Type | Description |
---|---|---|
error.code |
string |
Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord. |
error.details |
De lijst met ongeldige velden verzenden in aanvraag, in het geval van een validatiefout. |
|
error.message |
string |
Door mensen leesbare weergave van de fout. |
GatewayContract
Gatewaydetails.
Name | Type | Description |
---|---|---|
id |
string |
Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
De naam van de resource |
properties.description |
string |
Beschrijving van gateway |
properties.locationData |
Gatewaylocatie. |
|
type |
string |
Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' |
ResourceLocationDataContract
Eigenschappen van resourcelocatiegegevens.
Name | Type | Description |
---|---|---|
city |
string |
De plaats of plaats waar de resource zich bevindt. |
countryOrRegion |
string |
Het land of de regio waar de resource zich bevindt. |
district |
string |
Het district, de staat of de provincie waar de resource zich bevindt. |
name |
string |
Een canonieke naam voor de geografische of fysieke locatie. |