Api Management Service - Refresh Hostnames

Tjänst:: API Management

API-version:: 2025-03-01-preview

Tvinga att uppdatera SSL-certifikatet som är kopplat till de anpassade värdnamnen som konfigurerats med hemlighet från KeyVault på API-administrationstjänsten.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Namnet på API Management-tjänsten.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	ApiManagementServiceResource	Azure-åtgärden har slutförts.
202 Accepted		Resursåtgärden har godkänts. Sidhuvuden Retry-After: integer location: string
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Name

Typ

Description

200 OK

ApiManagementServiceResource

Azure-åtgärden har slutförts.

202 Accepted

Resursåtgärden har godkänts.

Sidhuvuden

Retry-After: integer
location: string

Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Exempelsvar

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

Statuskod:: 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

Definitioner

Name	Description
AdditionalLocation	Beskrivning av ytterligare en API Management resursplats.
ApiManagementServiceIdentity	Identitetsegenskaper för API-hanteringstjänstresursen.
ApiManagementServiceResource	En enda API Management-tjänstresurs i Lista eller Hämta svar.
ApiManagementServiceSkuProperties	Egenskaper för API Management-tjänstresurs SKU.
ApimIdentityType	Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.
ApiVersionConstraint	Versionsbegränsning för API:er för kontrollplan för API Management-tjänsten.
ArmIdWrapper	En omslutning för ett ARM-resurs-ID
CertificateConfiguration	Certifikatkonfiguration som består av icke-betrodda mellanliggande certifikat och rotcertifikat.
CertificateConfigurationStoreName	Certifikatarkivet System.Security.Cryptography.x509certificates.StoreName. Endast Rot- och CertificateAuthority är giltiga platser.
CertificateInformation	Information om SSL-certifikat.
CertificateSource	Källa för certifikat.
CertificateStatus	Status för certifikat.
ConfigurationApi	Information om konfigurations-API:et för API Management-tjänsten.
createdByType	Den typ av identitet som skapade resursen.
DeveloperPortalStatus	Status för utvecklarportalen i den här API Management-tjänsten.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
HostnameConfiguration	Anpassad värdnamnskonfiguration.
HostnameType	Typ av värdnamn.
LegacyApiState	Indikation om det äldre konfigurations-API:et (v1) ska exponeras på API Management-tjänsten eller inte. Värdet är valfritt men måste vara "Aktiverad" eller "Inaktiverad". Om "Inaktiverad" kommer äldre konfigurations-API (v1) inte att vara tillgängligt för gatewayer med egen värd. Standardvärdet är "Aktiverat"
LegacyPortalStatus	Status för den äldre portalen i API Management-tjänsten.
NatGatewayState	Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten.
PlatformVersion	Compute Platform Version som kör tjänsten.
PrivateEndpointServiceConnectionStatus	Anslutningsstatus för privat slutpunkt.
PrivateLinkServiceConnectionState	En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.
PublicNetworkAccess	Om offentlig slutpunktsåtkomst tillåts för den här API Management-tjänsten eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat". Om "Inaktiverad" är privata slutpunkter den exklusiva åtkomstmetoden. Standardvärdet är "Aktiverat"
ReleaseChannel	Versionskanal för den här API Management-tjänsten.
RemotePrivateEndpointConnectionWrapper	Resurs för anslutning till fjärransluten privat slutpunkt.
SkuType	Namnet på SKU:n.
systemData	Metadata som rör skapande och senaste ändring av resursen.
UserIdentityProperties
VirtualNetworkConfiguration	Konfiguration av ett virtuellt nätverk som API Management-tjänsten distribueras till.
VirtualNetworkType	Den typ av VPN som API Management-gatewayen måste konfigureras i.

AdditionalLocation

Objekt

Beskrivning av ytterligare en API Management resursplats.

