Api Management Service - Update

Odwołanie

Usługa:: API Management

Wersja interfejsu API:: 2024-05-01

Aktualizuje istniejącą usługę API Management.

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

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 (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
identity	ApiManagementServiceIdentity	Tożsamość usługi zarządzanej usługi Api Management.
properties.additionalLocations	AdditionalLocation[]	Dodatkowe lokalizacje centrów danych usługi API Management.
properties.apiVersionConstraint	ApiVersionConstraint	Ograniczenie wersji interfejsu 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 konfiguracji interfejsu API usługi API Management.
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 protokołów 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żna użyć do wyłączenia 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 na potrzeby 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 na potrzeby 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. Nie określono żadnej z tych właściwości operacji PATCH spowoduje zresetowanie wartości właściwości pominiętych do ich wartości domyślnych. Dla wszystkich ustawień z wyjątkiem Http2 wartość domyślna jest `True`, jeśli usługa została utworzona w dniu 1 kwietnia 2018 r. lub przed 1 kwietnia 2018 r. i `False` inaczej. Wartość domyślna ustawienia Http2 to `False`. Następujące szyfry można wyłączyć 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 to `true` dla nich. Uwaga: następujące szyfry nie mogą być wyłączone, ponieważ są one wymagane przez wewnętrzne składniki 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	Stan portalu dla deweloperów w tej usłudze API Management.
properties.disableGateway	boolean	Właściwość prawidłowa tylko dla usługi Api Management wdrożonej w wielu lokalizacjach. Może to służyć do wyłączania bramy w regionie głównym.
properties.enableClientCertificate	boolean	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.hostnameConfigurations	HostnameConfiguration[]	Niestandardowa konfiguracja nazwy hosta usługi API Management.
properties.legacyPortalStatus	LegacyPortalStatus	Stan starszego portalu w usłudze API Management.
properties.natGatewayState	NatGatewayState	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.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]	Lista połączeń prywatnego punktu końcowego tej usługi.
properties.publicIpAddressId	string	Publiczny standardowy adres IP jednostki SKU w wersji 4, który ma być skojarzony z wdrożona usługa sieci wirtualnej w regionie. Obsługiwane tylko w przypadku jednostki SKU developer i Premium wdrażanej w sieci wirtualnej.
properties.publicNetworkAccess	PublicNetworkAccess	Określa, 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.restore	boolean	Cofnij usunięcie usługi Api Management, jeśli została ona wcześniej usunięta nietrwale. Jeśli ta flaga jest określona i ustawiona na True, wszystkie inne właściwości zostaną zignorowane.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration	Konfiguracja sieci wirtualnej usługi API Management.
properties.virtualNetworkType	VirtualNetworkType	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.
sku	ApiManagementServiceSkuProperties	Właściwości jednostki SKU usługi API Management.
tags	object	Tagi zasobów.
zones	string[]	Lista stref dostępności oznaczających miejsce, z którego musi pochodzić zasób.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ApiManagementServiceResource	Usługa została pomyślnie zaktualizowana.
202 Accepted		Żądanie aktualizacji usługi zostało zaakceptowane. Nagłówki location: string
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Nazwa

Typ

Opis

200 OK

ApiManagementServiceResource

Usługa została pomyślnie zaktualizowana.

202 Accepted

Żądanie aktualizacji usługi zostało zaakceptowane.

Nagłówki

location: string

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

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

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementUpdateServiceDisableTls10

ApiManagementUpdateServicePublisherDetails

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

ApiManagementUpdateServiceDisableTls10

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:: 202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse

Kod stanu:: 200

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

ApiManagementUpdateServicePublisherDetails

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:: 202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse

Kod stanu:: 200

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

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:: 202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse

Kod stanu:: 200

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

Definicje

Nazwa	Opis
AdditionalLocation	Opis dodatkowej lokalizacji zasobów usługi 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.
ApiManagementServiceUpdateParameters	Parametr dostarczony do usługi Update 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 interfejsu 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 nie zaufanych pośrednich i certyfikatów głównych.
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 z uruchomioną usługą.
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	Określa, 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"
RemotePrivateEndpointConnectionWrapper	Zasób połączenia z zdalnym prywatnym punktem końcowym.
SkuType	Nazwa jednostki SKU.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
UserIdentityProperties
VirtualNetworkConfiguration	Konfiguracja sieci wirtualnej, do której wdrożono usługę API Management.
VirtualNetworkType	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.

