Api Gateway - Create Or Update

Servizio:: API Management

Versione API:: 2024-05-01

Crea o aggiorna un gateway di Gestione API. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
gatewayName	path	True	string minLength: 1 maxLength: 45 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nome del gateway di Gestione API.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
location	True	string	Percorso della risorsa.
sku	True	ApiManagementGatewaySkuProperties	Proprietà SKU del gateway di Gestione API.
properties.backend		BackendConfiguration	Informazioni sul modo in cui il gateway deve integrarsi con i sistemi back-end.
properties.configurationApi		GatewayConfigurationApi	Informazioni sull'API di configurazione del gateway di Gestione API. Questo è applicabile solo per il gateway API con SKU Standard.
properties.frontend		FrontendConfiguration	Informazioni sulla modalità di esposizione del gateway.
properties.virtualNetworkType		VirtualNetworkType	Tipo di VPN in cui deve essere configurato il gateway di Gestione API.
tags		object	Tag di risorsa.

Risposte

Nome	Tipo	Descrizione
200 OK	ApiManagementGatewayResource	Il gateway è stato configurato correttamente.
201 Created	ApiManagementGatewayResource	Creato
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementCreateStandardGateway

ApiManagementCreateWorkspacePremiumGateway

ApiManagementCreateStandardGateway

Esempio di richiesta

HTTP

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

{
  "properties": {
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    }
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "location": "South Central US",
  "tags": {
    "Name": "Contoso",
    "Test": "User"
  }
}

Risposta di esempio

Codice di stato:: 201

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1",
  "name": "apimGateway1",
  "type": "Microsoft.ApiManagement/gateway",
  "tags": {
    "api-version": "2024-05-01"
  },
  "location": "East US",
  "etag": "AAAAAAAmRAM=",
  "properties": {
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    }
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2022-07-11T18:41:00.9390609Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
  }
}

Codice di stato:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1",
  "name": "apimGateway1",
  "type": "Microsoft.ApiManagement/gateways",
  "tags": {
    "api-version": "2024-05-01"
  },
  "location": "East US",
  "etag": "AAAAAAAmREI=",
  "properties": {
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "frontend": {
      "defaultHostname": "apimGateway1.eastus.gateway.azure-api.net"
    },
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    },
    "configurationApi": {
      "hostname": "apimGateway1.eastus.configuration.gateway.azure-api.net"
    }
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2022-07-11T18:41:00.9390609Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
  }
}

ApiManagementCreateWorkspacePremiumGateway

Esempio di richiesta

HTTP

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

{
  "properties": {
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "WorkspaceGatewayPremium",
    "capacity": 1
  },
  "location": "South Central US",
  "tags": {
    "Name": "Contoso",
    "Test": "User"
  }
}

Risposta di esempio

Codice di stato:: 201

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1",
  "name": "apimGateway1",
  "type": "Microsoft.ApiManagement/gateway",
  "tags": {
    "api-version": "2024-05-01"
  },
  "location": "East US",
  "etag": "AAAAAAAmRAM=",
  "properties": {
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "WorkspaceGatewayPremium",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2022-07-11T18:41:00.9390609Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
  }
}

Codice di stato:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1",
  "name": "apimGateway1",
  "type": "Microsoft.ApiManagement/gateways",
  "tags": {
    "api-version": "2024-05-01"
  },
  "location": "East US",
  "etag": "AAAAAAAmREI=",
  "properties": {
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "WorkspaceGatewayPremium",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2022-07-11T18:41:00.9390609Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
  }
}

Definizioni

Nome	Descrizione
ApiGatewaySkuType	Nome dello SKU.
ApiManagementGatewayResource	Una singola risorsa del gateway di Gestione API in Elenco o Ottieni risposta.
ApiManagementGatewaySkuProperties	Proprietà dello SKU delle risorse del gateway di Gestione API.
BackendConfiguration	Informazioni sul modo in cui il gateway deve integrarsi con i sistemi back-end.
BackendSubnetConfiguration	Informazioni su come inserire il gateway nella subnet.
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
FrontendConfiguration	Informazioni sulla modalità di esposizione del gateway.
GatewayConfigurationApi	Informazioni sull'API di configurazione del gateway di Gestione API. Questo è applicabile solo per il gateway API con SKU Standard.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
VirtualNetworkType	Tipo di VPN in cui deve essere configurato il gateway di Gestione API.

