Api Management Service - Refresh Hostnames

Usługa:: API Management

Wersja interfejsu API:: 2025-03-01-preview

Wymuszenie odświeżenia certyfikatu SSL przypisanego do niestandardowych nazw hostów skonfigurowanych za pomocą sekretu z KeyVault w usłudze zarządzania API.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nazwa usługi API Management.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ApiManagementServiceResource	Operacja platformy Azure została ukończona pomyślnie.
202 Accepted		Zaakceptowano operację zasobu. Nagłówki Retry-After: integer location: string
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Nazwa

Typ

Opis

200 OK

ApiManagementServiceResource

Operacja platformy Azure została ukończona pomyślnie.

202 Accepted

Zaakceptowano operację zasobu.

Nagłówki

Retry-After: integer
location: string

Other Status Codes

ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 w usłudze Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	Podszywać się pod Twoje konto użytkownika

Przykłady

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

Przykładowa odpowiedź

Kod stanu:: 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": {}
}

Kod stanu:: 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

Definicje

Nazwa	Opis
AdditionalLocation	Opis dodatkowej lokalizacji zasobu API Management.
ApiManagementServiceIdentity	Właściwości tożsamości zasobu usługi Api Management.
ApiManagementServiceResource	Pojedynczy zasób usługi API Management w obszarze Lista lub Pobierz odpowiedź.
ApiManagementServiceSkuProperties	Właściwości jednostki SKU zasobu usługi API Management.
ApimIdentityType	Typ tożsamości używany dla zasobu. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi.
ApiVersionConstraint	Ograniczenie wersji interfejsów API płaszczyzny sterowania dla usługi API Management.
ArmIdWrapper	Otoka identyfikatora zasobu usługi ARM
CertificateConfiguration	Konfiguracja certyfikatu, która składa się z niezaufanych certyfikatów pośrednich i certyfikatów głównych.
CertificateConfigurationStoreName	Lokalizacja magazynu certyfikatów System.Security.Cryptography.x509certificates.StoreName. Prawidłowe lokalizacje to tylko katalog główny i certyfikatuAuthority.
CertificateInformation	Informacje o certyfikacie SSL.
CertificateSource	Źródło certyfikatu.
CertificateStatus	Stan certyfikatu.
ConfigurationApi	Informacje dotyczące interfejsu API konfiguracji usługi API Management.
createdByType	Typ tożsamości, która utworzyła zasób.
DeveloperPortalStatus	Stan portalu dla deweloperów w tej usłudze API Management.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
HostnameConfiguration	Niestandardowa konfiguracja nazwy hosta.
HostnameType	Typ nazwy hosta.
LegacyApiState	Wskazanie, czy starszy interfejs API konfiguracji (wersja 1) powinien być uwidoczniony w usłudze API Management. Wartość jest opcjonalna, ale musi być "Włączona" lub "Wyłączona". W przypadku ustawienia "Wyłączone" starszy interfejs API konfiguracji (wersja 1) nie będzie dostępny dla bram hostowanych samodzielnie. Wartość domyślna to "Włączone"
LegacyPortalStatus	Stan starszego portalu w usłudze API Management.
NatGatewayState	Właściwość może służyć do włączania bramy translatora adresów sieciowych dla tej usługi API Management.
PlatformVersion	Wersja platformy obliczeniowej, w której jest uruchomiona usługa.
PrivateEndpointServiceConnectionStatus	Stan połączenia prywatnego punktu końcowego.
PrivateLinkServiceConnectionState	Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą.
PublicNetworkAccess	Czy dostęp do publicznego punktu końcowego jest dozwolony dla tej usługi API Management. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone". Jeśli wartość jest wyłączona, prywatne punkty końcowe są wyłączną metodą dostępu. Wartość domyślna to "Włączone"
ReleaseChannel	Kanał wydania tej usługi API Management.
RemotePrivateEndpointConnectionWrapper	Zasób Połączenie zdalnego prywatnego punktu końcowego.
SkuType	Nazwa jednostki SKU.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
UserIdentityProperties
VirtualNetworkConfiguration	Konfiguracja sieci wirtualnej, w której wdrożono usługę API Management.
VirtualNetworkType	Typ sieci VPN, w której należy skonfigurować bramę usługi API Management.

AdditionalLocation

Objekt

Opis dodatkowej lokalizacji zasobu API Management.