Name	Typ	Standardvärde	Description
disableGateway	boolean	False	Egenskapen är endast giltig för en API Management-tjänst som distribueras på flera platser. Detta kan användas för att inaktivera gatewayen på den här ytterligare platsen.
gatewayRegionalUrl	string		Gateway-URL för API Management-tjänsten i regionen.
location	string		Platsnamnet för den ytterligare regionen mellan Azure Data Center-regioner.
natGatewayState	NatGatewayState	Disabled	Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten.
outboundPublicIPAddresses	string[]		Utgående offentliga IPV4-adressprefix som är associerade med den distribuerade NAT Gateway-tjänsten. Endast tillgängligt för Premium SKU på stv2-plattformen.
platformVersion	PlatformVersion		Compute Platform Version som kör tjänsten.
privateIPAddresses	string[]		Privata statiska belastningsutjämnade IP-adresser för API Management-tjänsten, som distribueras i ett internt virtuellt nätverk på en viss ytterligare plats. Endast tillgängligt för SKU:erna Basic, Standard, Premium och Isolerad.
publicIPAddresses	string[]		Offentliga statiska belastningsutjämnade IP-adresser för API Management-tjänsten på den ytterligare platsen. Endast tillgängligt för SKU:erna Basic, Standard, Premium och Isolerad.
publicIpAddressId	string		Offentlig Standard SKU IP V4-baserad IP-adress som ska associeras med Virtual Network distribuerad tjänst på platsen. Stöds endast för Premium SKU som distribueras i Virtual Network.
sku	ApiManagementServiceSkuProperties		SKU-egenskaper för API Management-tjänsten.
virtualNetworkConfiguration	VirtualNetworkConfiguration		Konfiguration av virtuellt nätverk för platsen.
zones	string[]		En lista över tillgänglighetszoner som anger var resursen måste komma ifrån.

ApiManagementServiceIdentity

Objekt

Identitetsegenskaper för API-hanteringstjänstresursen.

Name	Typ	Description
principalId	string (uuid)	Identitetens huvud-ID.
tenantId	string (uuid)	Klientklientorganisations-ID:t för identiteten.
type	ApimIdentityType	Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.
userAssignedIdentities	<string, UserIdentityProperties>	Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceResource

Objekt

En enda API Management-tjänstresurs i Lista eller Hämta svar.

