Api Management Service - Refresh Hostnames

Serviço:: API Management

Versão da API:: 2025-03-01-preview

Forçar a atualização do certificado SSL anexado aos Nomes de Host Personalizados configurados usando secret do KeyVault no serviço de Gerenciamento de APIs.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/refreshHostnames?api-version=2025-03-01-preview

Parâmetros de URI

Nome	Em	Obrigató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 minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	ApiManagementServiceResource	A operação do Azure foi concluída com êxito.
202 Accepted		Operação de recurso aceita. Cabeçalhos Retry-After: integer location: string
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Nome

Tipo

Description

200 OK

ApiManagementServiceResource

A operação do Azure foi concluída com êxito.

202 Accepted

Operação de recurso aceita.

Cabeçalhos

Retry-After: integer
location: string

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	Personificar sua conta de usuário

Exemplos

ApiManagementServiceRefreshKeyVaultHostnames

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/refreshHostnames?api-version=2025-03-01-preview

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_service_refresh_key_vault_hostnames.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.api_management_service.begin_refresh_hostnames(
        resource_group_name="rg1",
        service_name="apimService1",
    ).result()
    print(response)


# x-ms-original-file: 2025-03-01-preview/ApiManagementServiceRefreshKeyVaultHostnames.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:: 200

{
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "etag": "AAAAAAK5GpM=",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "b413456e-a9c8-4242-9754-0a01c061bd41",
    "tenantId": "b413456e-a9c8-4242-9754-0a01c061bd41"
  },
  "location": "West Europe",
  "properties": {
    "additionalLocations": [
      {
        "disableGateway": false,
        "gatewayRegionalUrl": "https://apimService1-northeurope-01.regional.azure-api.net",
        "location": "North Europe",
        "outboundPublicIPAddresses": [
          "4.xxx.40.176"
        ],
        "platformVersion": "stv2",
        "publicIPAddresses": [
          "4.xxx.40.176"
        ],
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimVnet/subnets/default2"
        }
      }
    ],
    "createdAtUtc": "2016-04-12T00:20:15.6018952Z",
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True"
    },
    "developerPortalStatus": "Enabled",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "disableGateway": false,
    "gatewayRegionalUrl": "https://apimService1-westeurope-01.regional.azure-api.net",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "certificateSource": "BuiltIn",
        "defaultSslBinding": false,
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false
      },
      {
        "type": "Proxy",
        "certificate": {
          "expiry": "2025-12-18T11:11:47+00:00",
          "subject": "CN=*.msitesting.net",
          "thumbprint": "9833D531D7A45XXXXXXXXXXXX8BD392E0BD3F"
        },
        "certificateSource": "KeyVault",
        "defaultSslBinding": true,
        "hostName": "proxy.msitesting.net",
        "keyVaultId": "https://apim-msi-keyvault.vault.azure.net/secrets/sslcertificate",
        "negotiateClientCertificate": false
      }
    ],
    "legacyPortalStatus": "Disabled",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "natGatewayState": "Disabled",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "outboundPublicIPAddresses": [
      "57.xxx.61.xx"
    ],
    "platformVersion": "stv2.1",
    "provisioningState": "Succeeded",
    "publicIPAddresses": [
      "XX.153.XX.94"
    ],
    "publicNetworkAccess": "Enabled",
    "publisherEmail": "autorest@contoso.com",
    "publisherName": "Microsoft",
    "releaseChannel": "Default",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1/subnets/default"
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "systemData": {
    "lastModifiedAt": "2024-06-14T17:33:34.8195595Z",
    "lastModifiedBy": "autorest@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {}
}

Código de status:: 202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2025-03-01-preview

Definições

