Api Management Service - Update

Serviço:: API Management

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

Atualiza um serviço de Gerenciamento de API existente.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do serviço de Gerenciamento de API.
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	Tipo	Description
identity	ApiManagementServiceIdentity	Identidade de serviço gerenciado do serviço de Gerenciamento de Api.
properties.additionalLocations	AdditionalLocation[]	Locais de datacenter adicionais do serviço de Gerenciamento de API.
properties.apiVersionConstraint	ApiVersionConstraint	Restrição de versão da Apis do Plano de Controle para o serviço de Gerenciamento de API.
properties.certificates	CertificateConfiguration[]	Lista de certificados que precisam ser instalados no serviço de gerenciamento de API. O máximo de certificados suportados que podem ser instalados é 10.
properties.configurationApi	ConfigurationApi	Configuração da API do serviço de Gerenciamento de API.
properties.customProperties	object	Propriedades personalizadas do serviço de Gerenciamento de API. Configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` desativará o TLS_RSA_WITH_3DES_EDE_CBC_SHA de codificação para todos os TLS(1.0, 1.1 e 1.2). Configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` pode ser usada para desativar apenas o TLS 1.1. Configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` pode ser usada para desabilitar o TLS 1.0 em um serviço de Gerenciamento de API. Configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` pode ser usada para desativar apenas o TLS 1.1 para comunicações com back-ends. Configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` pode ser usada para desativar o TLS 1.0 para comunicações com back-ends. Configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` pode ser usada para habilitar o protocolo HTTP2 em um serviço de Gerenciamento de API. Não especificar nenhuma dessas propriedades na operação PATCH redefinirá os valores das propriedades omitidas para seus padrões. Para todas as configurações, exceto Http2, o valor padrão é `True` se o serviço tiver sido criado em ou antes de 1º de abril de 2018 e `False` contrário. O valor padrão da configuração Http2 é `False`. Você pode desativar qualquer uma das seguintes cifras usando as configurações `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA. Por exemplo, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. O valor padrão é `true` para eles. Nota: As seguintes cifras não podem ser desativadas, pois são exigidas pelos componentes internos da plataforma: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
properties.developerPortalStatus	developerPortalStatus	Status do portal do desenvolvedor neste serviço de Gerenciamento de API.
properties.disableGateway	boolean	Propriedade válida apenas para um serviço de Gerenciamento de Api implantado em vários locais. Isso pode ser usado para desabilitar o gateway na região mestre.
properties.enableClientCertificate	boolean	Propriedade destinada apenas a ser usada para o Serviço de SKU de Consumo. Isso impõe um certificado de cliente a ser apresentado em cada solicitação ao gateway. Isso também permite a capacidade de autenticar o certificado na política no gateway.
properties.hostnameConfigurations	HostnameConfiguration[]	Configuração personalizada de nome de host do serviço de Gerenciamento de API.
properties.legacyPortalStatus	LegacyPortalStatus	Status do portal herdado no serviço de Gerenciamento de API.
properties.natGatewayState	NatGatewayState	A propriedade pode ser usada para habilitar o NAT Gateway para este serviço de Gerenciamento de API.
properties.notificationSenderEmail	string maxLength: 100	Endereço de e-mail a partir do qual a notificação será enviada.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]	Lista de Conexões de Ponto Final Privadas deste serviço.
properties.publicIpAddressId	string	Endereço IP baseado em SKU IP V4 padrão público a ser associado ao serviço implantado na Rede Virtual na região. Suportado apenas para Developer e Premium SKU sendo implantado na Rede Virtual.
properties.publicNetworkAccess	PublicNetworkAccess	Se o acesso ao ponto de extremidade público é permitido ou não para este serviço de Gerenciamento de API. O valor é opcional, mas se passado, deve ser 'Ativado' ou 'Desativado'. Se 'Desativado', os pontos finais privados são o método de acesso exclusivo. O valor padrão é 'Enabled'
properties.publisherEmail	string maxLength: 100	E-mail do editor.
properties.publisherName	string maxLength: 100	Nome do editor.
properties.restore	boolean	Cancele a exclusão do Serviço de Gerenciamento de Api se ele tiver sido excluído anteriormente por software. Se esse sinalizador for especificado e definido como True, todas as outras propriedades serão ignoradas.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration	Configuração de rede virtual do serviço de Gerenciamento de API.
properties.virtualNetworkType	VirtualNetworkType	O tipo de VPN no qual o serviço de Gerenciamento de API precisa ser configurado. Nenhum (Valor Padrão) significa que o serviço de Gerenciamento de API não faz parte de nenhuma Rede Virtual, Externo significa que a implantação do Gerenciamento de API é configurada dentro de uma Rede Virtual com um Ponto de Extremidade voltado para a Internet e Interno significa que a implantação do Gerenciamento de API é configurada dentro de uma Rede Virtual com um Ponto de Extremidade Voltado para a Intranet apenas.
sku	ApiManagementServiceSkuProperties	Propriedades de SKU do serviço de Gerenciamento de API.
tags	object	Tags de recursos.
zones	string[]	Uma lista de zonas de disponibilidade indicando de onde o recurso precisa vir.

Respostas

Name	Tipo	Description
200 OK	ApiManagementServiceResource	O serviço foi atualizado com sucesso.
202 Accepted		A solicitação de atualização de serviço foi aceita. Cabeçalhos location: string
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Name

Tipo

Description

200 OK

ApiManagementServiceResource

O serviço foi atualizado com sucesso.

202 Accepted

A solicitação de atualização de serviço foi aceita.

Cabeçalhos

location: string

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

ApiManagementUpdateServiceDisableTls10

ApiManagementUpdateServicePublisherDetails

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

ApiManagementUpdateServiceDisableTls10

Pedido de amostra

HTTP

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

{
  "properties": {
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false"
    }
  }
}

Resposta da amostra

Código de estado:: 202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/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/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse

Código de estado:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "sasolank",
    "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3",
    "Reserved": "",
    "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT",
    "Pool": "Manual",
    "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT"
  },
  "location": "West US",
  "etag": "AAAAAAAYRPs=",
  "properties": {
    "publisherEmail": "admin@live.com",
    "publisherName": "Contoso",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2017-06-29T17:50:42.3191122Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [],
    "publicIPAddresses": [
      "40.86.176.232"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False"
    },
    "virtualNetworkType": "None"
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  }
}

ApiManagementUpdateServicePublisherDetails

Pedido de amostra

HTTP

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

{
  "properties": {
    "publisherEmail": "foobar@live.com",
    "publisherName": "Contoso Vnext"
  }
}

Resposta da amostra

Código de estado:: 202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/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/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse

Código de estado:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "sasolank",
    "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3",
    "Reserved": "",
    "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT",
    "Pool": "Manual",
    "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT"
  },
  "location": "West US",
  "etag": "AAAAAAAYRPs=",
  "properties": {
    "publisherEmail": "foobar@live.com",
    "publisherName": "Contoso Vnext",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2017-06-29T17:50:42.3191122Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [],
    "publicIPAddresses": [
      "40.86.176.232"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False"
    },
    "virtualNetworkType": "None"
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  }
}

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

Pedido de amostra

HTTP

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

{
  "properties": {
    "additionalLocations": [
      {
        "location": "Australia East",
        "sku": {
          "name": "Premium",
          "capacity": 3
        },
        "zones": [
          "1",
          "2",
          "3"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"
        },
        "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip"
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"
    },
    "virtualNetworkType": "External",
    "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east"
  },
  "sku": {
    "name": "Premium",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ]
}

Resposta da amostra

Código de estado:: 202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/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/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse

Código de estado:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "location": "Japan East",
  "etag": "AAAAAAAWBIU=",
  "properties": {
    "publisherEmail": "contoso@microsoft.com",
    "publisherName": "apimPublisher",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2021-04-08T23:41:35.6447381Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-japaneast-01.regional.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false,
        "certificateSource": "BuiltIn"
      },
      {
        "type": "Proxy",
        "hostName": "mycustomdomain.int-azure-api.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2022-06-09T23:59:59+00:00",
          "thumbprint": "2994B5FFB8F76B3C687D324A8DEE0432C1ED18CD",
          "subject": "CN=mycustomdomain.int-azure-api.net"
        },
        "defaultSslBinding": true,
        "certificateSource": "Managed"
      }
    ],
    "publicIPAddresses": [
      "20.78.248.217"
    ],
    "additionalLocations": [
      {
        "location": "Australia East",
        "sku": {
          "name": "Premium",
          "capacity": 3
        },
        "zones": [
          "1",
          "2",
          "3"
        ],
        "publicIPAddresses": [
          "20.213.1.35"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"
        },
        "gatewayRegionalUrl": "https://apimService1-australiaeast-01.regional.azure-api.net",
        "disableGateway": false,
        "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip",
        "platformVersion": "stv2"
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"
    },
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false"
    },
    "virtualNetworkType": "Internal",
    "disableGateway": false,
    "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east",
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ],
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-01-21T20:04:21.6108974Z"
  }
}

Definições

Name	Description
AdditionalLocation	Descrição de um local de recurso adicional de Gerenciamento de API.
ApiManagementServiceIdentity	Propriedades de identidade do recurso de serviço Gerenciamento de Api.
ApiManagementServiceResource	Um único recurso de serviço de Gerenciamento de API em Listar ou Obter resposta.
ApiManagementServiceSkuProperties	Propriedades SKU do recurso de serviço de Gerenciamento de API.
ApiManagementServiceUpdateParameters	Parâmetro fornecido ao Update Api Management Service.
ApimIdentityType	O tipo de identidade usado para o recurso. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do serviço.
ApiVersionConstraint	Restrição de versão da Apis do Plano de Controle para o serviço de Gerenciamento de API.
ArmIdWrapper	Um wrapper para um ID de recurso ARM
CertificateConfiguration	Configuração de certificado que consiste em intermediários não confiáveis e certificados raiz.
CertificateInformation	Informações do certificado SSL.
CertificateSource	Origem do certificado.
CertificateStatus	Status do certificado.
ConfigurationApi	Informações sobre a API de configuração do serviço de Gerenciamento de API.
createdByType	O tipo de identidade que criou o recurso.
developerPortalStatus	Status do portal do desenvolvedor neste serviço de Gerenciamento de API.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
HostnameConfiguration	Configuração personalizada do nome do host.
HostnameType	Tipo de nome de host.
LegacyApiState	Indicação se a API de configuração herdada (v1) deve ou não ser exposta no serviço de Gerenciamento de API. O valor é opcional, mas deve ser 'Ativado' ou 'Desativado'. Se 'Desabilitada', a API de configuração herdada (v1) não estará disponível para gateways auto-hospedados. O valor padrão é 'Enabled'
LegacyPortalStatus	Status do portal herdado no serviço de Gerenciamento de API.
NatGatewayState	A propriedade pode ser usada para habilitar o NAT Gateway para este serviço de Gerenciamento de API.
PlatformVersion	Versão da plataforma de computação executando o serviço.
PrivateEndpointServiceConnectionStatus	O status da conexão de ponto de extremidade privado.
PrivateLinkServiceConnectionState	Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.
PublicNetworkAccess	Se o acesso ao ponto de extremidade público é permitido ou não para este serviço de Gerenciamento de API. O valor é opcional, mas se passado, deve ser 'Ativado' ou 'Desativado'. Se 'Desativado', os pontos finais privados são o método de acesso exclusivo. O valor padrão é 'Enabled'
RemotePrivateEndpointConnectionWrapper	Recurso de Conexão de Ponto Final Privado Remoto.
SkuType	Nome do Sku.
systemData	Metadados referentes à criação e última modificação do recurso.
UserIdentityProperties
VirtualNetworkConfiguration	Configuração de uma rede virtual na qual o serviço de Gerenciamento de API é implantado.
VirtualNetworkType	O tipo de VPN no qual o serviço de Gerenciamento de API precisa ser configurado. Nenhum (Valor Padrão) significa que o serviço de Gerenciamento de API não faz parte de nenhuma Rede Virtual, Externo significa que a implantação do Gerenciamento de API é configurada dentro de uma Rede Virtual com um Ponto de Extremidade voltado para a Internet e Interno significa que a implantação do Gerenciamento de API é configurada dentro de uma Rede Virtual com um Ponto de Extremidade Voltado para a Intranet apenas.

AdditionalLocation

Object

Descrição de um local de recurso adicional de Gerenciamento de API.

Name	Tipo	Default value	Description
disableGateway	boolean	False	Propriedade válida apenas para um serviço de Gerenciamento de Api implantado em vários locais. Isso pode ser usado para desabilitar o gateway nesse local adicional.
gatewayRegionalUrl	string		URL do gateway do serviço de Gerenciamento de API na Região.
location	string		O nome do local da região adicional entre as regiões do Data Center do Azure.
natGatewayState	NatGatewayState	Disabled	A propriedade pode ser usada para habilitar o NAT Gateway para este serviço de Gerenciamento de API.
outboundPublicIPAddresses	string[]		Prefixos de endereço IPV4 público de saída associados ao serviço implantado do Gateway NAT. Disponível apenas para SKU Premium na plataforma stv2.
platformVersion	PlatformVersion		Versão da plataforma de computação executando o serviço.
privateIPAddresses	string[]		Endereços IP privados com balanceamento de carga estática do serviço de Gerenciamento de API que é implantado em uma Rede Virtual Interna em um local adicional específico. Disponível apenas para SKU Básico, Standard, Premium e Isolado.
publicIPAddresses	string[]		Endereços IP públicos com balanceamento de carga estática do serviço de Gerenciamento de API no local adicional. Disponível apenas para SKU Básico, Standard, Premium e Isolado.
publicIpAddressId	string		Endereço IP baseado em SKU IP V4 padrão público a ser associado ao serviço implantado de Rede Virtual no local. Suportado apenas para SKU Premium sendo implantado na Rede Virtual.
sku	ApiManagementServiceSkuProperties		Propriedades de SKU do serviço de Gerenciamento de API.
virtualNetworkConfiguration	VirtualNetworkConfiguration		Configuração de rede virtual para o local.
zones	string[]		Uma lista de zonas de disponibilidade indicando de onde o recurso precisa vir.

ApiManagementServiceIdentity

Object

Propriedades de identidade do recurso de serviço Gerenciamento de Api.

Name	Tipo	Description
principalId	string (uuid)	O id principal da identidade.
tenantId	string (uuid)	O ID do locatário do cliente da identidade.
type	ApimIdentityType	O tipo de identidade usado para o recurso. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do serviço.
userAssignedIdentities	<string, UserIdentityProperties>	A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceResource

Object

Um único recurso de serviço de Gerenciamento de API em Listar ou Obter resposta.

Name	Tipo	Default value	Description
etag	string		ETag do recurso.
id	string		ID do recurso.
identity	ApiManagementServiceIdentity		Identidade de serviço gerenciado do serviço de Gerenciamento de Api.
location	string		Localização do recurso.
name	string		Nome do recurso.
properties.additionalLocations	AdditionalLocation[]		Locais de datacenter adicionais do serviço de Gerenciamento de API.
properties.apiVersionConstraint	ApiVersionConstraint		Restrição de versão da Apis do Plano de Controle para o serviço de Gerenciamento de API.
properties.certificates	CertificateConfiguration[]		Lista de certificados que precisam ser instalados no serviço de gerenciamento de API. O máximo de certificados suportados que podem ser instalados é 10.
properties.configurationApi	ConfigurationApi		Configuração da API do serviço de Gerenciamento de API.
properties.createdAtUtc	string (date-time)		Data de criação UTC do serviço 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.customProperties	object		Propriedades personalizadas do serviço de Gerenciamento de API. Configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` desativará o TLS_RSA_WITH_3DES_EDE_CBC_SHA de codificação para todos os TLS(1.0, 1.1 e 1.2). Configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` pode ser usada para desativar apenas o TLS 1.1. Configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` pode ser usada para desabilitar o TLS 1.0 em um serviço de Gerenciamento de API. Configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` pode ser usada para desativar apenas o TLS 1.1 para comunicações com back-ends. Configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` pode ser usada para desativar o TLS 1.0 para comunicações com back-ends. Configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` pode ser usada para habilitar o protocolo HTTP2 em um serviço de Gerenciamento de API. Não especificar nenhuma dessas propriedades na operação PATCH redefinirá os valores das propriedades omitidas para seus padrões. Para todas as configurações, exceto Http2, o valor padrão é `True` se o serviço tiver sido criado em ou antes de 1º de abril de 2018 e `False` contrário. O valor padrão da configuração Http2 é `False`. Você pode desativar qualquer uma das seguintes cifras usando as configurações `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA. Por exemplo, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. O valor padrão é `true` para eles. Nota: As seguintes cifras não podem ser desativadas, pois são exigidas pelos componentes internos da plataforma: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
properties.developerPortalStatus	developerPortalStatus	Enabled	Status do portal do desenvolvedor neste serviço de Gerenciamento de API.
properties.developerPortalUrl	string		URL do ponto de extremidade do Portal DEveloper do serviço de Gerenciamento de API.
properties.disableGateway	boolean	False	Propriedade válida apenas para um serviço de Gerenciamento de Api implantado em vários locais. Isso pode ser usado para desabilitar o gateway na região mestre.
properties.enableClientCertificate	boolean	False	Propriedade destinada apenas a ser usada para o Serviço de SKU de Consumo. Isso impõe um certificado de cliente a ser apresentado em cada solicitação ao gateway. Isso também permite a capacidade de autenticar o certificado na política no gateway.
properties.gatewayRegionalUrl	string		URL do gateway do serviço de Gerenciamento de API na Região Padrão.
properties.gatewayUrl	string		URL do gateway do serviço de Gerenciamento de API.
properties.hostnameConfigurations	HostnameConfiguration[]		Configuração personalizada de nome de host do serviço de Gerenciamento de API.
properties.legacyPortalStatus	LegacyPortalStatus	Enabled	Status do portal herdado no serviço de Gerenciamento de API.
properties.managementApiUrl	string		URL do ponto de extremidade da API de gerenciamento do serviço de gerenciamento de API.
properties.natGatewayState	NatGatewayState	Disabled	A propriedade pode ser usada para habilitar o NAT Gateway para este serviço de Gerenciamento de API.
properties.notificationSenderEmail	string maxLength: 100		Endereço de e-mail a partir do qual a notificação será enviada.
properties.outboundPublicIPAddresses	string[]		Prefixos de endereço IPV4 público de saída associados ao serviço implantado do Gateway NAT. Disponível apenas para SKU Premium na plataforma stv2.
properties.platformVersion	PlatformVersion		Versão da plataforma de computação executando o serviço neste local.
properties.portalUrl	string		URL do ponto de extremidade do portal do editor do serviço de Gerenciamento de API.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Lista de Conexões de Ponto Final Privadas deste serviço.
properties.privateIPAddresses	string[]		Endereços IP privados com balanceamento de carga estática do serviço de Gerenciamento de API na região primária que é implantado em uma rede virtual interna. Disponível apenas para SKU Básico, Standard, Premium e Isolado.
properties.provisioningState	string		O estado de provisionamento atual do serviço de Gerenciamento de API, que pode ser um dos seguintes: Criado/Ativando/Bem-sucedido/Atualizando/Falhado/Parado/Terminando/TerminaçãoFalhou/Excluído.
properties.publicIPAddresses	string[]		Endereços IP públicos com balanceamento de carga estática do serviço de Gerenciamento de API na região primária. Disponível apenas para SKU Básico, Standard, Premium e Isolado.
properties.publicIpAddressId	string		Endereço IP baseado em SKU IP V4 padrão público a ser associado ao serviço implantado na Rede Virtual na região. Suportado apenas para Developer e Premium SKU sendo implantado na Rede Virtual.
properties.publicNetworkAccess	PublicNetworkAccess		Se o acesso ao ponto de extremidade público é permitido ou não para este serviço de Gerenciamento de API. O valor é opcional, mas se passado, deve ser 'Ativado' ou 'Desativado'. Se 'Desativado', os pontos finais privados são o método de acesso exclusivo. O valor padrão é 'Enabled'
properties.publisherEmail	string maxLength: 100		E-mail do editor.
properties.publisherName	string maxLength: 100		Nome do editor.
properties.restore	boolean	False	Cancele a exclusão do Serviço de Gerenciamento de Api se ele tiver sido excluído anteriormente por software. Se esse sinalizador for especificado e definido como True, todas as outras propriedades serão ignoradas.
properties.scmUrl	string		URL do ponto de extremidade SCM do serviço de Gerenciamento de API.
properties.targetProvisioningState	string		O estado de provisionamento do serviço de Gerenciamento de API, que é direcionado pela operação de longa duração iniciada no serviço.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		Configuração de rede virtual do serviço de Gerenciamento de API.
properties.virtualNetworkType	VirtualNetworkType	None	O tipo de VPN no qual o serviço de Gerenciamento de API precisa ser configurado. Nenhum (Valor Padrão) significa que o serviço de Gerenciamento de API não faz parte de nenhuma Rede Virtual, Externo significa que a implantação do Gerenciamento de API é configurada dentro de uma Rede Virtual com um Ponto de Extremidade voltado para a Internet e Interno significa que a implantação do Gerenciamento de API é configurada dentro de uma Rede Virtual com um Ponto de Extremidade Voltado para a Intranet apenas.
sku	ApiManagementServiceSkuProperties		Propriedades de SKU do serviço 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.
zones	string[]		Uma lista de zonas de disponibilidade indicando de onde o recurso precisa vir.