Name	Typ	Standardvärde	Description
etag	string		ETag för resursen.
id	string		Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ApiManagementServiceIdentity		Hanterad tjänstidentitet för Api Management-tjänsten.
location	string		Den geo-plats där resursen finns
name	string		Namnet på resursen
properties.additionalLocations	AdditionalLocation[]		Ytterligare datacenterplatser för API Management-tjänsten.
properties.apiVersionConstraint	ApiVersionConstraint		Versionsbegränsning för API:er för kontrollplan för API Management-tjänsten.
properties.certificates	CertificateConfiguration[]		Lista över certifikat som måste installeras i API Management-tjänsten. Maximalt antal certifikat som stöds som kan installeras är 10.
properties.configurationApi	ConfigurationApi		Konfiguration av API-konfiguration av API Management-tjänsten.
properties.createdAtUtc	string (date-time)		UTC-datum för skapande av API Management-tjänsten. Datumet överensstämmer med följande format: `yyyy-MM-ddTHH:mm:ssZ` enligt ISO 8601-standarden.
properties.customProperties	object		Anpassade egenskaper för API Management-tjänsten. Inställningen `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` inaktiverar chiffer TLS_RSA_WITH_3DES_EDE_CBC_SHA för alla TLS(1.0, 1.1 och 1.2). Inställningen `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` kan användas för att inaktivera bara TLS 1.1. Inställningen `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` kan användas för att inaktivera TLS 1.0 på en API Management-tjänst. Inställningen `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` kan användas för att inaktivera bara TLS 1.1 för kommunikation med serverdelar. Inställningen `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` kan användas för att inaktivera TLS 1.0 för kommunikation med serverdelar. Inställningen `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` kan användas för att aktivera HTTP2-protokollet på en API Management-tjänst. Om du inte anger någon av dessa egenskaper vid PATCH-åtgärden återställs de utelämnade egenskapernas värden till deras standardvärden. För alla inställningar utom Http2 är `True` standardvärdet om tjänsten skapades den 1 april 2018 eller tidigare och `False` på annat sätt. Standardvärdet för Http2-inställningen är `False`. Du kan inaktivera något av följande chiffer med hjälp av inställningarna `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. Till exempel `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Standardvärdet är `true` för dem. Följande chiffer kan inte inaktiveras eftersom de krävs av interna plattformskomponenter: 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 för utvecklarportalen i den här API Management-tjänsten.
properties.developerPortalUrl	string		DEveloper Portalens slutpunkts-URL för API Management-tjänsten.
properties.disableGateway	boolean	False	Egenskapen är endast giltig för en API Management-tjänst som distribueras på flera platser. Detta kan användas för att inaktivera gatewayen i huvudregionen.
properties.enableClientCertificate	boolean	False	Egenskapen är endast avsedd att användas för förbruknings-SKU-tjänsten. Detta framtvingar att ett klientcertifikat visas på varje begäran till gatewayen. Detta gör det också möjligt att autentisera certifikatet i principen på gatewayen.
properties.gatewayRegionalUrl	string		Gateway-URL för API Management-tjänsten i standardregionen.
properties.gatewayUrl	string		Gateway-URL för API Management-tjänsten.
properties.hostnameConfigurations	HostnameConfiguration[]		Konfiguration av anpassat värdnamn för API Management-tjänsten.
properties.legacyPortalStatus	LegacyPortalStatus	Enabled	Status för den äldre portalen i API Management-tjänsten.
properties.managementApiUrl	string		URL för API-slutpunkt för hantering av API Management-tjänsten.
properties.natGatewayState	NatGatewayState	Disabled	Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten.
properties.notificationSenderEmail	string maxLength: 100		E-postadress som meddelandet ska skickas från.
properties.outboundPublicIPAddresses	string[]		Utgående offentliga IPV4-adressprefix som är associerade med den distribuerade NAT Gateway-tjänsten. Endast tillgängligt för Premium SKU på stv2-plattformen.
properties.platformVersion	PlatformVersion		Compute Platform Version som kör tjänsten på den här platsen.
properties.portalUrl	string		Slutpunkt för utgivarportalen URL för API Management-tjänsten.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Lista över privata slutpunktsanslutningar för den här tjänsten.
properties.privateIPAddresses	string[]		Privata statiska belastningsutjämnade IP-adresser för API Management-tjänsten i den primära regionen, som distribueras i ett internt virtuellt nätverk. Endast tillgängligt för SKU:erna Basic, Standard, Premium och Isolerad.
properties.provisioningState	string		Det aktuella etableringstillståndet för API Management-tjänsten som kan vara något av följande: Skapad/Aktivera/Lyckades/Uppdaterade/Misslyckades/Stoppad/Avslutande/TerminationFailed/Deleted.
properties.publicIPAddresses	string[]		Offentliga statiska belastningsutjämnade IP-adresser för API Management-tjänsten i den primära regionen. Endast tillgängligt för SKU:erna Basic, Standard, Premium och Isolerad.
properties.publicIpAddressId	string		Offentlig Standard SKU IP V4-baserad IP-adress som ska associeras med Virtual Network distribuerad tjänst i regionen. Stöds endast för Developer och Premium SKU som distribueras i Virtual Network.
properties.publicNetworkAccess	PublicNetworkAccess		Om offentlig slutpunktsåtkomst tillåts för den här API Management-tjänsten eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat". Om "Inaktiverad" är privata slutpunkter den exklusiva åtkomstmetoden. Standardvärdet är "Aktiverat"
properties.publisherEmail	string maxLength: 100		E-post för utgivare.
properties.publisherName	string maxLength: 100		Utgivarens namn.
properties.releaseChannel	ReleaseChannel		Versionskanal för den här API Management-tjänsten.
properties.restore	boolean	False	Ta bort API-hanteringstjänsten om den tidigare har tagits bort mjukt. Om den här flaggan anges och anges till True ignoreras alla andra egenskaper.
properties.scmUrl	string		SCM-slutpunkts-URL för API Management-tjänsten.
properties.targetProvisioningState	string		Etableringstillståndet för API Management-tjänsten, som är mål för den långvariga åtgärden som startats på tjänsten.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		Konfiguration av virtuellt nätverk för API Management-tjänsten.
properties.virtualNetworkType	VirtualNetworkType	None	Den typ av VPN som API Management-tjänsten måste konfigureras i. Ingen (standardvärde) innebär att API Management-tjänsten inte ingår i något virtuellt nätverk, externt innebär att API Management-distributionen har konfigurerats i ett virtuellt nätverk med en Internetuppkopplad slutpunkt, och intern innebär att API Management-distributionen konfigureras i ett virtuellt nätverk som endast har en intranätuppkopplad slutpunkt.
properties.zoneRedundant	boolean	False	Zonredundant krav vid skapandet av StandardV2 och PremiumV2. Om denna flagga är satt till True, kommer den att returnera en APIM-tjänst med zonredundant eller misslyckas med begäran om någon underliggande komponent inte kan vara zonredundant.
sku	ApiManagementServiceSkuProperties		SKU-egenskaper för API Management-tjänsten.
systemData	systemData		Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
tags	object		Resursetiketter.
type	string		Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"
zones	string[]		Tillgänglighetszonerna.