Nome	Description
AdditionalLocation	Descrição de um local de recurso adicional do 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 de SKU de recurso do serviço de Gerenciamento de API.
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 'None' removerá as identidades do serviço.
ApiVersionConstraint	Restrição de versão do Control Plane Apis para o serviço de Gerenciamento de API.
ArmIdWrapper	Um wrapper para uma ID de recurso do ARM
CertificateConfiguration	Configuração de certificado que consiste em intermediários não confiáveis e certificados raiz.
CertificateConfigurationStoreName	O local do repositório de certificados System.Security.Cryptography.x509certificates.StoreName. Somente Root e CertificateAuthority são locais válidos.
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	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
HostnameConfiguration	Configuração de nome de host personalizado.
HostnameType	Tipo de nome de host.
LegacyApiState	Indica 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 "Habilitado" ou "Desabilitado". Se 'Disabled', 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 Gateway nat para este serviço de Gerenciamento de API.
PlatformVersion	Versão da plataforma de computação que executa o serviço.
PrivateEndpointServiceConnectionStatus	O status da conexão do ponto de extremidade privado.
PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.
PublicNetworkAccess	Se o acesso ao ponto de extremidade público é permitido ou não para esse serviço de Gerenciamento de API. O valor é opcional, mas se passado, deve ser "Habilitado" ou "Desabilitado". Se 'Disabled', pontos de extremidade privados são o método de acesso exclusivo. O valor padrão é 'Enabled'
ReleaseChannel	Canal de Lançamento deste serviço de Gerenciamento de API.
RemotePrivateEndpointConnectionWrapper	Recurso de Conexão de Ponto de Extremidade Privado Remoto.
SkuType	Nome do Sku.
systemData	Metadados relativos à 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 gateway de Gerenciamento de API precisa ser configurado.

AdditionalLocation

Objeto

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

Nome	Tipo	Valor padrão	Description
disableGateway	boolean	False	Propriedade válida somente para um serviço de Gerenciamento de API implantado em vários locais. Isso pode ser usado para desabilitar o gateway neste local adicional.
gatewayRegionalUrl	string		URL do gateway do serviço de Gerenciamento de API na Região.
location	string		O nome da localização da região adicional entre as regiões do Data center do Azure.
natGatewayState	NatGatewayState	Disabled	A propriedade pode ser usada para habilitar o Gateway nat 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 que executa o serviço.
privateIPAddresses	string[]		Endereços IP com balanceamento de carga estático privado do serviço de Gerenciamento de API implantado em uma Rede Virtual Interna em um local adicional específico. Disponível apenas para SKU Básico, Padrão, 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, Padrão, Premium e Isolado.
publicIpAddressId	string		Endereço IP baseado em SKU Padrão Público V4 a ser associado ao serviço implantado da Rede Virtual no local. Suporte somente para SKU Premium que está 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

Objeto

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

Nome	Tipo	Description
principalId	string (uuid)	A ID principal da identidade.
tenantId	string (uuid)	A 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 'None' removerá 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 do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceResource

Objeto

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