AdditionalLocation

Objekt

Opis dodatkowej lokalizacji zasobów usługi API Management.

Nazwa	Typ	Domyślna wartość	Opis
disableGateway	boolean	False	Właściwość prawidłowa tylko dla usługi Api Management wdrożonej w wielu lokalizacjach. Może to służyć do wyłączania 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żonym usługą bramy translatora adresów sieciowych. Dostępna tylko dla jednostki SKU Premium na platformie stv2.
platformVersion	PlatformVersion		Wersja platformy obliczeniowej z uruchomioną usługą.
privateIPAddresses	string[]		Prywatne statyczne adresy IP usługi API Management wdrożonej w wewnętrznej sieci wirtualnej w określonej dodatkowej lokalizacji. Dostępne tylko dla jednostek SKU w warstwie Podstawowa, Standardowa, Premium i Izolowana.
publicIPAddresses	string[]		Publiczne statyczne adresy IP usługi API Management w dodatkowej lokalizacji. Dostępne tylko dla jednostek SKU w warstwie Podstawowa, Standardowa, Premium i Izolowana.
publicIpAddressId	string		Publiczny adres IP jednostki SKU w warstwie Standardowa w wersji 4, który ma być skojarzony z usługą wdrożona w sieci wirtualnej w lokalizacji. Obsługiwane tylko w przypadku jednostki SKU w warstwie Premium wdrażanej w sieci wirtualnej.
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		Identyfikator zasobu.
identity	ApiManagementServiceIdentity		Tożsamość usługi zarządzanej usługi Api Management.
location	string		Lokalizacja zasobu.
name	string		Nazwa zasobu.
properties.additionalLocations	AdditionalLocation[]		Dodatkowe lokalizacje centrów danych usługi API Management.
properties.apiVersionConstraint	ApiVersionConstraint		Ograniczenie wersji interfejsu 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 konfiguracji interfejsu API usługi API Management.
properties.createdAtUtc	string (date-time)		Data utc utworzenia usługi API Management. Data jest zgodna z następującym formatem: `yyyy-MM-ddTHH:mm:ssZ` określony przez standard 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 protokołów 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żna użyć do wyłączenia 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 na potrzeby 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 na potrzeby 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. Nie określono żadnej z tych właściwości operacji PATCH spowoduje zresetowanie wartości właściwości pominiętych do ich wartości domyślnych. Dla wszystkich ustawień z wyjątkiem Http2 wartość domyślna jest `True`, jeśli usługa została utworzona w dniu 1 kwietnia 2018 r. lub przed 1 kwietnia 2018 r. i `False` inaczej. Wartość domyślna ustawienia Http2 to `False`. Następujące szyfry można wyłączyć 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 to `true` dla nich. Uwaga: następujące szyfry nie mogą być wyłączone, ponieważ są one wymagane przez wewnętrzne składniki 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ść prawidłowa tylko dla usługi Api Management wdrożonej w wielu lokalizacjach. Może to służyć do wyłączania 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żonym usługą bramy translatora adresów sieciowych. Dostępna tylko dla jednostki SKU Premium na platformie stv2.
properties.platformVersion	PlatformVersion		Wersja platformy obliczeniowej z uruchomioną usługą w tej lokalizacji.
properties.portalUrl	string		Adres URL punktu końcowego portalu wydawcy usługi API Management.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Lista połączeń prywatnego punktu końcowego tej usługi.
properties.privateIPAddresses	string[]		Prywatne statyczne adresy IP usługi API Management w regionie podstawowym, które są wdrażane w wewnętrznej sieci wirtualnej. Dostępne tylko dla jednostek SKU w warstwie 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/Aktywowanie/Powodzenie/Aktualizowanie/Niepowodzenie/Zatrzymano/Zakończenie/ZakończenieFailed/Deleted.
properties.publicIPAddresses	string[]		Publiczne statyczne adresy IP usługi API Management w regionie podstawowym. Dostępne tylko dla jednostek SKU w warstwie Podstawowa, Standardowa, Premium i Izolowana.
properties.publicIpAddressId	string		Publiczny standardowy adres IP jednostki SKU w wersji 4, który ma być skojarzony z wdrożona usługa sieci wirtualnej w regionie. Obsługiwane tylko w przypadku jednostki SKU developer i Premium wdrażanej w sieci wirtualnej.
properties.publicNetworkAccess	PublicNetworkAccess		Określa, 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.restore	boolean	False	Cofnij usunięcie usługi Api Management, jeśli została ona wcześniej usunięta nietrwale. Jeśli ta flaga jest określona i ustawiona na 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ą uruchomioną 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.
sku	ApiManagementServiceSkuProperties		Właściwości jednostki SKU usługi API Management.
systemData	systemData		Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
tags	object		Tagi zasobów.
type	string		Typ zasobu usługi API Management jest ustawiony na Wartość Microsoft.ApiManagement.
zones	string[]		Lista stref dostępności oznaczających miejsce, z którego musi pochodzić zasób.

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 obszarze Pojemność jednostki SKU zużycie musi być określona jako 0.
name	SkuType	Nazwa jednostki SKU.