ApiManagementServiceSkuProperties

Objekt

Egenskaper för API Management-tjänstresurs SKU.

Name	Typ	Description
capacity	integer (int32)	SKU:ns kapacitet (antalet distribuerade enheter i SKU:n). För förbrukning måste SKU-kapaciteten anges som 0.
name	SkuType	Namnet på SKU:n.

ApimIdentityType

Uppräkning

Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.

Värde	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ApiVersionConstraint

Objekt

Versionsbegränsning för API:er för kontrollplan för API Management-tjänsten.

Name	Typ	Description
minApiVersion	string	Begränsa API-anrop för kontrollplanet till API Management-tjänsten med en version som är lika med eller nyare än det här värdet.

ArmIdWrapper

Objekt

En omslutning för ett ARM-resurs-ID

Name	Typ	Description
id	string

CertificateConfiguration

Objekt

Certifikatkonfiguration som består av icke-betrodda mellanliggande certifikat och rotcertifikat.

Name	Typ	Description
certificate	CertificateInformation	Certifikatinformation.
certificatePassword	string	Certifikatlösenord.
encodedCertificate	string	Base64-kodat certifikat.
storeName	CertificateConfigurationStoreName	Certifikatarkivet System.Security.Cryptography.x509certificates.StoreName. Endast Rot- och CertificateAuthority är giltiga platser.

CertificateConfigurationStoreName

Uppräkning

Certifikatarkivet System.Security.Cryptography.x509certificates.StoreName. Endast Rot- och CertificateAuthority är giltiga platser.

Värde	Description
CertificateAuthority
Root

CertificateInformation

Objekt

Information om SSL-certifikat.

Name	Typ	Description
expiry	string (date-time)	Förfallodatum för certifikatet. Datumet överensstämmer med följande format: `yyyy-MM-ddTHH:mm:ssZ` enligt ISO 8601-standarden.
subject	string	Certifikatets ämne.
thumbprint	string	Tumavtryck för certifikatet.

CertificateSource

Uppräkning

Källa för certifikat.

Värde	Description
Managed
KeyVault
Custom
BuiltIn

CertificateStatus

Uppräkning

Status för certifikat.

Värde	Description
Completed
Failed
InProgress

ConfigurationApi

Objekt

