Api Gateway - Create Or Update

Serviço:: API Management

Versão da API:: 2024-05-01

Cria ou atualiza um gateway de Gerenciamento de API. Esta é uma operação de longa duração e pode levar vários minutos para ser concluída.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
gatewayName	path	True	string minLength: 1 maxLength: 45 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do gateway de Gerenciamento de API.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
location	True	string	Localização do recurso.
sku	True	ApiManagementGatewaySkuProperties	Propriedades SKU do gateway de Gerenciamento de API.
properties.backend		BackendConfiguration	Informações sobre como o gateway deve se integrar aos sistemas de back-end.
properties.configurationApi		GatewayConfigurationApi	Informações sobre a API de configuração do gateway de gerenciamento de API. Isso só é aplicável para gateway de API com SKU padrão.
properties.frontend		FrontendConfiguration	Informações sobre a forma como o portal deve ser exposto.
properties.virtualNetworkType		VirtualNetworkType	O tipo de VPN no qual o gateway de Gerenciamento de API precisa ser configurado.
tags		object	Tags de recursos.

Respostas

Name	Tipo	Description
200 OK	ApiManagementGatewayResource	O gateway foi configurado com êxito.
201 Created	ApiManagementGatewayResource	Criado
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

ApiManagementCreateStandardGateway

ApiManagementCreateWorkspacePremiumGateway

ApiManagementCreateStandardGateway

Pedido de amostra

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"
  }
}

Resposta da amostra

Código de estado:: 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"
  }
}

Código de estado:: 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

Pedido de amostra

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"
  }
}

Resposta da amostra

Código de estado:: 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"
  }
}

Código de estado:: 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"
  }
}

Definições

Name	Description
ApiGatewaySkuType	Nome do Sku.
ApiManagementGatewayResource	Um único recurso de gateway de Gerenciamento de API em Listar ou Obter resposta.
ApiManagementGatewaySkuProperties	Propriedades SKU do recurso do gateway de gerenciamento de API.
BackendConfiguration	Informações sobre como o gateway deve se integrar aos sistemas de back-end.
BackendSubnetConfiguration	Informações sobre como a sub-rede na qual o gateway deve ser injetado.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
FrontendConfiguration	Informações sobre a forma como o portal deve ser exposto.
GatewayConfigurationApi	Informações sobre a API de configuração do gateway de gerenciamento de API. Isso só é aplicável para gateway de API com SKU padrão.
systemData	Metadados referentes à criação e última modificação do recurso.
VirtualNetworkType	O tipo de VPN no qual o gateway de Gerenciamento de API precisa ser configurado.

ApiGatewaySkuType

Enumeração

Nome do Sku.

Valor	Description
Standard	SKU padrão do gateway de API.
WorkspaceGatewayStandard	SKU padrão do gateway de API a ser usado em espaços de trabalho.
WorkspaceGatewayPremium	SKU Premium do gateway de API a ser usado em espaços de trabalho.

ApiManagementGatewayResource

Object

Um único recurso de gateway de Gerenciamento de API em Listar ou Obter resposta.

Name	Tipo	Description
etag	string	ETag do recurso.
id	string	ID do recurso.
location	string	Localização do recurso.
name	string	Nome do recurso.
properties.backend	BackendConfiguration	Informações sobre como o gateway deve se integrar aos sistemas de back-end.
properties.configurationApi	GatewayConfigurationApi	Informações sobre a API de configuração do gateway de gerenciamento de API. Isso só é aplicável para gateway de API com SKU padrão.
properties.createdAtUtc	string (date-time)	Data UTC de criação do gateway de Gerenciamento de API. A data está em conformidade com o seguinte formato: `yyyy-MM-ddTHH:mm:ssZ` conforme especificado pela norma ISO 8601.
properties.frontend	FrontendConfiguration	Informações sobre a forma como o portal deve ser exposto.
properties.provisioningState	string	O estado de provisionamento atual do gateway de Gerenciamento de API, que pode ser um dos seguintes: Criado/Ativando/Bem-sucedido/Atualizando/Falhado/Parado/Terminando/TerminaçãoFalhou/Excluído.
properties.targetProvisioningState	string	O estado de provisionamento do gateway de Gerenciamento de API, que é direcionado pela operação de longa duração iniciada no gateway.
properties.virtualNetworkType	VirtualNetworkType	O tipo de VPN no qual o gateway de Gerenciamento de API precisa ser configurado.
sku	ApiManagementGatewaySkuProperties	Propriedades SKU do gateway de Gerenciamento de API.
systemData	systemData	Metadados referentes à criação e última modificação do recurso.
tags	object	Tags de recursos.
type	string	O tipo de recurso para o recurso de Gerenciamento de API é definido como Microsoft.ApiManagement.

ApiManagementGatewaySkuProperties

Object

Propriedades SKU do recurso do gateway de gerenciamento de API.

Name	Tipo	Description
capacity	integer (int32)	Capacidade do SKU (número de unidades implantadas do SKU)
name	ApiGatewaySkuType	Nome do Sku.

BackendConfiguration

Object

Informações sobre como o gateway deve se integrar aos sistemas de back-end.

Name	Tipo	Description
subnet	BackendSubnetConfiguration	O nome de host padrão do gateway do plano de dados para o qual as solicitações podem ser enviadas.

BackendSubnetConfiguration

Object

Informações sobre como a sub-rede na qual o gateway deve ser injetado.

Name	Tipo	Description
id	string	O ARM ID da sub-rede na qual os sistemas de back-end estão hospedados.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

FrontendConfiguration

Object

Informações sobre a forma como o portal deve ser exposto.

Name	Tipo	Description
defaultHostname	string	O nome de host padrão do gateway do plano de dados para o qual as solicitações podem ser enviadas. Isso só é aplicável para gateway de API com SKU padrão.

GatewayConfigurationApi

Object

Informações sobre a API de configuração do gateway de gerenciamento de API. Isso só é aplicável para gateway de API com SKU padrão.

Name	Tipo	Description
hostname	string	Nome do host ao qual o agente se conecta para propagar a configuração para a nuvem.

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

VirtualNetworkType

Enumeração

O tipo de VPN no qual o gateway de Gerenciamento de API precisa ser configurado.

Valor	Description
None	O gateway de Gerenciamento de API não faz parte de nenhuma Rede Virtual.
External	O gateway de Gerenciamento de API faz parte da Rede Virtual e pode ser acessado pela Internet.
Internal	O gateway de Gerenciamento de API faz parte da Rede Virtual e só é acessível de dentro da rede virtual.

Partilhar via

Api Gateway - Create Or Update

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

ApiManagementCreateStandardGateway

Pedido de amostra

Resposta da amostra

ApiManagementCreateWorkspacePremiumGateway

Pedido de amostra

Resposta da amostra

Definições

ApiGatewaySkuType

ApiManagementGatewayResource

ApiManagementGatewaySkuProperties

BackendConfiguration

BackendSubnetConfiguration

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FrontendConfiguration

GatewayConfigurationApi

systemData

VirtualNetworkType