Nazwa	Typ	Domyślna wartość	Opis
disableGateway	boolean	False	Właściwość jest prawidłowa tylko dla usługi Api Management wdrożonej w wielu lokalizacjach. Można to użyć do wyłączenia bramy w tej dodatkowej lokalizacji.
gatewayRegionalUrl	string		Adres URL bramy usługi API Management w regionie.
location	string		Nazwa lokalizacji dodatkowego regionu między regionami centrum danych platformy Azure.
natGatewayState	NatGatewayState	Disabled	Właściwość może służyć do włączania bramy translatora adresów sieciowych dla tej usługi API Management.
outboundPublicIPAddresses	string[]		Prefiksy publicznych adresów IPV4 dla ruchu wychodzącego skojarzone z wdrożoną usługą bramy translatora adresów sieciowych. Dostępne tylko dla jednostki SKU Premium na platformie stv2.
platformVersion	PlatformVersion		Wersja platformy obliczeniowej, w której jest uruchomiona usługa.
privateIPAddresses	string[]		Prywatne statyczne adresy IP ze zrównoważonym obciążeniem usługi API Management, która jest wdrażana w wewnętrznej sieci wirtualnej w określonej dodatkowej lokalizacji. Dostępne tylko dla jednostek SKU w warstwach Podstawowa, Standardowa, Premium i Izolowana.
publicIPAddresses	string[]		Publiczne adresy IP ze zrównoważonym obciążeniem statycznym usługi API Management w dodatkowej lokalizacji. Dostępne tylko dla jednostek SKU w warstwach Podstawowa, Standardowa, Premium i Izolowana.
publicIpAddressId	string		Publiczny adres IP IP oparty na adresie IP w warstwie Standardowa V4 do skojarzenia z usługą Virtual Network wdrożoną w lokalizacji. Obsługiwane tylko w przypadku jednostki SKU Premium wdrażanej w Virtual Network.
sku	ApiManagementServiceSkuProperties		Właściwości jednostki SKU usługi API Management.
virtualNetworkConfiguration	VirtualNetworkConfiguration		Konfiguracja sieci wirtualnej dla lokalizacji.
zones	string[]		Lista stref dostępności oznaczających miejsce, z którego musi pochodzić zasób.

ApiManagementServiceIdentity

Objekt

Właściwości tożsamości zasobu usługi Api Management.

Nazwa	Typ	Opis
principalId	string (uuid)	Identyfikator podmiotu zabezpieczeń tożsamości.
tenantId	string (uuid)	Identyfikator dzierżawy klienta tożsamości.
type	ApimIdentityType	Typ tożsamości używany dla zasobu. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi.
userAssignedIdentities	<string, UserIdentityProperties>	Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ApiManagementServiceResource

Objekt

Pojedynczy zasób usługi API Management w obszarze Lista lub Pobierz odpowiedź.