Information om konfigurations-API:et för API Management-tjänsten.

Name	Typ	Standardvärde	Description
legacyApi	LegacyApiState	Enabled	Indikation om det äldre konfigurations-API:et (v1) ska exponeras på API Management-tjänsten eller inte. Värdet är valfritt men måste vara "Aktiverad" eller "Inaktiverad". Om "Inaktiverad" kommer äldre konfigurations-API (v1) inte att vara tillgängligt för gatewayer med egen värd. Standardvärdet är "Aktiverat"

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

DeveloperPortalStatus

Uppräkning

Status för utvecklarportalen i den här API Management-tjänsten.

Värde	Description
Enabled	Utvecklarportalen är aktiverad för tjänsten.
Disabled	Utvecklarportalen är inaktiverad för tjänsten.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Typen av ytterligare information.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Felet ytterligare information.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felet riktas.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felet objektet.

HostnameConfiguration

Objekt

Anpassad värdnamnskonfiguration.

Name	Typ	Standardvärde	Description
certificate	CertificateInformation		Certifikatinformation.
certificatePassword	string		Certifikatlösenord.
certificateSource	CertificateSource		Källa för certifikat.
certificateStatus	CertificateStatus		Status för certifikat.
defaultSslBinding	boolean	False	Ange true för att konfigurera certifikatet som är associerat med det här värdnamnet som standard-SSL-certifikat. Om en klient inte skickar SNI-huvudet blir det här certifikatet som kommer att utmanas. Egenskapen är användbar om en tjänst har flera anpassade värdnamn aktiverade och måste bestämma standard-SSL-certifikatet. Inställningen tillämpas endast på gatewayens värdnamnstyp.
encodedCertificate	string		Base64-kodat certifikat.
hostName	string		Värdnamn som ska konfigureras på Api Management-tjänsten.
identityClientId	string		System- eller användartilldelad hanterad identitet clientId som genereras av Azure AD, som har GET-åtkomst till keyVault som innehåller SSL-certifikatet.
keyVaultId	string		Url till KeyVault-hemligheten som innehåller Ssl-certifikatet. Om absolut URL som innehåller version tillhandahålls fungerar inte automatisk uppdatering av SSL-certifikatet. Detta kräver att API Management-tjänsten konfigureras med aka.ms/apimmsi. Hemligheten ska vara av typen application/x-pkcs12
negotiateClientCertificate	boolean	False	Ange true för att alltid förhandla om klientcertifikatet på värdnamnet. Standardvärdet är falskt.
type	HostnameType		Typ av värdnamn.

HostnameType

Uppräkning

Typ av värdnamn.

Värde	Description
Proxy
Portal
Management
Scm
DeveloperPortal
ConfigurationApi

LegacyApiState

Uppräkning

Indikation om det äldre konfigurations-API:et (v1) ska exponeras på API Management-tjänsten eller inte. Värdet är valfritt men måste vara "Aktiverad" eller "Inaktiverad". Om "Inaktiverad" kommer äldre konfigurations-API (v1) inte att vara tillgängligt för gatewayer med egen värd. Standardvärdet är "Aktiverat"

Värde	Description
Enabled	Äldre konfigurations-API (v1) är aktiverat för tjänsten och gatewayer med egen värd kan ansluta till den.
Disabled	Äldre konfigurations-API (v1) är inaktiverat för tjänsten och gatewayer med egen värd kan inte ansluta till den.

LegacyPortalStatus

Uppräkning

Status för den äldre portalen i API Management-tjänsten.

Värde	Description
Enabled	Äldre portal är aktiverad för tjänsten.
Disabled	Äldre portal är inaktiverad för tjänsten.

NatGatewayState

Uppräkning

Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten.

Värde	Description
Enabled	Nat Gateway är aktiverat för tjänsten.
Disabled	Nat Gateway är inaktiverat för tjänsten.

PlatformVersion

Uppräkning

Compute Platform Version som kör tjänsten.