ApiManagementServiceUpdateParameters

Objekt

Parametr dostarczony do usługi Update Api Management.

Nazwa	Typ	Domyślna wartość	Opis
etag	string		Element ETag zasobu.
id	string		Identyfikator zasobu.
identity	ApiManagementServiceIdentity		Tożsamość usługi zarządzanej usługi Api Management.
name	string		Nazwa zasobu.
properties.additionalLocations	AdditionalLocation[]		Dodatkowe lokalizacje centrów danych usługi API Management.
properties.apiVersionConstraint	ApiVersionConstraint		Ograniczenie wersji interfejsu 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 konfiguracji interfejsu API usługi API Management.
properties.createdAtUtc	string (date-time)		Data utc utworzenia usługi API Management. Data jest zgodna z następującym formatem: `yyyy-MM-ddTHH:mm:ssZ` określony przez standard 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 protokołów 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żna użyć do wyłączenia 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 na potrzeby 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 na potrzeby 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. Nie określono żadnej z tych właściwości operacji PATCH spowoduje zresetowanie wartości właściwości pominiętych do ich wartości domyślnych. Dla wszystkich ustawień z wyjątkiem Http2 wartość domyślna jest `True`, jeśli usługa została utworzona w dniu 1 kwietnia 2018 r. lub przed 1 kwietnia 2018 r. i `False` inaczej. Wartość domyślna ustawienia Http2 to `False`. Następujące szyfry można wyłączyć 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 to `true` dla nich. Uwaga: następujące szyfry nie mogą być wyłączone, ponieważ są one wymagane przez wewnętrzne składniki 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ść prawidłowa tylko dla usługi Api Management wdrożonej w wielu lokalizacjach. Może to służyć do wyłączania 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żonym usługą bramy translatora adresów sieciowych. Dostępna tylko dla jednostki SKU Premium na platformie stv2.
properties.platformVersion	PlatformVersion		Wersja platformy obliczeniowej z uruchomioną usługą w tej lokalizacji.
properties.portalUrl	string		Adres URL punktu końcowego portalu wydawcy usługi API Management.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Lista połączeń prywatnego punktu końcowego tej usługi.
properties.privateIPAddresses	string[]		Prywatne statyczne adresy IP usługi API Management w regionie podstawowym, które są wdrażane w wewnętrznej sieci wirtualnej. Dostępne tylko dla jednostek SKU w warstwie 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/Aktywowanie/Powodzenie/Aktualizowanie/Niepowodzenie/Zatrzymano/Zakończenie/ZakończenieFailed/Deleted.
properties.publicIPAddresses	string[]		Publiczne statyczne adresy IP usługi API Management w regionie podstawowym. Dostępne tylko dla jednostek SKU w warstwie Podstawowa, Standardowa, Premium i Izolowana.
properties.publicIpAddressId	string		Publiczny standardowy adres IP jednostki SKU w wersji 4, który ma być skojarzony z wdrożona usługa sieci wirtualnej w regionie. Obsługiwane tylko w przypadku jednostki SKU developer i Premium wdrażanej w sieci wirtualnej.
properties.publicNetworkAccess	PublicNetworkAccess		Określa, 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.restore	boolean	False	Cofnij usunięcie usługi Api Management, jeśli została ona wcześniej usunięta nietrwale. Jeśli ta flaga jest określona i ustawiona na 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ą uruchomioną 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.
sku	ApiManagementServiceSkuProperties		Właściwości jednostki SKU usługi API Management.
tags	object		Tagi zasobów.
type	string		Typ zasobu usługi API Management jest ustawiony na Wartość Microsoft.ApiManagement.
zones	string[]		Lista stref dostępności oznaczających miejsce, z którego musi pochodzić zasób.