Nazwa	Typ	Domyślna wartość	Opis
etag	string		Element ETag zasobu.
id	string		W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ApiManagementServiceIdentity		Tożsamość usługi zarządzanej usługi Api Management.
location	string		Lokalizacja geograficzna, w której znajduje się zasób
name	string		Nazwa zasobu
properties.additionalLocations	AdditionalLocation[]		Dodatkowe lokalizacje centrów danych usługi API Management.
properties.apiVersionConstraint	ApiVersionConstraint		Ograniczenie wersji interfejsów API płaszczyzny sterowania dla usługi API Management.
properties.certificates	CertificateConfiguration[]		Lista certyfikatów, które należy zainstalować w usłudze API Management. Maksymalna obsługiwana liczba obsługiwanych certyfikatów, które można zainstalować, wynosi 10.
properties.configurationApi	ConfigurationApi		Konfiguracja Konfiguracja interfejsu API konfiguracji usługi API Management.
properties.createdAtUtc	string (date-time)		Data utworzenia UTC usługi API Management. Data jest zgodna z następującym formatem: `yyyy-MM-ddTHH:mm:ssZ` zgodnie z normą ISO 8601.
properties.customProperties	object		Właściwości niestandardowe usługi API Management. Ustawienie `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` spowoduje wyłączenie TLS_RSA_WITH_3DES_EDE_CBC_SHA szyfrowania dla wszystkich TLS (1.0, 1.1 i 1.2). Ustawienie `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` może służyć do wyłączania tylko protokołu TLS 1.1. Ustawienie `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` może służyć do wyłączania protokołu TLS 1.0 w usłudze API Management. Ustawienie `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` może służyć do wyłączania tylko protokołu TLS 1.1 dla komunikacji z zapleczem. Ustawienie `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` może służyć do wyłączania protokołu TLS 1.0 dla komunikacji z zapleczem. Ustawienie `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` może służyć do włączania protokołu HTTP2 w usłudze API Management. Nieokreślenie żadnej z tych właściwości w operacji PATCH spowoduje zresetowanie wartości pominiętych właściwości do wartości domyślnych. W przypadku wszystkich ustawień z wyjątkiem Http2 wartość domyślna to `True` jeśli usługa została utworzona w dniu 1 kwietnia 2018 r. lub wcześniej, a `False` w przeciwnym razie. Domyślna wartość ustawienia Http2 to `False`. Możesz wyłączyć dowolny z następujących szyfrów przy użyciu ustawień `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. Na przykład `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Wartość domyślna jest `true` dla nich. Uwaga: Następujących szyfrów nie można wyłączyć, ponieważ są one wymagane przez wewnętrzne komponenty platformy: 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	Stan portalu dla deweloperów w tej usłudze API Management.
properties.developerPortalUrl	string		Adres URL punktu końcowego portalu DEveloper usługi API Management.
properties.disableGateway	boolean	False	Właściwość jest prawidłowa tylko dla usługi Api Management wdrożonej w wielu lokalizacjach. Można to użyć do wyłączenia bramy w regionie głównym.
properties.enableClientCertificate	boolean	False	Właściwość przeznaczona tylko do użycia w przypadku usługi SKU Zużycie. Wymusza to prezentowanie certyfikatu klienta dla każdego żądania do bramy. Umożliwia to również uwierzytelnianie certyfikatu w zasadach w bramie.
properties.gatewayRegionalUrl	string		Adres URL bramy usługi API Management w regionie domyślnym.
properties.gatewayUrl	string		Adres URL bramy usługi API Management.
properties.hostnameConfigurations	HostnameConfiguration[]		Niestandardowa konfiguracja nazwy hosta usługi API Management.
properties.legacyPortalStatus	LegacyPortalStatus	Enabled	Stan starszego portalu w usłudze API Management.
properties.managementApiUrl	string		Adres URL punktu końcowego interfejsu API zarządzania usługi API Management.
properties.natGatewayState	NatGatewayState	Disabled	Właściwość może służyć do włączania bramy translatora adresów sieciowych dla tej usługi API Management.
properties.notificationSenderEmail	string maxLength: 100		Adres e-mail, z którego zostanie wysłane powiadomienie.
properties.outboundPublicIPAddresses	string[]		Prefiksy publicznych adresów IPV4 dla ruchu wychodzącego skojarzone z wdrożoną usługą bramy translatora adresów sieciowych. Dostępne tylko dla jednostki SKU Premium na platformie stv2.
properties.platformVersion	PlatformVersion		Wersja platformy obliczeniowej, w której jest uruchomiona usługa w tej lokalizacji.
properties.portalUrl	string		Adres URL punktu końcowego portalu publikatorów usługi API Management.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Lista połączeń prywatnego punktu końcowego tej usługi.
properties.privateIPAddresses	string[]		Prywatne adresy IP ze zrównoważonym obciążeniem statycznym usługi API Management w regionie podstawowym, który jest wdrażany w wewnętrznej sieci wirtualnej. Dostępne tylko dla jednostek SKU w warstwach Podstawowa, Standardowa, Premium i Izolowana.
properties.provisioningState	string		Bieżący stan aprowizacji usługi API Management, który może być jednym z następujących: Utworzono/Aktywacja/Powodzenie/Aktualizowanie/Niepowodzenie/Zatrzymano/Zakończenie/ZakończenieNiepowodzenie/Usunięto.
properties.publicIPAddresses	string[]		Publiczne adresy IP ze zrównoważonym obciążeniem statycznym usługi API Management w regionie podstawowym. Dostępne tylko dla jednostek SKU w warstwach Podstawowa, Standardowa, Premium i Izolowana.
properties.publicIpAddressId	string		Publiczny adres IP IP oparty na adresie IP w warstwie Standardowa V4 do skojarzenia z wdrożoną usługą Virtual Network w regionie. Obsługiwane tylko w przypadku jednostek SKU Developer i Premium wdrażanych w Virtual Network.
properties.publicNetworkAccess	PublicNetworkAccess		Czy dostęp do publicznego punktu końcowego jest dozwolony dla tej usługi API Management. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone". Jeśli wartość jest wyłączona, prywatne punkty końcowe są wyłączną metodą dostępu. Wartość domyślna to "Włączone"
properties.publisherEmail	string maxLength: 100		Adres e-mail wydawcy.
properties.publisherName	string maxLength: 100		Nazwa wydawcy.
properties.releaseChannel	ReleaseChannel		Kanał wydania tej usługi API Management.
properties.restore	boolean	False	Cofnij usunięcie usługi Api Management Service, jeśli została wcześniej usunięta nietrwale. Jeśli ta flaga zostanie określona i ustawiona na wartość True, wszystkie inne właściwości zostaną zignorowane.
properties.scmUrl	string		Adres URL punktu końcowego SCM usługi API Management.
properties.targetProvisioningState	string		Stan aprowizacji usługi API Management, która jest objęta długotrwałą operacją rozpoczętą w usłudze.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		Konfiguracja sieci wirtualnej usługi API Management.
properties.virtualNetworkType	VirtualNetworkType	None	Typ sieci VPN, w której należy skonfigurować usługę API Management. Brak (wartość domyślna) oznacza, że usługa API Management nie jest częścią żadnej sieci wirtualnej, zewnętrzne oznacza, że wdrożenie usługi API Management jest konfigurowane wewnątrz sieci wirtualnej mającej punkt końcowy dostępny z Internetu, a wewnętrzne oznacza, że wdrożenie usługi API Management jest skonfigurowane wewnątrz sieci wirtualnej, która ma tylko punkt końcowy dostępny dla intranetu.
properties.zoneRedundant	boolean	False	Wymóg strefy redundantnej przy tworzeniu StandardV2 i PremiumV2. Jeśli ta flaga jest ustawiona na True, zwróci usługę APIM z redundantnością strefy lub nie przejdzie żądania, jeśli żaden komponent poniżej nie może być redundantny strefowo.
sku	ApiManagementServiceSkuProperties		Właściwości jednostki SKU usługi API Management.
systemData	systemData		Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
tags	object		Tagi zasobów.
type	string		Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"
zones	string[]		Strefy dostępności.