ApiManagementServiceSkuProperties

Object

Propriedades SKU do recurso de serviço de Gerenciamento de API.

Name	Tipo	Description
capacity	integer (int32)	Capacidade do SKU (número de unidades implantadas do SKU). Para Consumo, a capacidade de SKU deve ser especificada como 0.
name	SkuType	Nome do Sku.

ApiManagementServiceUpdateParameters

Object

Parâmetro fornecido ao Update Api Management Service.

Name	Tipo	Default value	Description
etag	string		ETag do recurso.
id	string		ID do recurso.
identity	ApiManagementServiceIdentity		Identidade de serviço gerenciado do serviço de Gerenciamento de Api.
name	string		Nome do recurso.
properties.additionalLocations	AdditionalLocation[]		Locais de datacenter adicionais do serviço de Gerenciamento de API.
properties.apiVersionConstraint	ApiVersionConstraint		Restrição de versão da Apis do Plano de Controle para o serviço de Gerenciamento de API.
properties.certificates	CertificateConfiguration[]		Lista de certificados que precisam ser instalados no serviço de gerenciamento de API. O máximo de certificados suportados que podem ser instalados é 10.
properties.configurationApi	ConfigurationApi		Configuração da API do serviço de Gerenciamento de API.
properties.createdAtUtc	string (date-time)		Data de criação UTC do serviço 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.customProperties	object		Propriedades personalizadas do serviço de Gerenciamento de API. Configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` desativará o TLS_RSA_WITH_3DES_EDE_CBC_SHA de codificação para todos os TLS(1.0, 1.1 e 1.2). Configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` pode ser usada para desativar apenas o TLS 1.1. Configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` pode ser usada para desabilitar o TLS 1.0 em um serviço de Gerenciamento de API. Configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` pode ser usada para desativar apenas o TLS 1.1 para comunicações com back-ends. Configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` pode ser usada para desativar o TLS 1.0 para comunicações com back-ends. Configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` pode ser usada para habilitar o protocolo HTTP2 em um serviço de Gerenciamento de API. Não especificar nenhuma dessas propriedades na operação PATCH redefinirá os valores das propriedades omitidas para seus padrões. Para todas as configurações, exceto Http2, o valor padrão é `True` se o serviço tiver sido criado em ou antes de 1º de abril de 2018 e `False` contrário. O valor padrão da configuração Http2 é `False`. Você pode desativar qualquer uma das seguintes cifras usando as configurações `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA. Por exemplo, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. O valor padrão é `true` para eles. Nota: As seguintes cifras não podem ser desativadas, pois são exigidas pelos componentes internos da plataforma: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
properties.developerPortalStatus	developerPortalStatus	Enabled	Status do portal do desenvolvedor neste serviço de Gerenciamento de API.
properties.developerPortalUrl	string		URL do ponto de extremidade do Portal DEveloper do serviço de Gerenciamento de API.
properties.disableGateway	boolean	False	Propriedade válida apenas para um serviço de Gerenciamento de Api implantado em vários locais. Isso pode ser usado para desabilitar o gateway na região mestre.
properties.enableClientCertificate	boolean	False	Propriedade destinada apenas a ser usada para o Serviço de SKU de Consumo. Isso impõe um certificado de cliente a ser apresentado em cada solicitação ao gateway. Isso também permite a capacidade de autenticar o certificado na política no gateway.
properties.gatewayRegionalUrl	string		URL do gateway do serviço de Gerenciamento de API na Região Padrão.
properties.gatewayUrl	string		URL do gateway do serviço de Gerenciamento de API.
properties.hostnameConfigurations	HostnameConfiguration[]		Configuração personalizada de nome de host do serviço de Gerenciamento de API.
properties.legacyPortalStatus	LegacyPortalStatus	Enabled	Status do portal herdado no serviço de Gerenciamento de API.
properties.managementApiUrl	string		URL do ponto de extremidade da API de gerenciamento do serviço de gerenciamento de API.
properties.natGatewayState	NatGatewayState	Disabled	A propriedade pode ser usada para habilitar o NAT Gateway para este serviço de Gerenciamento de API.
properties.notificationSenderEmail	string maxLength: 100		Endereço de e-mail a partir do qual a notificação será enviada.
properties.outboundPublicIPAddresses	string[]		Prefixos de endereço IPV4 público de saída associados ao serviço implantado do Gateway NAT. Disponível apenas para SKU Premium na plataforma stv2.
properties.platformVersion	PlatformVersion		Versão da plataforma de computação executando o serviço neste local.
properties.portalUrl	string		URL do ponto de extremidade do portal do editor do serviço de Gerenciamento de API.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Lista de Conexões de Ponto Final Privadas deste serviço.
properties.privateIPAddresses	string[]		Endereços IP privados com balanceamento de carga estática do serviço de Gerenciamento de API na região primária que é implantado em uma rede virtual interna. Disponível apenas para SKU Básico, Standard, Premium e Isolado.
properties.provisioningState	string		O estado de provisionamento atual do serviço de Gerenciamento de API, que pode ser um dos seguintes: Criado/Ativando/Bem-sucedido/Atualizando/Falhado/Parado/Terminando/TerminaçãoFalhou/Excluído.
properties.publicIPAddresses	string[]		Endereços IP públicos com balanceamento de carga estática do serviço de Gerenciamento de API na região primária. Disponível apenas para SKU Básico, Standard, Premium e Isolado.
properties.publicIpAddressId	string		Endereço IP baseado em SKU IP V4 padrão público a ser associado ao serviço implantado na Rede Virtual na região. Suportado apenas para Developer e Premium SKU sendo implantado na Rede Virtual.
properties.publicNetworkAccess	PublicNetworkAccess		Se o acesso ao ponto de extremidade público é permitido ou não para este serviço de Gerenciamento de API. O valor é opcional, mas se passado, deve ser 'Ativado' ou 'Desativado'. Se 'Desativado', os pontos finais privados são o método de acesso exclusivo. O valor padrão é 'Enabled'
properties.publisherEmail	string maxLength: 100		E-mail do editor.
properties.publisherName	string maxLength: 100		Nome do editor.
properties.restore	boolean	False	Cancele a exclusão do Serviço de Gerenciamento de Api se ele tiver sido excluído anteriormente por software. Se esse sinalizador for especificado e definido como True, todas as outras propriedades serão ignoradas.
properties.scmUrl	string		URL do ponto de extremidade SCM do serviço de Gerenciamento de API.
properties.targetProvisioningState	string		O estado de provisionamento do serviço de Gerenciamento de API, que é direcionado pela operação de longa duração iniciada no serviço.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		Configuração de rede virtual do serviço de Gerenciamento de API.
properties.virtualNetworkType	VirtualNetworkType	None	O tipo de VPN no qual o serviço de Gerenciamento de API precisa ser configurado. Nenhum (Valor Padrão) significa que o serviço de Gerenciamento de API não faz parte de nenhuma Rede Virtual, Externo significa que a implantação do Gerenciamento de API é configurada dentro de uma Rede Virtual com um Ponto de Extremidade voltado para a Internet e Interno significa que a implantação do Gerenciamento de API é configurada dentro de uma Rede Virtual com um Ponto de Extremidade Voltado para a Intranet apenas.
sku	ApiManagementServiceSkuProperties		Propriedades de SKU do serviço de Gerenciamento de API.
tags	object		Tags de recursos.
type	string		O tipo de recurso para o recurso de Gerenciamento de API é definido como Microsoft.ApiManagement.
zones	string[]		Uma lista de zonas de disponibilidade indicando de onde o recurso precisa vir.

ApimIdentityType

Enumeração

O tipo de identidade usado para o recurso. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do serviço.

Valor	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ApiVersionConstraint

Object

Restrição de versão da Apis do Plano de Controle para o serviço de Gerenciamento de API.

Name	Tipo	Description
minApiVersion	string	Limite as chamadas de API do plano de controle para o serviço de Gerenciamento de API com versão igual ou mais recente que esse valor.

ArmIdWrapper

Object

Um wrapper para um ID de recurso ARM

Name	Tipo	Description
id	string

CertificateConfiguration

Object

Configuração de certificado que consiste em intermediários não confiáveis e certificados raiz.

Name	Tipo	Description
certificate	CertificateInformation	Informações do certificado.
certificatePassword	string	Senha do certificado.
encodedCertificate	string	Certificado codificado Base64.
storeName	enum: CertificateAuthority Root	O local de armazenamento de certificados System.Security.Cryptography.x509certificates.StoreName. Somente Root e CertificateAuthority são locais válidos.

CertificateInformation

Object

Informações do certificado SSL.

Name	Tipo	Description
expiry	string (date-time)	Data de validade do certificado. A data está em conformidade com o seguinte formato: `yyyy-MM-ddTHH:mm:ssZ` conforme especificado pela norma ISO 8601.
subject	string	Objeto do certificado.
thumbprint	string	Impressão digital do certificado.

CertificateSource

Enumeração

Origem do certificado.

Valor	Description
Managed
KeyVault
Custom
BuiltIn

CertificateStatus

Enumeração

Status do certificado.

Valor	Description
Completed
Failed
InProgress

ConfigurationApi

Object

Informações sobre a API de configuração do serviço de Gerenciamento de API.

Name	Tipo	Default value	Description
legacyApi	LegacyApiState	Enabled	Indicação se a API de configuração herdada (v1) deve ou não ser exposta no serviço de Gerenciamento de API. O valor é opcional, mas deve ser 'Ativado' ou 'Desativado'. Se 'Desabilitada', a API de configuração herdada (v1) não estará disponível para gateways auto-hospedados. O valor padrão é 'Enabled'

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

developerPortalStatus

Enumeração

Status do portal do desenvolvedor neste serviço de Gerenciamento de API.

Valor	Description
Enabled	O Portal do Desenvolvedor está habilitado para o serviço.
Disabled	O Portal do Desenvolvedor está desabilitado para o serviço.

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.

HostnameConfiguration

Object

Configuração personalizada do nome do host.

Name	Tipo	Default value	Description
certificate	CertificateInformation		Informações do certificado.
certificatePassword	string		Senha do certificado.
certificateSource	CertificateSource		Origem do certificado.
certificateStatus	CertificateStatus		Status do certificado.
defaultSslBinding	boolean	False	Especifique true para configurar o certificado associado a esse nome de host como o certificado SSL padrão. Se um cliente não enviar o cabeçalho SNI, este será o certificado que será contestado. A propriedade é útil se um serviço tiver vários nomes de host personalizados habilitados e precisar decidir sobre o certificado ssl padrão. A configuração só foi aplicada ao tipo de nome de host do gateway.
encodedCertificate	string		Certificado codificado Base64.
hostName	string		Nome do host a ser configurado no serviço de Gerenciamento de Api.
identityClientId	string		Identidade gerenciada atribuída pelo sistema ou usuário clientId conforme gerado pelo Azure AD, que tem acesso GET ao keyVault que contém o certificado SSL.
keyVaultId	string		Url para o segredo KeyVault que contém o certificado SSL. Se a URL absoluta contendo a versão for fornecida, a atualização automática do certificado ssl não funcionará. Isso requer que o serviço de Gerenciamento de Api seja configurado com aka.ms/apimmsi. O segredo deve ser do tipo application/x-pkcs12
negotiateClientCertificate	boolean	False	Especifique true para sempre negociar o certificado do cliente no nome do host. O valor padrão é false.
type	HostnameType		Tipo de nome de host.

HostnameType

Enumeração

Tipo de nome de host.

Valor	Description
Proxy
Portal
Management
Scm
DeveloperPortal
ConfigurationApi

LegacyApiState

Enumeração

Indicação se a API de configuração herdada (v1) deve ou não ser exposta no serviço de Gerenciamento de API. O valor é opcional, mas deve ser 'Ativado' ou 'Desativado'. Se 'Desabilitada', a API de configuração herdada (v1) não estará disponível para gateways auto-hospedados. O valor padrão é 'Enabled'

Valor	Description
Enabled	A API de configuração herdada (v1) está habilitada para o serviço e gateways auto-hospedados podem se conectar a ele.
Disabled	A API de configuração herdada (v1) está desabilitada para o serviço e os gateways auto-hospedados não podem se conectar a ele.

LegacyPortalStatus

Enumeração

Status do portal herdado no serviço de Gerenciamento de API.

Valor	Description
Enabled	O Portal Legado está habilitado para o serviço.
Disabled	O Portal Legado está desativado para o serviço.

NatGatewayState

Enumeração

A propriedade pode ser usada para habilitar o NAT Gateway para este serviço de Gerenciamento de API.

Valor	Description
Enabled	O Nat Gateway está habilitado para o serviço.
Disabled	O Nat Gateway está desativado para o serviço.

PlatformVersion

Enumeração

Versão da plataforma de computação executando o serviço.

Valor	Description
undetermined	A versão da plataforma não pode ser determinada, pois a plataforma de computação não está implantada.
stv1	Plataforma que executa o serviço na plataforma Single Tenant V1.
stv2	Plataforma que executa o serviço na plataforma Single Tenant V2.
mtv1	Plataforma que executa o serviço na plataforma Multi Tenant V1.
stv2.1	Plataforma que executa o serviço na plataforma Single Tenant V2 em hardware mais recente.

PrivateEndpointServiceConnectionStatus

Enumeração

O status da conexão de ponto de extremidade privado.

Valor	Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Object

Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.

Name	Tipo	Description
actionsRequired	string	Uma mensagem indicando se as alterações no prestador de serviços exigem atualizações sobre o consumidor.
description	string	O motivo da aprovação/rejeição da ligação.
status	PrivateEndpointServiceConnectionStatus	Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço.

PublicNetworkAccess

Enumeração

Se o acesso ao ponto de extremidade público é permitido ou não para este serviço de Gerenciamento de API. O valor é opcional, mas se passado, deve ser 'Ativado' ou 'Desativado'. Se 'Desativado', os pontos finais privados são o método de acesso exclusivo. O valor padrão é 'Enabled'

Valor	Description
Enabled
Disabled

RemotePrivateEndpointConnectionWrapper

Object

Recurso de Conexão de Ponto Final Privado Remoto.

Name	Tipo	Description
id	string	ID do recurso de conexão do Ponto Final Privado
name	string	Nome da Conexão de Ponto Final Privado
properties.groupIds	string[]	Todos os IDs do Grupo.
properties.privateEndpoint	ArmIdWrapper	O recurso do ponto final privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.
properties.provisioningState	string	O estado de provisionamento do recurso de conexão de ponto de extremidade privado.
type	string	Tipo de recurso de conexão de ponto de extremidade privado

SkuType

Enumeração

Nome do Sku.

Valor	Description
Developer	Desenvolvedor SKU de Api Management.
Standard	SKU padrão de gerenciamento de API.
Premium	SKU Premium de Gestão de Api.
Basic	SKU básico de gerenciamento de api.
Consumption	Consumo de SKU de Gestão de Api.
Isolated	SKU isolado de gerenciamento de api.
BasicV2	SKU BasicV2 de Gerenciamento de Api.
StandardV2	SKU StandardV2 de Gerenciamento de Api.

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.

UserIdentityProperties

Object

Name	Tipo	Description
clientId	string	O ID do cliente da identidade atribuída ao usuário.
principalId	string	O id principal da identidade atribuída ao usuário.

VirtualNetworkConfiguration

Object

Configuração de uma rede virtual na qual o serviço de Gerenciamento de API é implantado.

Name	Tipo	Description
subnetResourceId	string pattern: ^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$	O ID de recurso completo de uma sub-rede em uma rede virtual na qual implantar o serviço de Gerenciamento de API.
subnetname	string	O nome da sub-rede.
vnetid	string	O ID da rede virtual. Normalmente, trata-se de um GUID. Espere um GUID nulo por padrão.

VirtualNetworkType

Enumeração

O tipo de VPN no qual o serviço de Gerenciamento de API precisa ser configurado. Nenhum (Valor Padrão) significa que o serviço de Gerenciamento de API não faz parte de nenhuma Rede Virtual, Externo significa que a implantação do Gerenciamento de API é configurada dentro de uma Rede Virtual com um Ponto de Extremidade voltado para a Internet e Interno significa que a implantação do Gerenciamento de API é configurada dentro de uma Rede Virtual com um Ponto de Extremidade Voltado para a Intranet apenas.

Valor	Description
None	O serviço não faz parte de nenhuma Rede Virtual.
External	O serviço faz parte da Rede Virtual e é acessível a partir da Internet.
Internal	O serviço faz parte da Rede Virtual e só é acessível a partir da rede virtual.

Partilhar via

Api Management Service - Update

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

ApiManagementUpdateServiceDisableTls10

Pedido de amostra

Resposta da amostra

ApiManagementUpdateServicePublisherDetails

Pedido de amostra

Resposta da amostra

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

Pedido de amostra

Resposta da amostra

Definições

AdditionalLocation

ApiManagementServiceIdentity

ApiManagementServiceResource

ApiManagementServiceSkuProperties

ApiManagementServiceUpdateParameters

ApimIdentityType

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateInformation

CertificateSource

CertificateStatus

ConfigurationApi

createdByType

developerPortalStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HostnameConfiguration

HostnameType

LegacyApiState

LegacyPortalStatus

NatGatewayState

PlatformVersion

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

PublicNetworkAccess

RemotePrivateEndpointConnectionWrapper

SkuType

systemData

UserIdentityProperties

VirtualNetworkConfiguration

VirtualNetworkType