Värde	Description
undetermined	Det går inte att fastställa plattformsversionen eftersom beräkningsplattformen inte har distribuerats.
stv1	Plattform som kör tjänsten på en V1-plattform för en klientorganisation.
stv2	Plattform som kör tjänsten på en V2-plattform för en klientorganisation.
mtv1	Plattform som kör tjänsten på Multi Tenant V1-plattformen.
stv2.1	Plattform som kör tjänsten på en V2-plattform för en klientorganisation på nyare maskinvara.

PrivateEndpointServiceConnectionStatus

Uppräkning

Anslutningsstatus för privat slutpunkt.

Värde	Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Objekt

En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.

Name	Typ	Description
actionsRequired	string	Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.
description	string	Orsak till godkännande/avvisande av anslutningen.
status	PrivateEndpointServiceConnectionStatus	Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare.

PublicNetworkAccess

Uppräkning

Om offentlig slutpunktsåtkomst tillåts för den här API Management-tjänsten eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat". Om "Inaktiverad" är privata slutpunkter den exklusiva åtkomstmetoden. Standardvärdet är "Aktiverat"

Värde	Description
Enabled
Disabled

ReleaseChannel

Uppräkning

Versionskanal för den här API Management-tjänsten.

Värde	Description
Preview	Förhandsgranskningskanal för tjänsten.
Default	Standardkanal för tjänsten.
Stable	Stabil kanal för tjänsten.

RemotePrivateEndpointConnectionWrapper

Objekt

Resurs för anslutning till fjärransluten privat slutpunkt.

Name	Typ	Description
id	string	Resurs-ID för anslutning till privat slutpunkt
name	string	Anslutningsnamn för privat slutpunkt
properties.groupIds	string[]	Alla grupp-ID:n.
properties.privateEndpoint	ArmIdWrapper	Resursen för den privata slutpunkten.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.
properties.provisioningState	string	Etableringstillståndet för den privata slutpunktsanslutningsresursen.
type	string	Resurstyp för anslutning till privat slutpunkt

SkuType

Uppräkning

Namnet på SKU:n.

Värde	Description
Developer	Utvecklar-SKU för API-hantering.
Standard	Standard-SKU för API-hantering.
Premium	Premium-SKU för API Management.
Basic	Grundläggande SKU för API-hantering.
Consumption	Förbruknings-SKU för API Management.
Isolated	Isolerad SKU för API-hantering.
BasicV2	BasicV2 SKU för API-hantering.
StandardV2	StandardV2 SKU för API Management.
PremiumV2	PremiumV2 SKU för API Management.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för senaste ändring av resurs (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

UserIdentityProperties

Objekt

Name	Typ	Description
clientId	string	Klient-ID för användartilldelad identitet.
principalId	string	Huvud-ID för användartilldelad identitet.

VirtualNetworkConfiguration

Objekt

Konfiguration av ett virtuellt nätverk som API Management-tjänsten distribueras till.

Name	Typ	Description
subnetResourceId	string pattern: ^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$	Det fullständiga resurs-ID:t för ett undernät i ett virtuellt nätverk för att distribuera API Management-tjänsten i.
subnetname	string	Namnet på undernätet.
vnetid	string	Det virtuella nätverks-ID:t. Detta är vanligtvis ett GUID. Förvänta dig ett null-GUID som standard.

VirtualNetworkType

Uppräkning

Den typ av VPN som API Management-gatewayen måste konfigureras i.

Värde	Description
None	API Management-gatewayen är inte en del av någon Virtual Network.
External	API Management-gatewayen är en del av Virtual Network och är tillgänglig från Internet.
Internal	API Management-gatewayen är en del av Virtual Network och är endast tillgänglig inifrån det virtuella nätverket.

Dela via

Api Management Service - Refresh Hostnames

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

ApiManagementServiceRefreshKeyVaultHostnames

Exempelbegäran

Exempelsvar

Definitioner

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