ApiManagementServiceSkuProperties

Objekt

Właściwości jednostki SKU zasobu usługi API Management.

Nazwa	Typ	Opis
capacity	integer (int32)	Pojemność jednostki SKU (liczba wdrożonych jednostek SKU). W przypadku pojemności jednostki SKU Użycie należy określić wartość 0.
name	SkuType	Nazwa jednostki SKU.

ApimIdentityType

Wyliczenie

Typ tożsamości używany dla zasobu. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi.

Wartość	Opis
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ApiVersionConstraint

Objekt

Ograniczenie wersji interfejsów API płaszczyzny sterowania dla usługi API Management.

Nazwa	Typ	Opis
minApiVersion	string	Ogranicz wywołania interfejsu API płaszczyzny sterowania do usługi API Management z wersją równą lub nowszą niż ta wartość.

ArmIdWrapper

Objekt

Otoka identyfikatora zasobu usługi ARM

Nazwa	Typ	Opis
id	string

CertificateConfiguration

Objekt

Konfiguracja certyfikatu, która składa się z niezaufanych certyfikatów pośrednich i certyfikatów głównych.

Nazwa	Typ	Opis
certificate	CertificateInformation	Informacje o certyfikacie.
certificatePassword	string	Hasło certyfikatu.
encodedCertificate	string	Certyfikat zakodowany w formacie Base64.
storeName	CertificateConfigurationStoreName	Lokalizacja magazynu certyfikatów System.Security.Cryptography.x509certificates.StoreName. Prawidłowe lokalizacje to tylko katalog główny i certyfikatuAuthority.

CertificateConfigurationStoreName

Wyliczenie

Lokalizacja magazynu certyfikatów System.Security.Cryptography.x509certificates.StoreName. Prawidłowe lokalizacje to tylko katalog główny i certyfikatuAuthority.

Wartość	Opis
CertificateAuthority
Root

CertificateInformation

Objekt

Informacje o certyfikacie SSL.

Nazwa	Typ	Opis
expiry	string (date-time)	Data wygaśnięcia certyfikatu. Data jest zgodna z następującym formatem: `yyyy-MM-ddTHH:mm:ssZ` określony przez standard ISO 8601.
subject	string	Podmiot certyfikatu.
thumbprint	string	Odcisk palca certyfikatu.

CertificateSource

Wyliczenie

Źródło certyfikatu.