Nome	Tipo	Valor padrão	Description
etag	string		ETag do recurso.
id	string		ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ApiManagementServiceIdentity		Identidade de serviço gerenciada do serviço de Gerenciamento de API.
location	string		A localização geográfica onde o recurso reside
name	string		O 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 do Control Plane Apis 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 com suporte 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. A configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` desativará o TLS_RSA_WITH_3DES_EDE_CBC_SHA de criptografia para todos os TLS(1.0, 1.1 e 1.2). A configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` pode ser usada para desabilitar apenas o TLS 1.1. A 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. A configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` pode ser usada para desabilitar apenas o TLS 1.1 para comunicações com back-ends. A configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` pode ser usada para desabilitar o TLS 1.0 para comunicações com back-ends. A 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 será `True` se o serviço tiver sido criado em ou antes de 1º de abril de 2018 e `False` caso contrário. O valor padrão da configuração Http2 é `False`. Você pode desativar qualquer uma das seguintes cifras usando 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. Observação: as seguintes criptografias 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 somente para um serviço de Gerenciamento de API implantado em vários locais. Isso pode ser usado para desabilitar o gateway na região mestra.
properties.enableClientCertificate	boolean	False	Propriedade destinada apenas a ser usada para o Serviço de SKU de Consumo. Isso impõe que um certificado do cliente seja 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 de nome de host personalizado 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 Gateway nat para este serviço de Gerenciamento de API.
properties.notificationSenderEmail	string maxLength: 100		Endereço de email 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 que executa 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 de extremidade privado deste serviço.
properties.privateIPAddresses	string[]		Endereços IP com balanceamento de carga estático privado do serviço de Gerenciamento de API na região Primária que é implantada em uma Rede Virtual Interna. Disponível apenas para SKU Básico, Padrão, 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/Falha/Parado/Encerrado/TerminationFailed/Deleted.
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, Padrão, Premium e Isolado.
properties.publicIpAddressId	string		Endereço IP baseado em IP de SKU Padrão Público V4 a ser associado ao serviço implantado da Rede Virtual na região. Com suporte apenas para desenvolvedores e SKU Premium que estão sendo implantados na Rede Virtual.
properties.publicNetworkAccess	PublicNetworkAccess		Se o acesso ao ponto de extremidade público é permitido ou não para esse serviço de Gerenciamento de API. O valor é opcional, mas se passado, deve ser "Habilitado" ou "Desabilitado". Se 'Disabled', pontos de extremidade privados são o método de acesso exclusivo. O valor padrão é 'Enabled'
properties.publisherEmail	string maxLength: 100		Email do publicador.
properties.publisherName	string maxLength: 100		Nome do editor.
properties.releaseChannel	ReleaseChannel		Canal de Lançamento deste serviço de Gerenciamento de API.
properties.restore	boolean	False	Desdelete o Serviço de Gerenciamento de API se ele foi excluído anteriormente. Se esse sinalizador for especificado e definido como True, todas as outras propriedades serão ignoradas.
properties.scmUrl	string		URL do ponto de extremidade do 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 execução longa 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 de Gerenciamento de API está 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 apenas um ponto de extremidade voltado para intranet.
properties.zoneRedundant	boolean	False	Requisito de Redundância de Zona ao criar StandardV2 e PremiumV2. Se essa flag for definida como Verdadeiro, retornará um serviço APIM com Zona redundante ou falhará a solicitação se qualquer componente inferior não puder ser redundante de zona.
sku	ApiManagementServiceSkuProperties		Propriedades de SKU do serviço de Gerenciamento de API.
systemData	systemData		Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.
tags	object		Tags de recursos.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"
zones	string[]		As zonas de disponibilidade.

ApiManagementServiceSkuProperties

Objeto

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

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

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 'None' removerá as identidades do serviço.

Valor	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ApiVersionConstraint

Objeto

Restrição de versão do Control Plane Apis para o serviço de Gerenciamento de API.

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

ArmIdWrapper

Objeto

Um wrapper para uma ID de recurso do ARM

Nome	Tipo	Description
id	string

CertificateConfiguration

Objeto

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

Nome	Tipo	Description
certificate	CertificateInformation	Informações do certificado.
certificatePassword	string	Senha do certificado.
encodedCertificate	string	Certificado codificado em Base64.
storeName	CertificateConfigurationStoreName	O local do repositório de certificados System.Security.Cryptography.x509certificates.StoreName. Somente Root e CertificateAuthority são locais válidos.

CertificateConfigurationStoreName

Enumeração

O local do repositório de certificados System.Security.Cryptography.x509certificates.StoreName. Somente Root e CertificateAuthority são locais válidos.

Valor	Description
CertificateAuthority
Root

CertificateInformation

Objeto

Informações do certificado SSL.

Nome	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 pelo padrão ISO 8601.
subject	string	Assunto 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

Objeto

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

Nome	Tipo	Valor padrão	Description
legacyApi	LegacyApiState	Enabled	Indica 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 "Habilitado" ou "Desabilitado". Se 'Disabled', 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

Objeto

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

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

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

HostnameConfiguration

Objeto

Configuração de nome de host personalizado.