ApiGatewaySkuType

Enumerazione

Nome dello SKU.

Valore	Descrizione
Standard	SKU standard del gateway API.
WorkspaceGatewayStandard	SKU standard del gateway API da usare nelle aree di lavoro.
WorkspaceGatewayPremium	SKU Premium del gateway API da usare nelle aree di lavoro.

ApiManagementGatewayResource

Object

Una singola risorsa del gateway di Gestione API in Elenco o Ottieni risposta.

Nome	Tipo	Descrizione
etag	string	ETag della risorsa.
id	string	ID risorsa.
location	string	Percorso della risorsa.
name	string	Nome risorsa.
properties.backend	BackendConfiguration	Informazioni sul modo in cui il gateway deve integrarsi con i sistemi back-end.
properties.configurationApi	GatewayConfigurationApi	Informazioni sull'API di configurazione del gateway di Gestione API. Questo è applicabile solo per il gateway API con SKU Standard.
properties.createdAtUtc	string (date-time)	Data UTC di creazione del gateway di Gestione API. La data è conforme al formato seguente: `yyyy-MM-ddTHH:mm:ssZ` come specificato dallo standard ISO 8601.
properties.frontend	FrontendConfiguration	Informazioni sulla modalità di esposizione del gateway.
properties.provisioningState	string	Stato di provisioning corrente del gateway di Gestione API, che può essere uno dei seguenti: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
properties.targetProvisioningState	string	Stato di provisioning del gateway di Gestione API, destinato all'operazione a esecuzione prolungata avviata nel gateway.
properties.virtualNetworkType	VirtualNetworkType	Tipo di VPN in cui deve essere configurato il gateway di Gestione API.
sku	ApiManagementGatewaySkuProperties	Proprietà SKU del gateway di Gestione API.
systemData	systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
tags	object	Tag di risorsa.
type	string	Il tipo di risorsa di Gestione API è impostato su Microsoft.ApiManagement.

ApiManagementGatewaySkuProperties

Object

Proprietà dello SKU delle risorse del gateway di Gestione API.

Nome	Tipo	Descrizione
capacity	integer (int32)	Capacità dello SKU (numero di unità distribuite dello SKU)
name	ApiGatewaySkuType	Nome dello SKU.

BackendConfiguration

Object

Informazioni sul modo in cui il gateway deve integrarsi con i sistemi back-end.

Nome	Tipo	Descrizione
subnet	BackendSubnetConfiguration	Nome host predefinito del gateway del piano dati a cui è possibile inviare le richieste.

BackendSubnetConfiguration

Object

Informazioni su come inserire il gateway nella subnet.

Nome	Tipo	Descrizione
id	string	ID ARM della subnet in cui sono ospitati i sistemi back-end.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

FrontendConfiguration

Object

Informazioni sulla modalità di esposizione del gateway.

Nome	Tipo	Descrizione
defaultHostname	string	Nome host predefinito del gateway del piano dati a cui è possibile inviare le richieste. Questo è applicabile solo per il gateway API con SKU Standard.

GatewayConfigurationApi

Object

Informazioni sull'API di configurazione del gateway di Gestione API. Questo è applicabile solo per il gateway API con SKU Standard.

Nome	Tipo	Descrizione
hostname	string	Nome host a cui l'agente si connette per propagare la configurazione al cloud.

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

VirtualNetworkType

Enumerazione

Tipo di VPN in cui deve essere configurato il gateway di Gestione API.

Valore	Descrizione
None	Il gateway di Gestione API non fa parte di alcuna rete virtuale.
External	Il gateway di Gestione API fa parte della rete virtuale ed è accessibile da Internet.
Internal	Il gateway di Gestione API fa parte della rete virtuale ed è accessibile solo dall'interno della rete virtuale.

Condividi tramite

Api Gateway - Create Or Update

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

ApiManagementCreateStandardGateway

Esempio di richiesta

Risposta di esempio

ApiManagementCreateWorkspacePremiumGateway

Esempio di richiesta

Risposta di esempio

Definizioni

ApiGatewaySkuType

ApiManagementGatewayResource

ApiManagementGatewaySkuProperties

BackendConfiguration

BackendSubnetConfiguration

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FrontendConfiguration

GatewayConfigurationApi

systemData

VirtualNetworkType