Wartość	Opis
Managed
KeyVault
Custom
BuiltIn

CertificateStatus

Wyliczenie

Stan certyfikatu.

Wartość	Opis
Completed
Failed
InProgress

ConfigurationApi

Objekt

Informacje dotyczące interfejsu API konfiguracji usługi API Management.

Nazwa	Typ	Domyślna wartość	Opis
legacyApi	LegacyApiState	Enabled	Wskazanie, czy starszy interfejs API konfiguracji (wersja 1) powinien być uwidoczniony w usłudze API Management. Wartość jest opcjonalna, ale musi być "Włączona" lub "Wyłączona". W przypadku ustawienia "Wyłączone" starszy interfejs API konfiguracji (wersja 1) nie będzie dostępny dla bram hostowanych samodzielnie. Wartość domyślna to "Włączone"

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

DeveloperPortalStatus

Wyliczenie

Stan portalu dla deweloperów w tej usłudze API Management.

Wartość	Opis
Enabled	Portal dla deweloperów jest włączony dla usługi.
Disabled	Portal dla deweloperów jest wyłączony dla usługi.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

HostnameConfiguration

Objekt

Niestandardowa konfiguracja nazwy hosta.

Nazwa	Typ	Domyślna wartość	Opis
certificate	CertificateInformation		Informacje o certyfikacie.
certificatePassword	string		Hasło certyfikatu.
certificateSource	CertificateSource		Źródło certyfikatu.
certificateStatus	CertificateStatus		Stan certyfikatu.
defaultSslBinding	boolean	False	Określ wartość true, aby skonfigurować certyfikat skojarzony z tą nazwą hosta jako domyślny certyfikat SSL. Jeśli klient nie wyśle nagłówka SNI, będzie to certyfikat, który zostanie zakwestionowany. Właściwość jest przydatna, jeśli usługa ma włączoną wiele niestandardowych nazw hostów i musi zdecydować o domyślnym certyfikacie SSL. Ustawienie dotyczyło tylko typu nazwy hosta bramy.
encodedCertificate	string		Certyfikat zakodowany w formacie Base64.
hostName	string		Nazwa hosta do skonfigurowania w usłudze Api Management.
identityClientId	string		Identyfikator clientId tożsamości zarządzanej przypisanej przez system lub użytkownika wygenerowany przez usługę Azure AD, która ma dostęp GET do usługi keyVault zawierającej certyfikat SSL.
keyVaultId	string		Adres URL wpisu tajnego usługi KeyVault zawierającego certyfikat SSL. Jeśli podany jest bezwzględny adres URL zawierający wersję, automatyczna aktualizacja certyfikatu ssl nie będzie działać. Wymaga to skonfigurowania usługi Api Management przy użyciu aka.ms/apimmsi. Wpis tajny powinien być typu application/x-pkcs12
negotiateClientCertificate	boolean	False	Określ wartość true, aby zawsze negocjować certyfikat klienta na nazwie hosta. Wartość domyślna to false.
type	HostnameType		Typ nazwy hosta.

HostnameType

Wyliczenie

Typ nazwy hosta.

Wartość	Opis
Proxy
Portal
Management
Scm
DeveloperPortal
ConfigurationApi

LegacyApiState

Wyliczenie

Wskazanie, czy starszy interfejs API konfiguracji (wersja 1) powinien być uwidoczniony w usłudze API Management. Wartość jest opcjonalna, ale musi być "Włączona" lub "Wyłączona". W przypadku ustawienia "Wyłączone" starszy interfejs API konfiguracji (wersja 1) nie będzie dostępny dla bram hostowanych samodzielnie. Wartość domyślna to "Włączone"

Wartość	Opis
Enabled	Starszy interfejs API konfiguracji (wersja 1) jest włączony dla usługi, a bramy hostowane samodzielnie mogą się z nim łączyć.
Disabled	Starszy interfejs API konfiguracji (wersja 1) jest wyłączony dla usługi, a bramy hostowane samodzielnie nie mogą się z nim łączyć.

LegacyPortalStatus

Wyliczenie

Stan starszego portalu w usłudze API Management.

Wartość	Opis
Enabled	Dla usługi jest włączony starszy portal.
Disabled	Starszy portal jest wyłączony dla usługi.

NatGatewayState

Wyliczenie

Właściwość może służyć do włączania bramy translatora adresów sieciowych dla tej usługi API Management.