Nome	Tipo	Valor padrão	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, esse será o certificado que será contestado. A propriedade será ú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 aplicada somente ao Tipo de Nome de Host do gateway.
encodedCertificate	string		Certificado codificado em Base64.
hostName	string		Nome do host a ser configurado no serviço de Gerenciamento de API.
identityClientId	string		System or User Assigned Managed identity clientId as generated by 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 que contém 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 é falso.
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 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 "Habilitado" ou "Desabilitado". Se 'Disabled', 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 os gateways auto-hospedados podem se conectar a ela.
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 ela.

LegacyPortalStatus

Enumeração

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

Valor	Description
Enabled	O Portal Herdado 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 Gateway nat 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á desabilitado para o serviço.

PlatformVersion

Enumeração

Versão da plataforma de computação que executa 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 do ponto de extremidade privado.

Valor	Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Objeto

Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.

Nome	Tipo	Description
actionsRequired	string	Uma mensagem que indica se as alterações no provedor de serviços exigem atualizações no consumidor.
description	string	O motivo da aprovação/rejeição da conexã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 esse serviço de Gerenciamento de API. O valor é opcional, mas se passado, deve ser "Habilitado" ou "Desabilitado". Se 'Disabled', pontos de extremidade privados são o método de acesso exclusivo. O valor padrão é 'Enabled'

Valor	Description
Enabled
Disabled

ReleaseChannel

Enumeração

Canal de Lançamento deste serviço de Gerenciamento de API.

Valor	Description
Preview	Canal de visualização do serviço.
Default	Canal padrão do serviço.
Stable	Canal estável do serviço.

RemotePrivateEndpointConnectionWrapper

Objeto

Recurso de Conexão de Ponto de Extremidade Privado Remoto.

Nome	Tipo	Description
id	string	ID do recurso de conexão do ponto de extremidade privado
name	string	Nome da conexão do ponto de extremidade privado
properties.groupIds	string[]	Todos os IDs de grupo.
properties.privateEndpoint	ArmIdWrapper	O recurso do ponto de extremidade privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.
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	SKU do desenvolvedor de gerenciamento de API.
Standard	SKU padrão de gerenciamento de API.
Premium	SKU Premium de Gerenciamento de API.
Basic	SKU básico de gerenciamento de API.
Consumption	SKU de consumo do Gerenciamento de API.
Isolated	SKU isolado do Gerenciamento de API.
BasicV2	SKU BasicV2 do Gerenciamento de API.
StandardV2	SKU StandardV2 do Gerenciamento de API.
PremiumV2	SKU PremiumV2 da API Management.

systemData

Objeto

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

Nome	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

Objeto

Nome	Tipo	Description
clientId	string	A ID do cliente da identidade atribuída pelo usuário.
principalId	string	A ID principal da identidade atribuída pelo usuário.

VirtualNetworkConfiguration

Objeto

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

Nome	Tipo	Description
subnetResourceId	string pattern: ^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$	A ID de recurso completa 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	A ID da rede virtual. Normalmente, isso é um GUID. Espere um GUID nulo por padrão.

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ó pode ser acessado de dentro da rede virtual.

Compartilhar via

Api Management Service - Refresh Hostnames

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

ApiManagementServiceRefreshKeyVaultHostnames

Solicitação de exemplo

Resposta de exemplo

Definições

AdditionalLocation

ApiManagementServiceIdentity

ApiManagementServiceResource

ApiManagementServiceSkuProperties

ApimIdentityType

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateConfigurationStoreName

CertificateInformation

CertificateSource

CertificateStatus

ConfigurationApi

createdByType

DeveloperPortalStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HostnameConfiguration

HostnameType

LegacyApiState

LegacyPortalStatus

NatGatewayState

PlatformVersion

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

PublicNetworkAccess

ReleaseChannel

RemotePrivateEndpointConnectionWrapper

SkuType

systemData

UserIdentityProperties

VirtualNetworkConfiguration

VirtualNetworkType