ApimIdentityType

Wyliczanie

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
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

ApiVersionConstraint

Objekt

Ograniczenie wersji interfejsu 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 nie zaufanych 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	enum: CertificateAuthority Root	Lokalizacja magazynu certyfikatów System.Security.Cryptography.x509certificates.StoreName. Prawidłowe lokalizacje to tylko katalog główny i certyfikatuAuthority.

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

Wyliczanie

Źródło certyfikatu.

Wartość	Opis
BuiltIn
Custom
KeyVault
Managed

CertificateStatus

Wyliczanie

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

Wyliczanie

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

Wartość	Opis
Application
Key
ManagedIdentity
User

developerPortalStatus

Wyliczanie

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

Wartość	Opis
Disabled	Portal deweloperów jest wyłączony dla usługi.
Enabled	Portal deweloperów jest włą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 stosowane tylko do 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óry ma dostęp GET do magazynu kluczy zawierającego 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

Wyliczanie

Typ nazwy hosta.

Wartość	Opis
ConfigurationApi
DeveloperPortal
Management
Portal
Proxy
Scm

LegacyApiState

Wyliczanie

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
Disabled	Starszy interfejs API konfiguracji (wersja 1) jest wyłączony dla usługi, a bramy self-hosted nie mogą się z nim łączyć.
Enabled	Starszy interfejs API konfiguracji (wersja 1) jest włączony dla usługi, a bramy self-hosted mogą się z nim łączyć.

LegacyPortalStatus

Wyliczanie

Stan starszego portalu w usłudze API Management.

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

NatGatewayState

Wyliczanie

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

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

PlatformVersion

Wyliczanie

Wersja platformy obliczeniowej z uruchomioną usługą.

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

PrivateEndpointServiceConnectionStatus

Wyliczanie

Stan połączenia prywatnego punktu końcowego.

Wartość	Opis
Approved
Pending
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

Wyliczanie

Określa, 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
Disabled
Enabled

RemotePrivateEndpointConnectionWrapper

Objekt

Zasób połączenia z zdalnym prywatnym punktem końcowym.

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 grupy.
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 prywatnego punktu końcowego

SkuType

Wyliczanie

Nazwa jednostki SKU.

Wartość	Opis
Basic	Podstawowa jednostka SKU usługi Api Management.
BasicV2	Podstawowa jednostka SKU usługi Api Management w wersji 2.
Consumption	Jednostka SKU użycia usługi Api Management.
Developer	Jednostka SKU dewelopera usługi Api Management.
Isolated	Izolowana jednostka SKU usługi Api Management.
Premium	Jednostka SKU w warstwie Premium usługi Api Management.
Standard	Standardowa jednostka SKU usługi Api Management.
StandardV2	Jednostka SKU standardu 2 usługi Api Management.

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)	Znacznik czasu 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, do 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. Oczekiwano domyślnego identyfikatora GUID o wartości null.

VirtualNetworkType

Wyliczanie

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.

Wartość	Opis
External	Usługa jest częścią sieci wirtualnej i jest dostępna z Internetu.
Internal	Usługa jest częścią sieci wirtualnej i jest dostępna tylko z poziomu sieci wirtualnej.
None	Usługa nie jest częścią żadnej sieci wirtualnej.

Udostępnij za pośrednictwem

Api Management Service - Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

ApiManagementUpdateServiceDisableTls10

Przykładowe żądanie

Przykładowa odpowiedź

ApiManagementUpdateServicePublisherDetails

Przykładowe żądanie

Przykładowa odpowiedź

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AdditionalLocation

ApiManagementServiceIdentity

ApiManagementServiceResource

ApiManagementServiceSkuProperties

ApiManagementServiceUpdateParameters

ApimIdentityType

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateInformation

CertificateSource

CertificateStatus

ConfigurationApi

createdByType

developerPortalStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HostnameConfiguration

HostnameType

LegacyApiState

LegacyPortalStatus

NatGatewayState

PlatformVersion

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

PublicNetworkAccess

RemotePrivateEndpointConnectionWrapper

SkuType

systemData

UserIdentityProperties

VirtualNetworkConfiguration

VirtualNetworkType

Dodatkowe zasoby