Wartość	Opis
Enabled	Brama translatora adresów sieciowych jest włączona dla usługi.
Disabled	Brama translatora adresów sieciowych jest wyłączona dla usługi.

PlatformVersion

Wyliczenie

Wersja platformy obliczeniowej, w której jest uruchomiona usługa.

Wartość	Opis
undetermined	Nie można określić wersji platformy, ponieważ platforma obliczeniowa nie jest wdrażana.
stv1	Platforma z uruchomioną usługą na platformie Single Tenant V1.
stv2	Platforma z uruchomioną usługą na platformie Single Tenant V2.
mtv1	Platforma z uruchomioną usługą na platformie Multi Tenant V1.
stv2.1	Platforma z uruchomioną usługą na platformie Single Tenant V2 na nowszym sprzęcie.

PrivateEndpointServiceConnectionStatus

Wyliczenie

Stan połączenia prywatnego punktu końcowego.

Wartość	Opis
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Objekt

Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą.

Nazwa	Typ	Opis
actionsRequired	string	Komunikat wskazujący, czy zmiany u dostawcy usług wymagają aktualizacji odbiorcy.
description	string	Przyczyna zatwierdzenia/odrzucenia połączenia.
status	PrivateEndpointServiceConnectionStatus	Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi.

PublicNetworkAccess

Wyliczenie

Czy dostęp do publicznego punktu końcowego jest dozwolony dla tej usługi API Management. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone". Jeśli wartość jest wyłączona, prywatne punkty końcowe są wyłączną metodą dostępu. Wartość domyślna to "Włączone"

Wartość	Opis
Enabled
Disabled

ReleaseChannel

Wyliczenie

Kanał wydania tej usługi API Management.

Wartość	Opis
Preview	Kanał podglądu usługi.
Default	Domyślny kanał usługi.
Stable	Stabilny kanał usługi.

RemotePrivateEndpointConnectionWrapper

Objekt

Zasób Połączenie zdalnego prywatnego punktu końcowego.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu połączenia z prywatnym punktem końcowym
name	string	Nazwa połączenia prywatnego punktu końcowego
properties.groupIds	string[]	Wszystkie identyfikatory grup.
properties.privateEndpoint	ArmIdWrapper	Zasób prywatnego punktu końcowego.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą.
properties.provisioningState	string	Stan aprowizacji zasobu połączenia prywatnego punktu końcowego.
type	string	Typ zasobu połączenia z prywatnym punktem końcowym

SkuType

Wyliczenie

Nazwa jednostki SKU.

Wartość	Opis
Developer	Jednostka SKU dla deweloperów usługi Api Management.
Standard	Standardowa jednostka SKU zarządzania interfejsem API.
Premium	Jednostka SKU Premium do zarządzania interfejsami API.
Basic	Podstawowa jednostka SKU zarządzania interfejsami API.
Consumption	Jednostka SKU zużycia zarządzania interfejsem API.
Isolated	Izolowana jednostka SKU zarządzania interfejsem API.
BasicV2	Jednostka SKU BasicV2 zarządzania interfejsem API.
StandardV2	Jednostka SKU StandardV2 zarządzania interfejsem API.
PremiumV2	PremiumV2 SKU zarządzania API.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

UserIdentityProperties

Objekt

Nazwa	Typ	Opis
clientId	string	Identyfikator klienta tożsamości przypisanej przez użytkownika.
principalId	string	Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika.

VirtualNetworkConfiguration

Objekt

Konfiguracja sieci wirtualnej, w której wdrożono usługę API Management.

Nazwa	Typ	Opis
subnetResourceId	string pattern: ^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$	Pełny identyfikator zasobu podsieci w sieci wirtualnej w celu wdrożenia usługi API Management.
subnetname	string	Nazwa podsieci.
vnetid	string	Identyfikator sieci wirtualnej. Jest to zazwyczaj identyfikator GUID. Domyślnie spodziewaj się pustego identyfikatora GUID.

VirtualNetworkType

Wyliczenie

Typ sieci VPN, w której należy skonfigurować bramę usługi API Management.

Wartość	Opis
None	Brama API Management nie jest częścią żadnej sieci wirtualnej.
External	Brama API Management jest częścią Virtual Network i jest dostępna z Internetu.
Internal	Brama API Management jest częścią Virtual Network i jest dostępna tylko z poziomu sieci wirtualnej.

Udostępnij za pośrednictwem

Api Management Service - Refresh Hostnames

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

ApiManagementServiceRefreshKeyVaultHostnames

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

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